Get Customer

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=all' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=deposits,virtualaccounts' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z",
    "customer_deposit": [
      {
        "transaction_id": "txn_xxxxxx",
        "transaction_amount": "500.00",
        "transaction_currency": "USD",
        "transaction_status": "Complete",
        "transaction_purpose": "Top-up",
        "created_at": "2026-04-03T08:00:00.000000Z"
      }
    ],
    "customer_payouts": [
      {
        "transaction_id": "txn_yyyyyy",
        "transaction_amount": "200.00",
        "transaction_currency": "USD",
        "transaction_payout_details": { "status": "Complete" },
        "created_at": "2026-04-04T09:00:00.000000Z"
      }
    ],
    "customer_virtualaccounts": [
      {
        "account_id": "va-001",
        "currency": "USD",
        "account_number": "8881234567",
        "routing_number": "021000021",
        "status": "active"
      }
    ],
    "customer_virtual_cards": [],
    "customer_crypto_wallets": []
  }
}

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z"
  }
}

{
  "status": "failed",
  "status_code": 404,
  "message": "Request failed.",
  "data": {
    "error": "Customer not found"
  }
}

GET

customer

{customer_id}

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=all' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=deposits,virtualaccounts' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z",
    "customer_deposit": [
      {
        "transaction_id": "txn_xxxxxx",
        "transaction_amount": "500.00",
        "transaction_currency": "USD",
        "transaction_status": "Complete",
        "transaction_purpose": "Top-up",
        "created_at": "2026-04-03T08:00:00.000000Z"
      }
    ],
    "customer_payouts": [
      {
        "transaction_id": "txn_yyyyyy",
        "transaction_amount": "200.00",
        "transaction_currency": "USD",
        "transaction_payout_details": { "status": "Complete" },
        "created_at": "2026-04-04T09:00:00.000000Z"
      }
    ],
    "customer_virtualaccounts": [
      {
        "account_id": "va-001",
        "currency": "USD",
        "account_number": "8881234567",
        "routing_number": "021000021",
        "status": "active"
      }
    ],
    "customer_virtual_cards": [],
    "customer_crypto_wallets": []
  }
}

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z"
  }
}

{
  "status": "failed",
  "status_code": 404,
  "message": "Request failed.",
  "data": {
    "error": "Customer not found"
  }
}

Returns a customer’s profile, including their endorsement list. Use the include query parameter to embed related data — deposits, payouts, virtual accounts, virtual cards, and/or crypto wallets — in the same response. The endorsement list is where the customer’s KYC or KYB result appears. Each entry is one service with its own status; a service is available when its endorsement is approved. See Track verification with endorsements.

GET /customer/{customer_id}

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=all' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=deposits,virtualaccounts' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z",
    "customer_deposit": [
      {
        "transaction_id": "txn_xxxxxx",
        "transaction_amount": "500.00",
        "transaction_currency": "USD",
        "transaction_status": "Complete",
        "transaction_purpose": "Top-up",
        "created_at": "2026-04-03T08:00:00.000000Z"
      }
    ],
    "customer_payouts": [
      {
        "transaction_id": "txn_yyyyyy",
        "transaction_amount": "200.00",
        "transaction_currency": "USD",
        "transaction_payout_details": { "status": "Complete" },
        "created_at": "2026-04-04T09:00:00.000000Z"
      }
    ],
    "customer_virtualaccounts": [
      {
        "account_id": "va-001",
        "currency": "USD",
        "account_number": "8881234567",
        "routing_number": "021000021",
        "status": "active"
      }
    ],
    "customer_virtual_cards": [],
    "customer_crypto_wallets": []
  }
}

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "customer_email": "alex.smith@example.com",
    "customer_phone": "+15551234567",
    "customer_country": "USA",
    "customer_type": "individual",
    "customer_status": "active",
    "customer_kyc_status": "approved",
    "kyc_verified_date": "2026-04-02T12:00:00.000000Z",
    "created_at": "2026-04-02T10:00:00.000000Z"
  }
}

{
  "status": "failed",
  "status_code": 404,
  "message": "Request failed.",
  "data": {
    "error": "Customer not found"
  }
}

The include parameter is additive — keys for un-requested relations are omitted from the response entirely. This keeps response payloads lean when you only need specific data.

Authorizations

X-Api-Key

string

header

required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret

string

header

required

Your API secret (yativo_sk_...), shown once when the key is created.

Path Parameters

customer_id

string<uuid>

required

The UUID of the customer to retrieve.

Query Parameters

include

string

Comma-separated list of relations to embed in the response.

Value	Embeds
`deposits`	`customer_deposit` array
`payouts`	`customer_payouts` array
`virtualaccounts`	`customer_virtualaccounts` array
`virtual_cards`	`customer_virtual_cards` array
`crypto_wallets`	`customer_crypto_wallets` array
`all`	All of the above

Multiple values can be combined: ?include=deposits,payouts

Response

Customer profile

status

string

status_code

integer

message

string

data

object

Show child attributes

Overview

Customers

KYC / KYB

KYC Lookups

Payments & Transfers

Deposits

Virtual Accounts

Wallets

Beneficiaries

Transactions

Virtual Cards

Payouts

Currency Swap

IP Whitelist & Security

Corporate Card Links

Webhooks

Developer

Authorizations

Path Parameters

Query Parameters

Response