Return the full customer record — balance, KYC status, and all card details
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.
Bearer YOUR_ACCESS_TOKENyativo_card_id, MongoDB _id, or external_customer_id.| Field | Description |
|---|---|
yativo_card_id | Yativo’s canonical customer identifier |
external_id | Your own reference ID supplied at onboarding |
email | Customer email |
flow_status | Onboarding stage — see onboarding stages |
step | Numeric step (1–6) |
next_action | What needs to happen next for this customer |
kyc_status | pending, in_progress, pending_review, approved, rejected, or expired |
currency | Card currency (USD, EUR, GBP) — null until a region is assigned during KYC |
safe_deployed | Whether the customer’s account wallet has been deployed |
null until the account wallet is deployed.
| Field | Description |
|---|---|
ledger_balance | Total token balance in the customer’s account wallet |
available_balance | Spendable balance after deducting pending authorizations |
pending_balance | Amount held for authorized but not yet settled transactions |
balance_freshness | "realtime" — sourced from live card notifications; "on_chain" — fetched directly from the blockchain (no pending info available) |
balance_updated_at | Timestamp of the last card notification that updated the balance (null when on-chain fallback was used) |
cards represents one card issued to this customer. Full card numbers and CVVs are never returned.
| Field | Description |
|---|---|
card_id | Card identifier |
last_four | Last four digits of the card number |
card_type | virtual or physical |
status | active, frozen, blocked, lost, or voided |
is_frozen | Card is temporarily frozen |
is_lost | Card reported lost |
is_stolen | Card reported stolen (treated as permanently voided) |
is_blocked | Card blocked by program or compliance |
is_void | Card permanently disabled |
activated_at | When the card was first activated |
created_at | When the card was issued |