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 and links for a customer. If the existing link has expired (1-hour TTL), a new one is generated automatically. Always fetch a fresh link from this endpoint rather than caching.

Path parameters

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

Response

KYC information with verification links.
    externalCustomerId
    string
    The customer identifier.
    verificationLink
    string
    URL for the customer to complete identity verification.
    driversLicenseVerificationLink
    string
    Direct URL for driver's license verification.
    passportVerificationLink
    string
    Direct URL for passport verification.
    kycVerifications
    array of object
    A KYC verification record for a customer.
      type
      string
      The type of verification. Currently, only `proof_of_id` is supported.
      Examples:proof_of_id
        proof_of_id
        string
      status
      string
      Current verification status.
      Examples:pending
        pending
        string
        verified
        string
        under_review
        string
        rejected
        string
        expired
        string
        verified_manually
        string
        rejected_manually
        string
      createdAt
      string
      Timestamp when the verification was initiated.
      Examples:2025-06-17T00:16:31.155Z
Built with