Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns a customer’s profile. By default only core profile fields are returned. Use the include query parameter to embed related data — deposits, payouts, virtual accounts, virtual cards, and/or crypto wallets — in the same response. 
GET /customer/{customer_id}

​
Path parameters

​
customer_id
string
required
The UUID of the customer to retrieve.

​
Query parameters

​
include
string
Comma-separated list of relations to embed in the response.
ValueEmbeds
depositscustomer_deposit array
payoutscustomer_payouts array
virtualaccountscustomer_virtualaccounts array
virtual_cardscustomer_virtual_cards array
crypto_walletscustomer_crypto_wallets array
allAll of the above
Multiple values can be combined: ?include=deposits,payouts
curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202?include=all' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "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": []
  }
}
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.