Customers
/
Get Customer

Get Customer

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

Retrieve a customer record by externalCustomerId, including profile data and KYC verification history.

Path parameters

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

Response

Customer record.
    externalCustomerId
    string
    The unique identifier of the customer as provided by your system.
    Examples:demo-user
    data
    object

    Customer profile fields. Only email is required — all other fields are collected during SDK flows where needed.

      email
      string
      Required

      Customer email address. Must not use a disposable domain or contain a + suffix.

      Examples:demo@vivamo.co
      phone
      string

      Customer mobile number in international format (e.g. +15551234567). Must be a valid mobile number — landlines and VOIP numbers are rejected. If provided without a + prefix and with at least 10 digits, +1 (US) is prepended automatically. Recommended if available — customers without a phone number are prompted to enter one during the SDK flow.

      Examples:+15551234567
      firstName
      string
      Customer's first name.
      Examples:John
      lastName
      string
      Customer's last name.
      Examples:Smith
      street
      string
      Street address.
      Examples:123 42nd St
      street2
      string
      Additional street address (apartment, suite, etc.).
      Examples:Suite 42
      state
      string
      2-character state code for US addresses.
      Examples:NY
      city
      string
      City name.
      Examples:New York
      zip
      string
      ZIP or postal code.
      Examples:10001
      country
      string
      2-character ISO 3166 Alpha-2 country code.
      Examples:US
    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
    createdAt
    string
    Timestamp when the customer record was created.
    Examples:2025-06-05T04:57:11.151Z
Built with