> ## Documentation Index > Fetch the complete documentation index at: https://docs.dakota.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Report a card found > Report that the cardholder found a card they had reported lost or stolen. Dakota clears the report so the card can be used again. The request has no body. The path names the card. **The card stays frozen.** This clears the report and nothing else. To put the card back in service, send `status: active` to `PATCH /cards/{card_id}` afterwards — which is refused while the report stands, and succeeds once it is cleared. Two steps deliberately: an unfreeze re-runs every other check, including the cardholder's state and the wallet's debt, and a single call that both cleared the report and opened the card would skip all of them. A `manual` freeze you applied yourself is untouched, so a card you had also frozen by hand stays frozen until you lift that too. **It clears the report whatever set it** — the cardholder's own report through `POST /cards/{card_id}/lost_stolen_report`, or a dispute you filed with reason `card_lost` or `card_stolen`. **Any dispute you filed is untouched:** this moves the card's status, never a claim. It is also not a fraud re-check — neither this call nor the unfreeze that follows consults an open dispute, so if you need a claim respected, check it before calling. An `overdrawn` card keeps that status and returns to `frozen` rather than `active` once the debt is paid, which is where the report left it. **It is safe to repeat.** Reporting a card found that carries no report returns 200 with the card as it stands, and does nothing. If a request times out or its response is lost, send it again. A card belonging to another client is answered with 404, the same as a card that does not exist. This endpoint calls the card provider. It is not only a write to Dakota's own table, so expect network latency. > [!WARNING] > > **Sandbox only.** This endpoint is available in sandbox only while we finish development. It is not available in production yet, and its request and response shapes may change before release. ## OpenAPI ````yaml /openapi.yaml post /cards/{card_id}/found_report openapi: 3.0.3 info: title: Dakota Platform API version: 1.0.0 description: >- Combined API specification for Dakota Platform services: - Issuance API: Asset minting and burning operations - Onboarding API: Know Your Business/Customer verification - On/Off Ramp API: Managing on-ramp and off-ramp accounts - Recipients API: Managing destinations for KYB'd entities - Transactions API: Viewing transaction history across platform operations ## Authentication and API Headers All API endpoints require the following headers: - `X-Idempotency-Key`: Required for all POST endpoints to ensure request idempotency - `x-api-key`: Required for authentication across all endpoints Note: On /applications endpoints you need a token for authentication instead of a x-api-key - `x-application-token`: Required for authentication on public /applications endpoints (alternative to `x-api-key` where documented) ## Rate Limits Requests are rate limited per API key. Every response includes the following headers: | Header | Description | | --- | --- | | `X-RateLimit-Limit` | Maximum requests allowed in the current one-minute window. | | `X-RateLimit-Remaining` | Requests remaining in the current window. | | `X-RateLimit-Reset` | Absolute Unix timestamp (seconds since epoch) when the current rate-limit window resets. | When a request is throttled (`429`), responses also include `Retry-After` with seconds to wait before retrying. servers: - url: https://api.platform.dakota.xyz description: Production environment - url: https://api.platform.sandbox.dakota.xyz description: Sandbox — safe for testing with simulated data security: - ApiKeyAuth: [] tags: - name: Agentic Payments x-beta: true description: >- Beta — agent-driven payments: provision agents, draft and approve spending mandates, accept reviewed instructions, and manage scheduled payments. **Prerequisites:** Customer onboarded; signer groups attached for recognition. **Related:** Wallets, Signer Groups, Transactions - name: Mandates x-beta: true description: >- Beta — spending mandates: signed, signer-bound authorizations governing what may be spent, approved or cancelled by a second recognized signer (§8 — the dual-control rule that every mandate mutation must be signed by a recognized signer OTHER than the bound one). Independent of agents and scheduled payments. **Prerequisites:** Signer groups attached for recognition. **Related:** Signer Groups, Transactions - name: Insights x-beta: true description: >- Beta — read-only insight: a deterministic report over a customer's agentic activity (funding balances, upcoming obligations, failures, mandate headroom and expiry), or — via `GET /insights` — over the whole client's book, with portfolio KPIs, daily series and a per-customer roll-up. Never moves money, never creates or changes anything. **Prerequisites:** Customer onboarded; insight is computed from the customer's scheduled payments, mandates, and wallets. **Related:** Agentic Payments, Mandates - name: Customers description: >- Manage customer entities representing businesses and organizations onboarded to Dakota. **Prerequisites:** Complete KYB via Onboarding endpoints before initiating money movement. **Related:** Onboarding, Recipients, Transactions, Accounts, Wallets - name: Wallets description: >- Manage wallets, balances, and wallet-to-signer-group relationships for custody and movement controls. **Prerequisites:** Customer must exist. Configure signer groups before policy-enforced workflows. **Related:** Signer Groups, Policies, Transactions, Customers - name: Transactions description: >- Create, cancel, and retrieve transaction records across account and wallet flows. **Prerequisites:** Accounts or destinations must be configured based on flow type. **Related:** Accounts, Recipients, Policies, Events - name: Recipients description: >- Manage recipient entities and destination rails used by customers for payouts and transfers. **Prerequisites:** Customer must be onboarded and active. **Related:** Customers, Transactions, Accounts, Onboarding - name: Cards description: >- Issue and manage cardholders and cards, and follow card transactions. Every change is also delivered as a webhook event. **Prerequisites:** Customer must be onboarded and the cards capability must be available. **Related:** Customers, Wallets, Events ### Webhook event catalog (v1) Every card-family event a client can subscribe to, in one place: | Event | Fires when | | -- | -- | | `cardholder.created` | A cardholder is created. | | `cardholder.updated` | Any cardholder change, including every review-status transition and deletion (`status: closed`). | | `cardholder.information_requested` | A reviewer asks for more information; the payload lists the open requirements. | | `card.created` | A card is created. | | `card.updated` | Any card change: status, spend limit, last4, freeze sources. A close arrives here with `status: closed`. | | `card_transaction.created` | The first event for a transaction, normally an authorization (`status: authorized`) placing a hold. A declined authorization also arrives here, with `status: declined`. | | `card_transaction.updated` | Every later change to the same transaction (see below). | | `wallet.card_enablement.completed` | A wallet's card-settlement enablement became active. | **Card event ordering.** `card.created` and `card.updated` carry the card as it stands after the change, including `version` and `freeze_sources` (always an array, empty when nothing holds the card). `version` is strictly increasing per card and matches the `version` on the card resource. Deliveries can arrive out of order, so keep the highest `version` you have applied for each card and drop any event whose `version` is not greater than it. **One transaction stream.** Holds, releases, partial clearings, settlement, returns, disputes and force posts are not separate event types. They are `status` transitions on the transaction, delivered as `card_transaction.updated` with the same payload shape as `card_transaction.created`: | What happened | `status` on the event | | -- | -- | | Transaction known before its first authorization event | `pending` (on `card_transaction.created`) | | Hold placed (authorization) | `authorized` (on `card_transaction.created`, or `card_transaction.updated` after a `pending` start) | | Hold released without clearing (merchant, issuer or network reversal) | `auth_reversed` | | Hold expired unused | `expired` | | Part of the hold settled | `partially_cleared` (with the new `cleared_amount`) | | Fully settled | `cleared` | | Settled with no prior hold | `force_posted` | | Merchant refund | `returned`, usually on a new card transaction for the refund while the original purchase stays `cleared`. A refund can also land on the purchase's own transaction, which keeps its purchase status until the refunds cover everything that cleared and nothing authorized is left to clear. A transaction carries a refund whenever `refund_state` has a value, whatever its `status`. `returned_amount` is how much was refunded. The network returned the money; read `refund_state` for whether it reached the customer's wallet: `pending` while owed, then `paid`; `reversed` when every refund was cancelled before payout; `failed` when a payout failed. `returned` alone is not proof of payout. | | Merchant refund on its own transaction, fully reversed before it is paid out | `auth_reversed` on the refund's card transaction, with `refund_state: reversed`. The refund is withdrawn; `refund_state` is what tells it from a released hold. | | Chargeback opened | `disputed` (reserved; not emitted yet) | | Authorization refused | `declined` (on `card_transaction.created`, or `card_transaction.updated` when the transaction already exists). Moves no money; read `decline_reason` and `decline_code` for why. | `outstanding_amount` is the part of `cleared_amount` that no authorization covered, less any refunds: non-zero after a force post or an over-capture. **Naming.** A dotted segment names a sub-resource of the resource before it, so `wallet.card_enablement.*` is a wallet's card enablement. `card_transaction.*` carries an underscore because the resource is `card_transactions`, a top-level resource, not a sub-resource of a card. It is not a typo, and there is no `card.transaction.*` family, and no separate settlement event: settlement is a `status` on `card_transaction.updated`. **Two states on a dispute report, and neither derives from the other.** `filing_state` is how far the automated filing with the provider has got. `state` is the Dakota operator workflow, where `filed_at_vendor` still means a person filed by hand. A successful automated filing does not move `state`. Read the one you mean. - name: Accounts description: >- Manage account resources used for onramp, offramp, and swap operations. **Prerequisites:** Customer must be created and network/asset constraints must be known. **Related:** Customers, Transactions, Auto Transactions, Info - name: Auto Transactions description: >- Manage automated transaction configurations and execution history for account automation workflows. **Prerequisites:** Source account must exist and be configured for automation. **Related:** Accounts, Transactions, Events - name: Onboarding description: >- Manage KYB/KYC onboarding lifecycle, application documents, attestations, and verification steps. **Prerequisites:** Customer context and required entity/application metadata. **Related:** Customers, Exceptions, Recipients, Transactions - name: Policies description: >- Define and manage policy objects and rules used for transaction governance and risk controls. **Prerequisites:** Wallet and signer group resources should be configured for enforcement scenarios. **Related:** Wallets, Signer Groups, Transactions - name: Signer Groups description: >- Manage signer groups and signer assignments for multi-party authorization models. **Prerequisites:** Wallets should exist before linking signer groups. **Related:** Wallets, Policies, Transactions - name: Authentication description: >- Manage API authentication credentials and key lifecycle for platform access. **Prerequisites:** Client organization must be provisioned. **Related:** Users, Info - name: Users description: >- Manage client users, roles, and identity metadata for platform access control. **Prerequisites:** Auth credentials and client context must be established. **Related:** Authentication - name: Webhooks description: >- Manage outbound webhook targets and delivery configuration for event notifications. **Prerequisites:** Subscriber endpoint must be reachable and secured. **Related:** Events, Authentication - name: Payouts description: >- Manage where Dakota sends your accrued developer-fee payouts. **Prerequisites:** Auth credentials and client context must be established. **Related:** Events - name: RD Marketing Fee description: >- Everything behind your RD marketing fee: read what a month came to, declare the wallets you hold outside Dakota so the RD in them counts, and say where the fee should be sent. **Prerequisites:** Client must be in the RD marketing-fee programme. A month is readable once it has closed. **Related:** Wallets, Events - name: Self Serve description: >- Buy and track prepaid credits, and read the tiers and pricing they are sold at. **Prerequisites:** Auth credentials and client context must be established. **Related:** Billing - name: Events description: >- Retrieve event records emitted by platform operations for audit and troubleshooting. **Prerequisites:** Requesting client must have access to referenced resources. **Related:** Webhooks, Transactions, Onboarding - name: Info description: >- Read platform capability metadata, such as supported rails, networks, and assets. These operations are served under `/capabilities/*` - `GET /capabilities/countries` and `GET /capabilities/networks`. The tag name does not appear in the request paths. **Prerequisites:** Valid authentication headers. **Related:** Accounts, Transactions - name: Sandbox description: >- Trigger sandbox-only simulation endpoints for safe end-to-end integration testing with synthetic data. The sandbox host (`https://api.platform.sandbox.dakota.xyz`) also accepts a family of `X-Sandbox-*` request headers on most write endpoints (`Customers`, `Accounts`, `Transactions`, simulate endpoints) that let integrators drive deterministic failure modes — pick a preset via `X-Sandbox-Scenario`, or compose a custom one with `X-Sandbox-Error-Step`/`X-Sandbox-Error-Status`/`X-Sandbox-Error-Message`. `X-Sandbox-Instant-Completion` collapses async flows to a single synchronous step, and `X-Sandbox-Skip-Auto-Approval` keeps newly created KYB applications in `pending` for manual-review testing. All `X-Sandbox-*` headers are ignored in production. **Prerequisites:** Sandbox environment and test customer data. **Related:** Customers, Accounts, Transactions, Onboarding - name: Legal description: |- The legal documents customers accept — terms of service, privacy policy, e-sign notice, and partner agreements. Dakota publishes these here, and this is the authoritative source: the hosted onboarding flow, the dakota.xyz website, and your own integration all read the same revisions. Present the current revision to your customer before capturing their acceptance so the record reflects the text they actually saw. paths: /cards/{card_id}/found_report: parameters: - name: card_id in: path required: true schema: $ref: '#/components/schemas/KSUID' post: tags: - Cards summary: Report a card found description: > Report that the cardholder found a card they had reported lost or stolen. Dakota clears the report so the card can be used again. The request has no body. The path names the card. **The card stays frozen.** This clears the report and nothing else. To put the card back in service, send `status: active` to `PATCH /cards/{card_id}` afterwards — which is refused while the report stands, and succeeds once it is cleared. Two steps deliberately: an unfreeze re-runs every other check, including the cardholder's state and the wallet's debt, and a single call that both cleared the report and opened the card would skip all of them. A `manual` freeze you applied yourself is untouched, so a card you had also frozen by hand stays frozen until you lift that too. **It clears the report whatever set it** — the cardholder's own report through `POST /cards/{card_id}/lost_stolen_report`, or a dispute you filed with reason `card_lost` or `card_stolen`. **Any dispute you filed is untouched:** this moves the card's status, never a claim. It is also not a fraud re-check — neither this call nor the unfreeze that follows consults an open dispute, so if you need a claim respected, check it before calling. An `overdrawn` card keeps that status and returns to `frozen` rather than `active` once the debt is paid, which is where the report left it. **It is safe to repeat.** Reporting a card found that carries no report returns 200 with the card as it stands, and does nothing. If a request times out or its response is lost, send it again. A card belonging to another client is answered with 404, the same as a card that does not exist. This endpoint calls the card provider. It is not only a write to Dakota's own table, so expect network latency. operationId: createCardFoundReport parameters: - $ref: '#/components/parameters/IdempotencyKeyHeader' responses: '200': description: | The report is cleared. `freeze_sources` no longer includes `lost_stolen`, and `status` still reads `frozen` — clearing a report is not an unfreeze. An `overdrawn` card keeps its own status. content: application/json: example: id: 2tQRvvnYkN6edEJUTmF1LzTj2ug cardholder_id: 31TgvufZK3gDXBcA3BnSeLWiSn7 customer_id: 2tQRvD3xFcJ7bKpW9qNsT4hZmYr wallet_id: 2tQRvK9pRzM4nVbW8sHqL5jXmYt status: frozen version: 5 last4: '4242' external_id: ads-card-01 nickname: Ads card freeze_sources: [] created_at: 1758211200 updated_at: 1758213000 schema: $ref: '#/components/schemas/CardResponse' '400': description: Invalid request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: | Forbidden. `#card-closed`: the card is closed. Closing is terminal, so a closed card can no longer be modified, and a report on it can no longer be cleared. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '502': description: Card provider unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' servers: - url: https://api.platform.sandbox.dakota.xyz description: Sandbox components: schemas: KSUID: type: string title: KSUID description: >- KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform. pattern: ^[0-9A-Za-z]{27}$ minLength: 27 maxLength: 27 example: 1NFHrqBHb3cTfLVkFSGmHZqdDPi CardResponse: type: object title: Card Response description: Response containing card details. required: - id - cardholder_id - customer_id - wallet_id - status - version - created_at - updated_at properties: id: $ref: '#/components/schemas/KSUID' cardholder_id: $ref: '#/components/schemas/KSUID' customer_id: $ref: '#/components/schemas/KSUID' wallet_id: $ref: '#/components/schemas/KSUID' version: type: integer format: int64 minimum: 1 description: >- The card's version, strictly increasing for this card. It is bumped by one on every change that emits a `card.created` or `card.updated` event, including a request that changes nothing, and the same value appears as `version` in that event's payload. Webhook deliveries can arrive out of order, and `updated_at` has only one-second resolution, so neither orders them. Keep the highest `version` you have applied for each card and drop any event or response whose `version` is not greater than it. example: 7 status: type: string description: > Current status of the card. Returns `pending` on create; flips to `active` via a `card.updated` webhook. `overdrawn`: The card's wallet owes money after a lost dispute. The card declines every authorization. It returns to its earlier status when the debt is paid. A client cannot request this status, and cannot set `active` or `frozen` while the card holds it. enum: - pending - active - frozen - closed - overdrawn example: pending last4: type: string nullable: true description: Non-sensitive last four digits, populated from the card provider. example: '4242' spend_limit: $ref: '#/components/schemas/SpendLimit' nullable: true external_id: type: string nullable: true nickname: type: string nullable: true maxLength: 64 description: Client-supplied display name for the card. Null when none was set. example: Ads card freeze_sources: type: array items: $ref: '#/components/schemas/CardFreezeSource' description: >- What is currently holding a freeze on this card, distinct and sorted. Empty when nothing is. A card is frozen while any source holds it, and lifting one source does not lift another. Read this rather than inferring the cause from `status`: `status` reports the card's state at the issuer, so it says only that the card is frozen, never why. `manual` is a freeze applied through this API and is the only source a client can lift, by sending `status: active` to this card's PATCH endpoint. While any other source is present that request is rejected with a `card-freeze-held` problem, because no card-level action will clear it. `lost_stolen` is the exception that has a remedy: the cardholder reported the card lost or stolen, and reporting it found with `POST /cards/{card_id}/found_report` clears the report and leaves the card frozen. The ordinary unfreeze works after that. example: - manual created_at: type: integer description: Unix timestamp (seconds) of creation. updated_at: type: integer description: Unix timestamp (seconds) of last update. cardholder: $ref: '#/components/schemas/CardholderResponse' description: The cardholder this card belongs to. wallet: $ref: '#/components/schemas/CardWalletResponse' description: >- The wallet this card draws on. Populated on the single-card detail endpoint; omitted from list responses. ProblemDetails: type: object required: - type - title - status description: | Error response following RFC 9457 Problem Details. Public API error responses use this format. example: type: https://docs.dakota.xyz/api-reference/errors#not-found title: Customer Not Found status: 404 detail: Customer cst_2abc123 was not found in your organization. instance: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: req_7f3a8b2c properties: type: type: string format: uri description: | URI reference identifying the problem type. Resolves to human-readable documentation. example: https://docs.dakota.xyz/api-reference/errors#not-found title: type: string description: >- Short, human-readable summary of the problem type. Stable across occurrences. example: Customer Not Found status: type: integer description: HTTP status code for this occurrence. example: 404 detail: type: string description: Human-readable explanation specific to this occurrence. example: Customer cst_2abc123 was not found in your organization. instance: type: string format: uri description: The request path that triggered this error. example: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: type: string description: Unique request identifier. Include when contacting support. example: req_7f3a8b2c errors: type: array description: Field-level validation errors (present for validation failures). items: $ref: '#/components/schemas/ValidationError' resolution_url: type: string format: uri description: | A link the customer can follow to CLEAR this error, present only on problems with a concrete self-service remedy. Today this is returned by `#terms-not-accepted`, where it points at the hosted flow in which the outstanding agreement can be signed. The link is token-gated and usable as-is — send the customer to it directly rather than parsing it out of `detail`. example: >- https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c user_message: type: string description: | A plain-language rendition of `detail` written for the end customer, present when one exists for this error. `detail` names request fields and actions so a machine caller (such as a payment agent drafting proposals) can self-correct; `user_message` says the same thing without API vocabulary. Clients that relay errors into a human surface (chat, email, UI) should show `user_message` when present and fall back to `detail`. example: >- ACH payments pay out USD, so a USDC payout isn't possible on this rail. Change the payout currency to USD and try again. reason: type: string description: > A stable, machine-readable code for why the request was refused, present only when Dakota has a typed reason for this error. Branch on `reason` rather than parsing `detail`. When `reason` is a value from the table below other than `signature_required` and `immutable_field`, `detail` is text Dakota writes for that reason, never a partner's or a bank's wording. For those two, `detail` is the text written for that specific refusal. In every case the wording can change, so do not parse it. This is an open set: new values are added over time and a value is never repurposed, so treat an unrecognized `reason` as absent. Which operations return it today: - `createAccount` (onramp, offramp and swap) and `createTransaction` (a one-off transaction creates an account): every value in the table except `immutable_field`; `signature_required` comes from `createTransaction` only. - `updateAccount`: `field_invalid` (a developer fee that is out of range), `resource_not_found`, and `immutable_field` (the change would alter the account's routing; create a new account instead). - `deleteAccount`: `resource_not_found`. - `createInstructions`: a payment-agent instruction that creates an account fails with the same `reason` values as `createAccount`, but `params.field` is never returned there: the response carries the other `params` keys only, because this operation has no public field names to map to. - Other operations may also set `reason`. Treat a `reason` you do not recognize as absent, as above, and never assume an operation that is not listed here omits it. | `reason` | Meaning | `params` | | --- | --- | --- | | `field_required` | A required request field is missing. | `field` | | `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` | | `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` | | `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` | | `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` | | `unsupported_network` | The network is not supported. | `network` | | `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` | | `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` | | `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` | | `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` | | `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` | | `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` | | `resource_not_found` | The named resource does not exist. | `resource` | | `duplicate_resource` | A matching resource already exists. | `resource` | | `request_rejected` | The request was refused and the reason is not disclosed. | none | | `signature_required` | The request must be signed. | none | | `immutable_field` | The field cannot be changed on an existing account; create a new one. | none | example: field_too_long params: type: object description: | Parameters of `reason`. Every value is a string: a number, a token from a closed set, or the public name of a request field (`field` is expressed in this operation's request body, and is omitted when the offending value has no public name). Never free text. Present only alongside `reason`, and only when the reason has parameters. additionalProperties: type: string example: field: payment_reference max: '35' actual: '40' rail: swift SpendLimit: type: object title: Spend Limit description: | A single cap on card spend, enforced when a purchase is authorized. A `per_transaction` limit is checked against the amount the purchase holds, which in some merchant categories is larger than the purchase: a fuel-pump authorization below 175 USD holds 175 USD, and a restaurant holds 30% above the bill. `daily`, `weekly`, `monthly` and `yearly` limits count the purchase amount. required: - interval - amount properties: interval: type: string description: Named calendar window the limit resets on. enum: - per_transaction - daily - weekly - monthly - yearly - lifetime example: monthly amount: type: integer description: Limit amount in minor units (cents). minimum: 1 example: 1000000 CardFreezeSource: type: string title: Card Freeze Source description: >- What is holding a freeze on a card. `manual` is a freeze applied deliberately through this API, and is the only source a client can lift. `lost_stolen` is a freeze held because the cardholder reported the card lost or stolen. A request to set the card `active` while it is held is refused. To release it, report the card found with `POST /cards/{card_id}/found_report`, which clears the report and leaves the card frozen; the ordinary unfreeze works after that. This enum grows as new freeze causes are built — a value is added when it can actually occur, never before. Treat any value other than `manual`, including one your client does not recognise, as a hold no card-level request will clear. enum: - manual - lost_stolen example: manual CardholderResponse: type: object title: Cardholder Response description: Response containing cardholder details. required: - id - customer_id - first_name - last_name - email - phone - status - created_at - updated_at properties: id: $ref: '#/components/schemas/KSUID' customer_id: $ref: '#/components/schemas/KSUID' first_name: type: string last_name: type: string email: type: string phone: type: string status: type: string description: >- Current status of the cardholder. Returns `pending` on create; on the clean path it flips to `active` within seconds via a `cardholder.updated` webhook. An enrollment flagged during screening takes a longer route: `pending` → `under_review` (a reviewer holds it) → `request_for_information` (the reviewer needs something from you) → `active` or `declined`. You answer information requests through the API; there is never a cardholder-facing link. Every transition emits `cardholder.updated`, and opening a request also emits `cardholder.information_requested`. `suspended` and `closed` are lifecycle rather than review states. `closed` is terminal and appears only in the `cardholder.updated` webhook emitted when a cardholder is deleted — deleted cardholders are not returned by the REST endpoints. enum: - pending - under_review - request_for_information - active - declined - suspended - closed example: pending open_requirements: $ref: '#/components/schemas/CardholderOpenRequirements' external_id: type: string nullable: true created_at: type: integer description: Unix timestamp (seconds) of creation. updated_at: type: integer description: Unix timestamp (seconds) of last update. CardWalletResponse: type: object title: Card Wallet Response description: Wallet details embedded in a card response. required: - id - address - family properties: id: $ref: '#/components/schemas/KSUID' address: type: string description: The wallet's blockchain address. example: '0x165cd37b4c644c2921454429e7f9358d18a45e14' family: $ref: '#/components/schemas/Family' ValidationError: type: object required: - field - message properties: field: type: string description: Field path using dot notation for nested fields. example: bank_account.routing_number message: type: string description: Human-readable description of the field error. example: Routing number must be exactly 9 digits code: type: string description: Machine-readable error code for this field. example: invalid_format CardholderOpenRequirements: type: object title: Cardholder Open Requirements description: >- Summary of what a reviewer is currently waiting on for this cardholder. `count` is `0` and `types` is empty unless the cardholder is in `request_for_information`. This is a summary only. Read the individual items, with their descriptions, from `GET /cardholders/{cardholder_id}/application`. required: - count - types properties: count: type: integer description: >- Number of requirements still outstanding, that is those with status `missing`. Requirements already satisfied (`on_file`) are excluded, so this can be lower than the length of `requested_information` on the application. example: 0 types: type: array description: >- The distinct kinds of information still outstanding, deduplicated. Satisfied requirements do not contribute a type. items: $ref: '#/components/schemas/CardholderRequirementType' example: [] Family: type: string title: Family description: Blockchain family for the crypto account. enum: - evm - solana example: evm CardholderRequirementType: type: string title: Cardholder Requirement Type description: >- The kind of information a reviewer has asked for. `field` is a value on the cardholder that must be corrected, `question` is free text a reviewer asked, and `document` is a file that must be supplied. enum: - document - field - question example: document parameters: IdempotencyKeyHeader: name: x-idempotency-key in: header required: true description: >- Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests. A key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a successful (below 400) response. Repeating the same request (same JSON body, whatever the key order or whitespace) with the same key within that window returns the original response with `X-Idempotent-Replayed: true` instead of executing the request again. Using the same key on the same endpoint with a different body returns `422` with problem type `idempotency-key-reused`; the request is not executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason can be corrected and retried under the same key. Request bodies that are not JSON (for example file uploads) are not compared. schema: type: string format: uuid securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.