Customers > KYC and Verification
/
Get Customer KYC Info

Get Customer KYC Info

GET
https://api.vivamo.co/v1/customers/{externalCustomerId}/kyc-info

Retrieve KYC verification status for a customer. The response is deliberately minimal: for any status other than pending only status, type, and verifiedAt are returned. When the status is pending, the response also includes a clientSecretKey (cs_ki_…, valid 24 hours) that your frontend passes to vivamo.createKycElements(), plus the EVS URLs under data for backward compatibility (deprecated — new integrations should use the clientSecretKey).

Path parameters

    externalCustomerId
    string
    Required
    The customer identifier you provided when creating the record.

Response

KYC information.
    externalCustomerId
    string
    kycVerification
    object or null
      type
      string
      Examples:proof_of_id
      status
      string
        pending
        string
        verified
        string
        verified_manually
        string
        under_review
        string
        rejected
        string
        rejected_manually
        string
        expired
        string
      verifiedAt
      string
      When the verification record was last created or refreshed. Present for every status.
      clientSecretKey
      string

      SDK client secret (cs_ki_…, 24h TTL) used with vivamo.createKycElements(). Only returned when the verification is pending.

      data
      object

      Only returned when the verification is pending. Deprecated — prefer clientSecretKey.

        driversLicenseVerificationUrl
        string
        Deprecated
        passportVerificationUrl
        string
        Deprecated
        url
        string
        Deprecated
Built with