{
"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"
}
{
"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"
}
{
"type": "https://docs.dakota.xyz/api-reference/errors#cards-capability-unavailable",
"title": "Cards Capability Unavailable",
"status": 403,
"detail": "The cards capability is not available for this customer.",
"errors": [
{
"field": "cards_tos",
"message": "Cards Terms of Service must be accepted before creating a cardholder.",
"code": "terms_acceptance"
}
]
}
{
"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"
}
{
"type": "https://docs.dakota.xyz/api-reference/errors#cardholder-person-exists",
"title": "Cardholder Person Exists",
"status": 409,
"detail": "A person with this email already exists on this application. Send person_id 2abc123 instead.",
"person_id": "2abc123"
}
{
"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"
}
{
"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"
}
{
"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"
}
{
"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"
}
Cards
Create a cardholder
Create a cardholder for the given customer, gated on the cards capability being available.
The cardholder is created synchronously and returns in pending status, then transitions to
active via a cardholder.updated webhook.
The request body is one of three shapes, chosen by which fields are present:
CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on
file; optional email): for an
INDIVIDUAL customer. Name is taken from the individual on the customer’s latest approved
application; email too, unless the individual has none on file, in which case the request
email is required.
CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on
file; optional email): for a
BUSINESS customer, creates a cardholder from an existing person returned by
GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the
person has none on file, in which case the request email is required.
CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a
BUSINESS customer, creates a cardholder from contact details supplied directly, without an
existing person to reference.
An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the
second or third; sending person_id together with first_name/last_name is ambiguous and
refused. Shared email addresses between persons are not supported: whenever a shape takes its
email from the request (a new-person request’s email, or one supplied for a person with none
on file), an email matching a person already on the application is refused with
#cardholder-person-exists rather than silently creating a second person under the same
address.
person_id is validated the same way whether it fails to parse into any application person or
the customer has no approved application at all: both are the same 400 field violation on
person_id, so a caller can never use the response to probe for another customer’s application
or persons.
{
"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"
}
{
"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"
}
{
"type": "https://docs.dakota.xyz/api-reference/errors#cards-capability-unavailable",
"title": "Cards Capability Unavailable",
"status": 403,
"detail": "The cards capability is not available for this customer.",
"errors": [
{
"field": "cards_tos",
"message": "Cards Terms of Service must be accepted before creating a cardholder.",
"code": "terms_acceptance"
}
]
}
{
"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"
}
{
"type": "https://docs.dakota.xyz/api-reference/errors#cardholder-person-exists",
"title": "Cardholder Person Exists",
"status": 409,
"detail": "A person with this email already exists on this application. Send person_id 2abc123 instead.",
"person_id": "2abc123"
}
{
"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"
}
{
"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"
}
{
"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"
}
{
"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"
}
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.
Authorizations
x-api-key
string
header
required
Headers
x-idempotency-key
string<uuid>
required
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.
Path Parameters
customer_id
string
required
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.
Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:
"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Body
application/json
Cardholder details
Create Cardholder For Individual Customer Request
Create Cardholder From Person Request
Create Cardholder For New Person Request
Creates a cardholder for an INDIVIDUAL customer. Name is not supplied here -- it is taken from the individual on the customer's latest approved onboarding application. email follows the same on-file rule as CreateCardholderFromPersonRequest: required only when the person has none on file, and otherwise rejected if it disagrees with the one already there. phone is optional when a phone number is on file for the individual, and required (a 400 on phone) when none is.
phone
string
Optional when a phone number is on file for the individual: the one on file is used when this is omitted, and a phone sent here is used instead. Required when none is on file. The cardholder's own mobile number, E.164-formatted (a +1 number must be a North American number that can exist: 10 digits after the +1, with an area code and exchange that do not start with 0 or 1). It is used to verify
the cardholder at online checkouts that ask for 3-D Secure, so do not send
a shared or placeholder number.
Example:
"+15555550123"
email
string<email>
Required only when the individual has no email on file. Otherwise omit it; sending a different email than the one already on file is rejected.
Maximum string length: 254
Example:
"ada@example.com"
external_id
string | null
Optional client-supplied lookup key.
address
Address · object
Optional override for the cardholder's residential address. When omitted, the customer's stored address is used for the country check and for provisioning: the business's address for a business customer, and the individual's onboarding address for an individual customer.
An address sent here must be one the card issuer accepts, or the request is refused with a 400 naming the field (errors[].code is cardholder_address_invalid) and nothing is created: every address needs street1 and city; a US address (country of US) also needs region, a two-letter US state or territory code such as CA, and postal_code, five digits or ZIP+4 such as 12345-1234; an address in the Cayman Islands (KY) or the British Virgin Islands (VG) needs a postal_code in that country's format (KY1-1234, VG1110).
Show child attributes
Response
Cardholder created successfully
Response containing cardholder details.
id
string
required
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.
Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:
"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
customer_id
string
required
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.
Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:
"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
first_name
string
required
last_name
string
required
email
string
required
phone
string
required
status
enum<string>
required
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.
Available options:
pending,
under_review,
request_for_information,
active,
declined,
suspended,
closed
Example:
"pending"
created_at
integer
required
Unix timestamp (seconds) of creation.
updated_at
integer
required
Unix timestamp (seconds) of last update.
open_requirements
Cardholder Open Requirements · object
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.
Show child attributes
external_id
string | null
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Dakota","colors":{"primary":"#8e4410","light":"#a36336","dark":"#72360d"},"logo":{"light":"https://mintcdn.com/dakota-49818541/-tkRmX-DtPxqfDgt/images/dakota-logo-black.png?fit=max\u0026auto=format\u0026n=-tkRmX-DtPxqfDgt\u0026q=85\u0026s=c409f7b8cec2e984bd0c79735f637bfe","dark":"https://mintcdn.com/dakota-49818541/-tkRmX-DtPxqfDgt/images/dakota-logo-white.png?fit=max\u0026auto=format\u0026n=-tkRmX-DtPxqfDgt\u0026q=85\u0026s=9e77213d983822ac9d3e6cb211500b1f"},"favicon":"https://mintcdn.com/dakota-49818541/-tkRmX-DtPxqfDgt/favicon.png?fit=max\u0026auto=format\u0026n=-tkRmX-DtPxqfDgt\u0026q=85\u0026s=a998c62579c0a092af10b861d4c26197","api":{"openapi":"openapi.yaml","params":{"expanded":"closed"},"playground":{"display":"simple","proxy":false},"examples":{"languages":["curl","javascript","python","go"]}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://platform.dakota.xyz/signin","label":"Login"}],"primary":{"type":"button","label":"Get Started","href":"https://dakota.xyz/talk-to-sales"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"search":{"prompt":"Search or ask..."},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"https://support.dakota.xyz"},{"anchor":"Contact us","icon":"envelope","href":"https://dakota.xyz/talk-to-sales"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dakota-49818541","hasAudioNarration":false,"actualSubdomain":"dakota-49818541","customDomains":["docs.dakota.xyz"],"gitSource":{"type":"github","owner":"dakota-xyz","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"documentation","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b006440baa97067db115bcf","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":200},{"language":"default","tag":"Documentation","count":80},{"language":"default","tag":"Cards","count":42},{"language":"default","tag":"Agentic Payments","count":32},{"language":"default","tag":"Onboarding","count":26},{"language":"default","tag":"Authentication","count":13},{"language":"default","tag":"Signer Groups","count":13},{"language":"default","tag":"Customers","count":11},{"language":"default","tag":"Policies","count":10},{"language":"default","tag":"RD Marketing Fee","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"[data-callout=\"note\"]{--callout-bg: #291f14 !important;--callout-border: #523e27 !important;--callout-icon: #9c8873 !important;background:#291f14!important;border-color:#523e27!important}[data-callout=\"note\"] svg{color:#9c8873!important}[data-callout=\"tip\"]{--callout-bg: #391b06 !important;--callout-border: #8e4410 !important;--callout-icon: #b9825b !important;background:#391b06!important;border-color:#8e4410!important}[data-callout=\"tip\"] svg{color:#b9825b!important}[data-callout=\"warning\"]{--callout-bg: #310a0c !important;--callout-border: #7b181d !important;--callout-icon: #ab5e62 !important;background:#310a0c!important;border-color:#7b181d!important}[data-callout=\"warning\"] svg{color:#ab5e62!important}[data-callout=\"info\"]{--callout-bg: #232222 !important;--callout-border: #464543 !important;--callout-icon: #929190 !important;background:#232222!important;border-color:#464543!important}[data-callout=\"info\"] svg{color:#929190!important}[data-callout=\"check\"]{--callout-bg: #283126 !important;--callout-border: #647a5e !important;--callout-icon: #a2af9e !important;background:#283126!important;border-color:#647a5e!important}[data-callout=\"check\"] svg{color:#a2af9e!important}[data-callout]{color:#FFFFFF!important}[data-callout] p,[data-callout] span,[data-callout] li{color:#cdcccb!important}[data-callout] a{color:#cea181!important}[data-callout] a:hover{color:#e4c0a6!important}.prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)):not(.card):not([class*=\"card\"]){color:var(--tw-prose-links);text-decoration:none;font-weight:600;border-bottom:1px solid rgba(142, 68, 16, 0.4);word-wrap:break-word;position:relative;z-index:10}.prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)):not(.card):not([class*=\"card\"]):hover{border-bottom-color:rgba(142, 68, 16, 1)}.prose a[href*=\"llms.txt\"] code,.prose a[href*=\"llms-full.txt\"] code{background-color:rgba(142, 68, 16, 0.05);padding:2px 4px;border-radius:4px;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace;font-size:0.9em}.prose a[href*=\"llms.txt\"]:hover code,.prose a[href*=\"llms-full.txt\"]:hover code{background-color:rgba(142, 68, 16, 0.08)}.link,.link>code{position:relative}.link{z-index:10}.flow-modal-overlay{z-index:2147483647!important;position:fixed!important}.flow-modal-overlay>*{position:relative;z-index:1}.method-nav-pill{display:none!important}#floating-assistant-container{display:none!important;position:fixed;left:0;right:0;bottom:0;padding:0 1rem 1rem;flex-direction:column;align-items:center;width:100%;z-index:20;pointer-events:none}#floating-assistant-wrapper{z-index:10;width:100%;max-width:24rem;transition:max-width 300ms ease-out, transform 300ms ease-out}#floating-assistant-wrapper:hover{transform:scale(1.05)}#floating-assistant-wrapper:focus-within{max-width:30rem;transform:scale(1)}#floating-assistant-form{display:flex;flex-direction:column;width:100%;border-radius:1rem;pointer-events:auto;background:rgba(255, 255, 255, 0.9);backdrop-filter:blur(24px);border:1px solid rgba(200, 200, 200, 0.3);box-shadow:0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px -5px rgba(0, 0, 0, 0.04);transition:border-color 300ms}.dark #floating-assistant-form{background:rgba(30, 30, 30, 0.9);border-color:rgba(255, 255, 255, 0.3)}#floating-assistant-form:focus-within{border-color:#8e4410}.dark #floating-assistant-form:focus-within{border-color:#a36336}#floating-assistant-input-wrapper{position:relative;display:flex;align-items:end}#floating-assistant-input{width:100%;background:transparent;border:0;color:#111827;outline:none;padding:0.625rem 2.5rem 0.625rem 0.875rem;font-size:0.875rem;resize:none;height:60px!important;font-family:inherit}.dark #floating-assistant-input{color:#f3f4f6}#floating-assistant-input::placeholder{color:#6b7280}.dark #floating-assistant-input::placeholder{color:#9ca3af}#floating-assistant-shortcut-hint{position:absolute;right:2.75rem;bottom:0.75rem;font-size:0.75rem;font-weight:500;color:#9ca3af;user-select:none;pointer-events:none;display:none}@media (min-width: 640px){#floating-assistant-shortcut-hint{display:inline}}#floating-assistant-input:focus+#floating-assistant-shortcut-hint{display:none}#floating-assistant-submit{display:flex;justify-content:center;align-items:center;border-radius:9999px;padding:0.25rem;width:1.5rem;height:1.5rem;position:absolute;right:0.625rem;bottom:0.5rem;background:rgba(142, 68, 16, 0.3);border:none;cursor:not-allowed;transition:all 200ms}#floating-assistant-submit.active{background:#8e4410;cursor:pointer}#floating-assistant-submit.active:hover{background:#723609}.dark #floating-assistant-submit{background:rgba(163, 99, 54, 0.3)}.dark #floating-assistant-submit.active{background:#a36336}.dark #floating-assistant-submit.active:hover{background:#8e4410}#floating-assistant-submit svg{width:0.875rem;height:0.875rem;color:white}@media (max-width: 640px){#floating-assistant-wrapper{max-width:100%}#floating-assistant-wrapper:hover{transform:scale(1)}}body.dakota-env-switcher-mounted #sidebar-content{padding-bottom:5.5rem!important}#dakota-env-switcher{font-family:inherit;color:#f3f4f6;z-index:30}#dakota-env-switcher[data-in-sidebar=\"true\"]{position:absolute;left:1rem;right:1.25rem;bottom:1rem}#dakota-env-switcher[data-in-sidebar=\"false\"]{position:fixed;left:1rem;bottom:1rem;width:15rem;max-width:calc(100vw - 2rem)}#dakota-env-switcher[data-collapsed=\"true\"]{width:auto;right:auto}#dakota-env-toggle{display:flex;align-items:center;gap:0.5rem;width:100%;padding:0.5rem 0.75rem;border-radius:0.625rem;background:rgba(20, 20, 20, 0.92);border:1px solid rgba(255, 255, 255, 0.08);color:#f3f4f6;font-size:0.8125rem;font-weight:500;cursor:pointer;backdrop-filter:blur(16px);box-shadow:0 8px 20px -8px rgba(0, 0, 0, 0.45);transition:border-color 150ms ease, background 150ms ease}.light #dakota-env-toggle,html:not(.dark) #dakota-env-toggle{background:rgba(255, 255, 255, 0.95);border-color:rgba(0, 0, 0, 0.08);color:#1f2937}#dakota-env-toggle:hover{border-color:rgba(255, 255, 255, 0.18)}.light #dakota-env-toggle:hover,html:not(.dark) #dakota-env-toggle:hover{border-color:rgba(0, 0, 0, 0.18)}#dakota-env-switcher[data-collapsed=\"true\"] #dakota-env-toggle .dakota-env-label,#dakota-env-switcher[data-collapsed=\"true\"] #dakota-env-toggle .dakota-env-caret{display:none}#dakota-env-switcher .dakota-env-dot{width:0.5rem;height:0.5rem;border-radius:9999px;background:#d98e3e;flex-shrink:0;box-shadow:0 0 0 3px rgba(217, 142, 62, 0.18)}#dakota-env-switcher .dakota-env-dot[data-env=\"production\"]{background:#c63d3d;box-shadow:0 0 0 3px rgba(198, 61, 61, 0.18)}#dakota-env-switcher[data-env=\"production\"] #dakota-env-toggle .dakota-env-dot{background:#c63d3d;box-shadow:0 0 0 3px rgba(198, 61, 61, 0.18)}#dakota-env-switcher .dakota-env-label{flex:1;text-align:left;white-space:nowrap}#dakota-env-switcher .dakota-env-caret{opacity:0.6;flex-shrink:0;transition:transform 150ms ease}#dakota-env-switcher[data-open=\"true\"] .dakota-env-caret{transform:rotate(180deg)}#dakota-env-menu{display:none;margin-bottom:0.5rem;padding:0.375rem;border-radius:0.625rem;background:rgba(20, 20, 20, 0.96);border:1px solid rgba(255, 255, 255, 0.08);box-shadow:0 12px 30px -10px rgba(0, 0, 0, 0.55);backdrop-filter:blur(16px);position:absolute;bottom:100%;left:0;right:0}.light #dakota-env-menu,html:not(.dark) #dakota-env-menu{background:rgba(255, 255, 255, 0.98);border-color:rgba(0, 0, 0, 0.08)}#dakota-env-switcher[data-open=\"true\"] #dakota-env-menu{display:block}.dakota-env-menu-header{font-size:0.6875rem;font-weight:600;letter-spacing:0.04em;text-transform:uppercase;color:#9ca3af;padding:0.5rem 0.625rem 0.375rem}.light .dakota-env-menu-header,html:not(.dark) .dakota-env-menu-header{color:#6b7280}.dakota-env-option{display:flex;align-items:center;gap:0.625rem;width:100%;padding:0.5rem 0.625rem;background:transparent;border:none;border-radius:0.5rem;color:inherit;text-align:left;cursor:pointer;transition:background 120ms ease}.dakota-env-option:hover{background:rgba(255, 255, 255, 0.06)}.light .dakota-env-option:hover,html:not(.dark) .dakota-env-option:hover{background:rgba(0, 0, 0, 0.04)}.dakota-env-option-text{display:flex;flex-direction:column;flex:1;min-width:0}.dakota-env-option-title{font-size:0.8125rem;font-weight:500;line-height:1.1}.dakota-env-option-host{font-size:0.6875rem;color:#9ca3af;font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace;margin-top:0.125rem;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.light .dakota-env-option-host,html:not(.dark) .dakota-env-option-host{color:#6b7280}.dakota-env-check{opacity:0;color:#8e4410;flex-shrink:0}.dark .dakota-env-check{color:#cea181}.dakota-env-option[aria-selected=\"true\"] .dakota-env-check{opacity:1}.dakota-env-footer{font-size:0.6875rem;color:#9ca3af;padding:0.5rem 0.625rem 0.375rem;border-top:1px solid rgba(255, 255, 255, 0.06);margin-top:0.25rem;line-height:1.35}.light .dakota-env-footer,html:not(.dark) .dakota-env-footer{color:#6b7280;border-top-color:rgba(0, 0, 0, 0.06)}@media (max-width: 768px){#dakota-env-switcher{left:0.75rem;bottom:0.75rem;width:12rem}}[class*=\"Card_card\"]{padding:0.75rem!important}[class*=\"Card_card\"] h3,[class*=\"Card_card\"] [class*=\"title\"]{font-size:0.875rem!important;line-height:1.25rem!important}[class*=\"Card_card\"] p,[class*=\"Card_card\"] [class*=\"description\"]{font-size:0.75rem!important;line-height:1rem!important;margin-top:0.25rem!important}"}]}
{"page":{"pagePath":"api-reference/cards/create-a-cardholder","slug":"/api-reference/cards/create-a-cardholder","pageMetadata":{"title":"Create a cardholder","description":"Create a cardholder for the given customer, gated on the cards capability being available.\nThe cardholder is created synchronously and returns in `pending` status, then transitions to\n`active` via a `cardholder.updated` webhook.\n\nThe request body is one of three shapes, chosen by which fields are present:\n\n- `CreateCardholderForIndividualCustomerRequest` (optional `phone`, required when none is on\n file; optional `email`): for an\n INDIVIDUAL customer. Name is taken from the individual on the customer's latest approved\n application; email too, unless the individual has none on file, in which case the request\n `email` is required.\n- `CreateCardholderFromPersonRequest` (`person_id`; optional `phone`, required when none is on\n file; optional `email`): for a\n BUSINESS customer, creates a cardholder from an existing person returned by\n `GET /customers/{customer_id}/persons`. Name comes from that person; email too, unless the\n person has none on file, in which case the request `email` is required.\n- `CreateCardholderForNewPersonRequest` (`first_name`, `last_name`, `email`, `phone`): for a\n BUSINESS customer, creates a cardholder from contact details supplied directly, without an\n existing person to reference.\n\nAn INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the\nsecond or third; sending `person_id` together with `first_name`/`last_name` is ambiguous and\nrefused. Shared email addresses between persons are not supported: whenever a shape takes its\nemail from the request (a new-person request's `email`, or one supplied for a person with none\non file), an email matching a person already on the application is refused with\n`#cardholder-person-exists` rather than silently creating a second person under the same\naddress.\n\n`person_id` is validated the same way whether it fails to parse into any application person or\nthe customer has no approved application at all: both are the same `400` field violation on\n`person_id`, so a caller can never use the response to probe for another customer's application\nor persons.\n","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /customers/{customer_id}/cardholders","href":"/api-reference/cards/create-a-cardholder","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Create a cardholder for the given customer, gated on the cards capability being available.\\nThe cardholder is created synchronously and returns in \", _jsx(_components.code, {\n children: \"pending\"\n }), \" status, then transitions to\\n\", _jsx(_components.code, {\n children: \"active\"\n }), \" via a \", _jsx(_components.code, {\n children: \"cardholder.updated\"\n }), \" webhook.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The request body is one of three shapes, chosen by which fields are present:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"CreateCardholderForIndividualCustomerRequest\"\n }), \" (optional \", _jsx(_components.code, {\n children: \"phone\"\n }), \", required when none is on\\nfile; optional \", _jsx(_components.code, {\n children: \"email\"\n }), \"): for an\\nINDIVIDUAL customer. Name is taken from the individual on the customer’s latest approved\\napplication; email too, unless the individual has none on file, in which case the request\\n\", _jsx(_components.code, {\n children: \"email\"\n }), \" is required.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"CreateCardholderFromPersonRequest\"\n }), \" (\", _jsx(_components.code, {\n children: \"person_id\"\n }), \"; optional \", _jsx(_components.code, {\n children: \"phone\"\n }), \", required when none is on\\nfile; optional \", _jsx(_components.code, {\n children: \"email\"\n }), \"): for a\\nBUSINESS customer, creates a cardholder from an existing person returned by\\n\", _jsx(_components.code, {\n children: \"GET /customers/{customer_id}/persons\"\n }), \". Name comes from that person; email too, unless the\\nperson has none on file, in which case the request \", _jsx(_components.code, {\n children: \"email\"\n }), \" is required.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"CreateCardholderForNewPersonRequest\"\n }), \" (\", _jsx(_components.code, {\n children: \"first_name\"\n }), \", \", _jsx(_components.code, {\n children: \"last_name\"\n }), \", \", _jsx(_components.code, {\n children: \"email\"\n }), \", \", _jsx(_components.code, {\n children: \"phone\"\n }), \"): for a\\nBUSINESS customer, creates a cardholder from contact details supplied directly, without an\\nexisting person to reference.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the\\nsecond or third; sending \", _jsx(_components.code, {\n children: \"person_id\"\n }), \" together with \", _jsx(_components.code, {\n children: \"first_name\"\n }), \"/\", _jsx(_components.code, {\n children: \"last_name\"\n }), \" is ambiguous and\\nrefused. Shared email addresses between persons are not supported: whenever a shape takes its\\nemail from the request (a new-person request’s \", _jsx(_components.code, {\n children: \"email\"\n }), \", or one supplied for a person with none\\non file), an email matching a person already on the application is refused with\\n\", _jsx(_components.code, {\n children: \"#cardholder-person-exists\"\n }), \" rather than silently creating a second person under the same\\naddress.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"person_id\"\n }), \" is validated the same way whether it fails to parse into any application person or\\nthe customer has no approved application at all: both are the same \", _jsx(_components.code, {\n children: \"400\"\n }), \" field violation on\\n\", _jsx(_components.code, {\n children: \"person_id\"\n }), \", so a caller can never use the response to probe for another customer’s application\\nor persons.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(Warning,{children:[_jsx(_components.strong,{children:`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.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a cardholder","description":"Create a cardholder for the given customer, gated on the cards capability being available.\nThe cardholder is created synchronously and returns in `pending` status, then transitions to\n`active` via a `cardholder.updated` webhook.\n\nThe request body is one of three shapes, chosen by which fields are present:\n\n- `CreateCardholderForIndividualCustomerRequest` (optional `phone`, required when none is on\n file; optional `email`): for an\n INDIVIDUAL customer. Name is taken from the individual on the customer's latest approved\n application; email too, unless the individual has none on file, in which case the request\n `email` is required.\n- `CreateCardholderFromPersonRequest` (`person_id`; optional `phone`, required when none is on\n file; optional `email`): for a\n BUSINESS customer, creates a cardholder from an existing person returned by\n `GET /customers/{customer_id}/persons`. Name comes from that person; email too, unless the\n person has none on file, in which case the request `email` is required.\n- `CreateCardholderForNewPersonRequest` (`first_name`, `last_name`, `email`, `phone`): for a\n BUSINESS customer, creates a cardholder from contact details supplied directly, without an\n existing person to reference.\n\nAn INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the\nsecond or third; sending `person_id` together with `first_name`/`last_name` is ambiguous and\nrefused. Shared email addresses between persons are not supported: whenever a shape takes its\nemail from the request (a new-person request's `email`, or one supplied for a person with none\non file), an email matching a person already on the application is refused with\n`#cardholder-person-exists` rather than silently creating a second person under the same\naddress.\n\n`person_id` is validated the same way whether it fails to parse into any application person or\nthe customer has no approved application at all: both are the same `400` field violation on\n`person_id`, so a caller can never use the response to probe for another customer's application\nor persons.\n","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /customers/{customer_id}/cardholders","href":"/api-reference/cards/create-a-cardholder","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dakota-49818541/166e91537ad3bb02/public/floating-assistant.js","/_mintlify/custom/dakota-49818541/98e4ee9d2a52c1e3/public/env-switcher.js"],"openApiReferenceData":{"operation":{"tags":["Cards"],"summary":"Create a cardholder","description":"Create a cardholder for the given customer, gated on the cards capability being available.\nThe cardholder is created synchronously and returns in `pending` status, then transitions to\n`active` via a `cardholder.updated` webhook.\n\nThe request body is one of three shapes, chosen by which fields are present:\n\n- `CreateCardholderForIndividualCustomerRequest` (optional `phone`, required when none is on\n file; optional `email`): for an\n INDIVIDUAL customer. Name is taken from the individual on the customer's latest approved\n application; email too, unless the individual has none on file, in which case the request\n `email` is required.\n- `CreateCardholderFromPersonRequest` (`person_id`; optional `phone`, required when none is on\n file; optional `email`): for a\n BUSINESS customer, creates a cardholder from an existing person returned by\n `GET /customers/{customer_id}/persons`. Name comes from that person; email too, unless the\n person has none on file, in which case the request `email` is required.\n- `CreateCardholderForNewPersonRequest` (`first_name`, `last_name`, `email`, `phone`): for a\n BUSINESS customer, creates a cardholder from contact details supplied directly, without an\n existing person to reference.\n\nAn INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the\nsecond or third; sending `person_id` together with `first_name`/`last_name` is ambiguous and\nrefused. Shared email addresses between persons are not supported: whenever a shape takes its\nemail from the request (a new-person request's `email`, or one supplied for a person with none\non file), an email matching a person already on the application is refused with\n`#cardholder-person-exists` rather than silently creating a second person under the same\naddress.\n\n`person_id` is validated the same way whether it fails to parse into any application person or\nthe customer has no approved application at all: both are the same `400` field violation on\n`person_id`, so a caller can never use the response to probe for another customer's application\nor persons.\n","operationId":"createCardholder","parameters":["2f69a425-6bc1-4e28-8566-c6f826588c6c"],"requestBody":"cbd1f46a-0e66-4c2f-b4de-a41b7516febb","responses":{"201":"c4d56980-8f8b-4e54-bc89-8076fb69a43b","400":"bfe5b911-bb68-4ed3-a25b-2ffb8683b31c","401":"7a17c844-c31a-4141-b1ad-3b7638ff72fc","403":"05c81ada-0986-4b01-9624-ac271f3e2fd9","404":"19a7554a-3784-4817-bb18-add72e53ab8b","409":"04dbd1c0-9e24-472b-bd87-80c51a0a5b84","422":"2a45be14-1d72-4501-99e8-f9f0f0ffb1ca","501":"c239fc34-a768-425f-a86c-59103bb3034a","502":"5f744c7b-273f-4f0c-928a-ad4e057b57d0","503":"722d09de-47d9-4f38-bd24-61f97da285b3"},"x-mint":{"metadata":{"tag":"Sandbox only"},"content":"\u003cWarning>**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.\u003c/Warning>"},"servers":["a9b7f703-4a74-42e1-bdf3-fc2ee843fff5"],"method":"post","type":"path","security":["9d0155ab-0186-4033-97ea-b2479ae0da6f"],"path":"/customers/{customer_id}/cardholders","baseUrlOptions":["https://api.platform.sandbox.dakota.xyz"],"title":"Create a cardholder","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"2f69a425-6bc1-4e28-8566-c6f826588c6c":{"name":"x-idempotency-key","in":"header","required":true,"description":"Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests.\n\nA key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a\nsuccessful (below 400) response. Repeating the same request (same JSON body, whatever the key order or\nwhitespace) with the same key within that window returns the original response with\n`X-Idempotent-Replayed: true` instead of executing the request again. Using the same key on the same\nendpoint with a different body returns `422` with problem type `idempotency-key-reused`; the request is\nnot executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason\ncan be corrected and retried under the same key. Request bodies that are not JSON (for example file\nuploads) are not compared.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests.\n\nA key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a\nsuccessful (below 400) response. Repeating the same request (same JSON body, whatever the key order or\nwhitespace) with the same key within that window returns the original response with\n`X-Idempotent-Replayed: true` instead of executing the request again. Using the same key on the same\nendpoint with a different body returns `422` with problem type `idempotency-key-reused`; the request is\nnot executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason\ncan be corrected and retried under the same key. Request bodies that are not JSON (for example file\nuploads) are not compared.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"6a4bbac6-4126-4817-a02c-b8775f508894":{"name":"customer_id","in":"path","required":true,"schema":{"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","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Cardholder details","required":true,"content":{"application/json":{"examples":{"from_person":{"title":"from_person","summary":"Business customer: from an existing person","value":{"person_id":"33KqV8cN2pLmR5tW7xYzA1bC3dE","phone":"+15555550123","external_id":"emp-0042"}},"new_person":{"title":"new_person","summary":"Business customer: a new person","value":{"first_name":"Ada","last_name":"Lovelace","email":"ada@example.com","phone":"+15555550123","external_id":"emp-0042"}},"individual_customer":{"title":"individual_customer","summary":"Individual customer: the customer themself","value":{"phone":"+15555550123"}}},"schema":{"oneOf":[{"type":"object","title":"Create Cardholder For Individual Customer Request","description":"Creates a cardholder for an INDIVIDUAL customer. Name is not supplied here -- it is taken from the individual on the customer's latest approved onboarding application. `email` follows the same on-file rule as `CreateCardholderFromPersonRequest`: required only when the person has none on file, and otherwise rejected if it disagrees with the one already there. `phone` is optional when a phone number is on file for the individual, and required (a 400 on `phone`) when none is.","properties":{"phone":{"type":"string","description":"Optional when a phone number is on file for the individual: the one on file is used when this is omitted, and a phone sent here is used instead. Required when none is on file. The cardholder's own mobile number, E.164-formatted (a `+1` number must be a North American number that can exist: 10 digits after the `+1`, with an area code and exchange that do not start with 0 or 1). It is used to verify\nthe cardholder at online checkouts that ask for 3-D Secure, so do not send\na shared or placeholder number.\n","example":"+15555550123","x-go-type-skip-optional-pointer":true,"uniqueKey":"oneOf.0.phone","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"description":"Required only when the individual has no email on file. Otherwise omit it; sending a different email than the one already on file is rejected.","example":"ada@example.com","uniqueKey":"oneOf.0.email","typeLabel":"string\u003cemail>"},"external_id":{"oneOf":[{"type":"string","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.external_id","typeLabel":"string | null"},"address":{"type":"object","title":"Address","description":"Optional override for the cardholder's residential address. When omitted, the customer's stored address is used for the country check and for provisioning: the business's address for a business customer, and the individual's onboarding address for an individual customer.\nAn address sent here must be one the card issuer accepts, or the request is refused with a 400 naming the field (`errors[].code` is `cardholder_address_invalid`) and nothing is created: every address needs `street1` and `city`; a US address (`country` of `US`) also needs `region`, a two-letter US state or territory code such as `CA`, and `postal_code`, five digits or ZIP+4 such as `12345-1234`; an address in the Cayman Islands (`KY`) or the British Virgin Islands (`VG`) needs a `postal_code` in that country's format (`KY1-1234`, `VG1110`).","required":["street1","city","country"],"properties":{"street1":{"type":"string","description":"Primary street address line","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.0.address.street1","typeLabel":"string"},"city":{"type":"string","description":"City or locality name","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.0.address.city","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (two-letter country code)","example":"US","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"oneOf.0.address.country","typeLabel":"string"},"street2":{"type":"string","description":"Secondary address information such as apartment, suite, or unit number","example":"Apt 4B","uniqueKey":"oneOf.0.address.street2","typeLabel":"string"},"street3":{"type":"string","description":"Additional address information like building name or floor","example":"Building C","uniqueKey":"oneOf.0.address.street3","typeLabel":"string"},"region":{"type":"string","description":"State, province or region. Send the subdivision part of its ISO 3166-2 code, the\ncharacters after the country prefix, rather than the full name: for example `CA` for\nCalifornia (`US-CA`) or `ON` for Ontario (`CA-ON`).\n\nThe onboarding endpoints (business details and individuals on an application) require a\nregion for a US address and accept only a two-letter US state or territory code there,\nrejecting a full name such as `California`.\n","example":"CA","uniqueKey":"oneOf.0.address.region","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal or ZIP code","example":"94105","uniqueKey":"oneOf.0.address.postal_code","typeLabel":"string"}},"uniqueKey":"oneOf.0.address","typeLabel":"Address · object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"Create Cardholder For Individual Customer Request · object"},{"type":"object","title":"Create Cardholder From Person Request","description":"Creates a cardholder for a BUSINESS customer from an existing person -- one returned by `GET /customers/{customer_id}/persons`. Name comes from that person; `email` here is only used when the person has no email on file, and is otherwise rejected if it disagrees with the one already there. Shared email addresses between persons are not supported. `phone` is optional when the person has a phone number on file, and required (a 400 on `phone`) when they have none.","required":["person_id"],"properties":{"person_id":{"type":"string","description":"A person's `id` from `GET /customers/{customer_id}/persons`, on the customer's latest approved application.","isRequired":true,"uniqueKey":"oneOf.1.person_id","typeLabel":"string"},"phone":{"type":"string","description":"Optional when the person has a phone number on file (see `phone_number` on `GET /customers/{customer_id}/persons`): the one on file is used when this is omitted, and a phone sent here is used instead. Required when none is on file. The cardholder's own mobile number, E.164-formatted (a `+1` number must be a North American number that can exist: 10 digits after the `+1`, with an area code and exchange that do not start with 0 or 1). It is used to verify\nthe cardholder at online checkouts that ask for 3-D Secure, so do not send\na shared or placeholder number.\n","example":"+15555550123","x-go-type-skip-optional-pointer":true,"uniqueKey":"oneOf.1.phone","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Required only when the person has no email on file (see `missing_for_cards` on `GET /customers/{customer_id}/persons`). Otherwise omit it; sending a different email than the one already on file is rejected.","example":"ada@example.com","uniqueKey":"oneOf.1.email","typeLabel":"string\u003cemail>"},"external_id":{"oneOf":[{"type":"string","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.1.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.1.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.external_id","typeLabel":"string | null"},"address":{"type":"object","title":"Address","description":"Optional override for the cardholder's residential address. When omitted, the customer's stored address is used for the country check and for provisioning: the business's address for a business customer, and the individual's onboarding address for an individual customer.\nAn address sent here must be one the card issuer accepts, or the request is refused with a 400 naming the field (`errors[].code` is `cardholder_address_invalid`) and nothing is created: every address needs `street1` and `city`; a US address (`country` of `US`) also needs `region`, a two-letter US state or territory code such as `CA`, and `postal_code`, five digits or ZIP+4 such as `12345-1234`; an address in the Cayman Islands (`KY`) or the British Virgin Islands (`VG`) needs a `postal_code` in that country's format (`KY1-1234`, `VG1110`).","required":["street1","city","country"],"properties":{"street1":{"type":"string","description":"Primary street address line","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.1.address.street1","typeLabel":"string"},"city":{"type":"string","description":"City or locality name","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.1.address.city","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (two-letter country code)","example":"US","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"oneOf.1.address.country","typeLabel":"string"},"street2":{"type":"string","description":"Secondary address information such as apartment, suite, or unit number","example":"Apt 4B","uniqueKey":"oneOf.1.address.street2","typeLabel":"string"},"street3":{"type":"string","description":"Additional address information like building name or floor","example":"Building C","uniqueKey":"oneOf.1.address.street3","typeLabel":"string"},"region":{"type":"string","description":"State, province or region. Send the subdivision part of its ISO 3166-2 code, the\ncharacters after the country prefix, rather than the full name: for example `CA` for\nCalifornia (`US-CA`) or `ON` for Ontario (`CA-ON`).\n\nThe onboarding endpoints (business details and individuals on an application) require a\nregion for a US address and accept only a two-letter US state or territory code there,\nrejecting a full name such as `California`.\n","example":"CA","uniqueKey":"oneOf.1.address.region","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal or ZIP code","example":"94105","uniqueKey":"oneOf.1.address.postal_code","typeLabel":"string"}},"uniqueKey":"oneOf.1.address","typeLabel":"Address · object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"Create Cardholder From Person Request · object"},{"type":"object","title":"Create Cardholder For New Person Request","description":"Creates a cardholder for a BUSINESS customer from contact details supplied directly, with no existing person to reference. Shared email addresses between persons are not supported: an `email` matching a person already on the customer's latest approved application is refused with `#cardholder-person-exists` rather than creating a second person under the same address.","required":["first_name","last_name","email","phone"],"properties":{"first_name":{"type":"string","description":"Cardholder's first name.","example":"Ada","isRequired":true,"uniqueKey":"oneOf.2.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Cardholder's last name.","example":"Lovelace","isRequired":true,"uniqueKey":"oneOf.2.last_name","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":254,"description":"The cardholder's own email address.","example":"ada@example.com","isRequired":true,"uniqueKey":"oneOf.2.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","description":"The cardholder's own mobile number, E.164-formatted (a `+1` number must be a North American number that can exist: 10 digits after the `+1`, with an area code and exchange that do not start with 0 or 1). It is used to verify\nthe cardholder at online checkouts that ask for 3-D Secure, so do not send\na shared or placeholder number.\n","example":"+15555550123","isRequired":true,"uniqueKey":"oneOf.2.phone","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.2.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional client-supplied lookup key.","uniqueKey":"oneOf.2.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.external_id","typeLabel":"string | null"},"address":{"type":"object","title":"Address","description":"Optional override for the cardholder's residential address. When omitted, the customer's stored address is used for the country check and for provisioning: the business's address for a business customer, and the individual's onboarding address for an individual customer.\nAn address sent here must be one the card issuer accepts, or the request is refused with a 400 naming the field (`errors[].code` is `cardholder_address_invalid`) and nothing is created: every address needs `street1` and `city`; a US address (`country` of `US`) also needs `region`, a two-letter US state or territory code such as `CA`, and `postal_code`, five digits or ZIP+4 such as `12345-1234`; an address in the Cayman Islands (`KY`) or the British Virgin Islands (`VG`) needs a `postal_code` in that country's format (`KY1-1234`, `VG1110`).","required":["street1","city","country"],"properties":{"street1":{"type":"string","description":"Primary street address line","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.2.address.street1","typeLabel":"string"},"city":{"type":"string","description":"City or locality name","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.2.address.city","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (two-letter country code)","example":"US","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"oneOf.2.address.country","typeLabel":"string"},"street2":{"type":"string","description":"Secondary address information such as apartment, suite, or unit number","example":"Apt 4B","uniqueKey":"oneOf.2.address.street2","typeLabel":"string"},"street3":{"type":"string","description":"Additional address information like building name or floor","example":"Building C","uniqueKey":"oneOf.2.address.street3","typeLabel":"string"},"region":{"type":"string","description":"State, province or region. Send the subdivision part of its ISO 3166-2 code, the\ncharacters after the country prefix, rather than the full name: for example `CA` for\nCalifornia (`US-CA`) or `ON` for Ontario (`CA-ON`).\n\nThe onboarding endpoints (business details and individuals on an application) require a\nregion for a US address and accept only a two-letter US state or territory code there,\nrejecting a full name such as `California`.\n","example":"CA","uniqueKey":"oneOf.2.address.region","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal or ZIP code","example":"94105","uniqueKey":"oneOf.2.address.postal_code","typeLabel":"string"}},"uniqueKey":"oneOf.2.address","typeLabel":"Address · object"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"Create Cardholder For New Person Request · object"}],"uniqueKey":"","typeLabel":"Create Cardholder For Individual Customer Request · object | Create Cardholder From Person Request · object | Create Cardholder For New Person Request · object"},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c4d56980-8f8b-4e54-bc89-8076fb69a43b":{"description":"Cardholder created successfully","content":{"application/json":{"example":{"id":"31TgvufZK3gDXBcA3BnSeLWiSn7","customer_id":"2tQRvD3xFcJ7bKpW9qNsT4hZmYr","first_name":"Ada","last_name":"Lovelace","email":"ada@example.com","phone":"+15555550123","status":"pending","open_requirements":{"count":0,"types":[]},"external_id":"emp-0042","created_at":1758211200,"updated_at":1758211200},"schema":{"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":{"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","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"customer_id":{"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","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"first_name":{"type":"string","isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","isRequired":true,"uniqueKey":"last_name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","isRequired":true,"uniqueKey":"phone","typeLabel":"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.\n\nAn 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`.\n\n`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","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","description":"Unix timestamp (seconds) of creation.","isRequired":true,"uniqueKey":"created_at","typeLabel":"integer"},"updated_at":{"type":"integer","description":"Unix timestamp (seconds) of last update.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"integer"},"open_requirements":{"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`.\n\nThis 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,"isRequired":true,"uniqueKey":"open_requirements.count","typeLabel":"integer"},"types":{"type":"array","description":"The distinct kinds of information still outstanding, deduplicated. Satisfied requirements do not contribute a type.","items":{"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","uniqueKey":"open_requirements.types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":[],"isRequired":true,"uniqueKey":"open_requirements.types","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"open_requirements","typeLabel":"Cardholder Open Requirements · object"},"external_id":{"oneOf":[{"type":"string","uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"Cardholder Response · object"},"examples":{"Example":{"title":"Example","value":{"id":"31TgvufZK3gDXBcA3BnSeLWiSn7","customer_id":"2tQRvD3xFcJ7bKpW9qNsT4hZmYr","first_name":"Ada","last_name":"Lovelace","email":"ada@example.com","phone":"+15555550123","status":"pending","open_requirements":{"count":0,"types":[]},"external_id":"emp-0042","created_at":1758211200,"updated_at":1758211200}}},"exampleType":"examples"}},"exampleType":"examples"},"bfe5b911-bb68-4ed3-a25b-2ffb8683b31c":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"7a17c844-c31a-4141-b1ad-3b7638ff72fc":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"05c81ada-0986-4b01-9624-ac271f3e2fd9":{"description":"Forbidden — the cards capability is not available for this customer. The `type` is\n`#cards-capability-unavailable` in the general case (not in rollout with the card terms\nnot yet accepted, or more than the card terms outstanding), `#cards-capability-enabling`\nwhen the customer has completed what cards require but cards are not enabled for it yet,\nor the more specific `#cards-tos-not-accepted` when the sole\nunmet requirement is a required card terms `terms_acceptance`. Its `field` is the\ncard terms key the customer owes: `cards_tos` (commercial, for a business) or\n`cards_consumer_tos` (consumer, for an individual).\nWhen the capability check finds outstanding requirements, they ride in `errors`.\n`#cards-capability-enabling` means the customer has completed what cards require, and Dakota\nenables cards for it once Dakota's own setup and rollout for this customer are done. No client\nor customer action is needed: retry later, once the `customer.capability_status.updated`\nwebhook reports cards available, rather than polling. Dakota support can say when that will be.\nWhen the client is not activated for cards,\n`#cards-capability-unavailable` carries `errors` with the field `client_not_activated` and the\ncode `capability_enablement`: only Dakota can activate cards, so contact Dakota rather than\nshowing the customer a step.\nA `#cards-capability-unavailable` because the customer's bank record is not active\ncarries no `errors`: it usually clears once the customer's bank onboarding completes,\nand if it persists, contact Dakota support.\nA `#cards-capability-unavailable` because the customer's card account needs Dakota support\nalso carries no `errors`: contact Dakota support; retrying does not help until then.\nA `#cards-capability-unavailable` because cards are not offered in the customer's country\ncarries `errors` with the field `country_not_supported` and the code `capability_enablement`;\nnothing the customer does on cards changes it. When the address sent with the request is in\nsuch a country instead, `errors` carries the field `address.country` and the code\n`COUNTRY_NOT_SUPPORTED`, and sending an address in a supported country resolves it.\n`#cardholder-base-not-enabled` means the client is not activated to issue cards to this\ncustomer's type (business or individual); contact Dakota.\n`#account-under-review` means the customer is frozen, so no cardholder can be added\nuntil the review is resolved; the customer's existing cards are held meanwhile.\n","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.dakota.xyz/api-reference/errors#cards-capability-unavailable","title":"Cards Capability Unavailable","status":403,"detail":"The cards capability is not available for this customer.","errors":[{"field":"cards_tos","message":"Cards Terms of Service must be accepted before creating a cardholder.","code":"terms_acceptance"}]},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.dakota.xyz/api-reference/errors#cards-capability-unavailable","title":"Cards Capability Unavailable","status":403,"detail":"The cards capability is not available for this customer.","errors":[{"field":"cards_tos","message":"Cards Terms of Service must be accepted before creating a cardholder.","code":"terms_acceptance"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"19a7554a-3784-4817-bb18-add72e53ab8b":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"04dbd1c0-9e24-472b-bd87-80c51a0a5b84":{"description":"Conflict. `type` distinguishes the cause:\n\n- `#cardholder-person-exists` — an email supplied in the request (a new-person request's\n `email`, or one supplied for a person with none on file) matches a person already on the\n customer's latest approved application. `person_id` names the match; a BUSINESS customer\n retries as a `CreateCardholderFromPersonRequest` with that id (an INDIVIDUAL customer's\n cardholder is the customer themself, so the email must change). The same type without\n `person_id` means the bank reports that another person of this customer already uses the\n email; use a different email, or create the cardholder from that person if the persons\n list shows them. Two persons who share one email address are not supported.\n- `#cardholder-already-exists` — a cardholder of this customer blocks this one: the\n resolved person's live cardholder, a live cardholder that already uses this email, or an\n INDIVIDUAL customer's cardholder (an individual customer can hold one cardholder that is\n not deleted, whatever its status). `cardholder_id` names it when Dakota has it on record.\n- `#cardholder-person-unavailable` — there is no usable record to source the cardholder\n from, and changing the request cannot fix it: an INDIVIDUAL customer has no approved\n application, no individual on it, or the individual's record is missing a name; or the\n bank has no usable record for the named person (contact Dakota support).\n- `#conflict` — a replay of an already-processed request (same idempotency key) whose body\n no longer agrees with the cardholder already created for it.\n","content":{"application/problem+json":{"schema":{"type":"object","title":"Create Cardholder Conflict Problem","description":"The 409 response of `createCardholder`. Carries ProblemDetails plus, depending on `type`, one of two RFC 9457 extension members naming the specific conflict -- scoped here rather than added to the shared ProblemDetails schema, since no other operation returns them.","required":["type","title","status"],"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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"},"person_id":{"type":"string","description":"Only on `#cardholder-person-exists`, and only when the match is a person on the customer's latest approved application: the id of the person whose email the request's `email` matched. A business customer retries the create as a `CreateCardholderFromPersonRequest` naming this id. Absent when the bank reports that another person uses the email.","example":"2abc123","uniqueKey":"person_id","typeLabel":"string"},"cardholder_id":{"type":"string","description":"Only on `#cardholder-already-exists`: the id of the cardholder of this customer that blocks this one.","example":"2xyz789","uniqueKey":"cardholder_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"Create Cardholder Conflict Problem · object"},"example":{"type":"https://docs.dakota.xyz/api-reference/errors#cardholder-person-exists","title":"Cardholder Person Exists","status":409,"detail":"A person with this email already exists on this application. Send person_id 2abc123 instead.","person_id":"2abc123"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.dakota.xyz/api-reference/errors#cardholder-person-exists","title":"Cardholder Person Exists","status":409,"detail":"A person with this email already exists on this application. Send person_id 2abc123 instead.","person_id":"2abc123"}}},"exampleType":"examples"}},"exampleType":"examples"},"2a45be14-1d72-4501-99e8-f9f0f0ffb1ca":{"description":"Unprocessable — the `X-Idempotency-Key` was already used on this endpoint with a different request body\n(problem type `idempotency-key-reused`). The request was not executed and the original response was not replayed.\nResend the original body to receive the original response, or use a new key to make a new request.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"c239fc34-a768-425f-a86c-59103bb3034a":{"description":"Not yet implemented","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"5f744c7b-273f-4f0c-928a-ad4e057b57d0":{"description":"Card provider unavailable","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"722d09de-47d9-4f38-bd24-61f97da285b3":{"description":"Cards is not available in this environment","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status"],"description":"Error response following RFC 9457 Problem Details.\nPublic API error responses use this format.\n","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.\nResolves to human-readable documentation.\n","example":"https://docs.dakota.xyz/api-reference/errors#not-found","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the problem type. Stable across occurrences.","example":"Customer Not Found","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code for this occurrence.","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence.","example":"Customer cst_2abc123 was not found in your organization.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"The request path that triggered this error.","example":"https://api.platform.dakota.xyz/customers/cst_2abc123","uniqueKey":"instance","typeLabel":"string\u003curi>"},"request_id":{"type":"string","description":"Unique request identifier. Include when contacting support.","example":"req_7f3a8b2c","uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present for validation failures).","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields.","example":"bank_account.routing_number","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the field error.","example":"Routing number must be exactly 9 digits","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code for this field.","example":"invalid_format","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"resolution_url":{"type":"string","format":"uri","description":"A link the customer can follow to CLEAR this error, present only on\nproblems with a concrete self-service remedy.\n\nToday this is returned by\n`#terms-not-accepted`, where it points at the hosted flow in which\nthe outstanding agreement can be signed. The link is token-gated and\nusable as-is — send the customer to it directly rather than parsing\nit out of `detail`.\n","example":"https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c","uniqueKey":"resolution_url","typeLabel":"string\u003curi>"},"user_message":{"type":"string","description":"A plain-language rendition of `detail` written for the end\ncustomer, present when one exists for this error. `detail` names\nrequest fields and actions so a machine caller (such as a payment\nagent drafting proposals) can self-correct; `user_message` says the\nsame thing without API vocabulary. Clients that relay errors into a\nhuman surface (chat, email, UI) should show `user_message` when\npresent and fall back to `detail`.\n","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.","uniqueKey":"user_message","typeLabel":"string"},"reason":{"type":"string","description":"A stable, machine-readable code for why the request was refused,\npresent only when Dakota has a typed reason for this error. Branch\non `reason` rather than parsing `detail`.\n\nWhen `reason` is a value from the table below other than\n`signature_required` and `immutable_field`, `detail` is text Dakota\nwrites for that reason, never a partner's or a bank's wording. For\nthose two, `detail` is the text written for that specific refusal.\nIn every case the wording can change, so do not parse it.\n\nThis is an open set: new values are added over time and a value is\nnever repurposed, so treat an unrecognized `reason` as absent.\n\nWhich operations return it today:\n\n- `createAccount` (onramp, offramp and swap) and `createTransaction`\n (a one-off transaction creates an account): every value in the\n table except `immutable_field`; `signature_required` comes from\n `createTransaction` only.\n- `updateAccount`: `field_invalid` (a developer fee that is out of\n range), `resource_not_found`, and `immutable_field` (the change\n would alter the account's routing; create a new account instead).\n- `deleteAccount`: `resource_not_found`.\n- `createWalletTransaction` and `signWalletTypedData`:\n `check_unavailable` (503) when the address screen could not run.\n- `deletePolicy`: `policy_attached` (409, under governance\n enforcement) when a wallet still holds the policy.\n- Every operation authenticated with an API key:\n `api_key_expired` (401) and `ip_not_allowed` (403).\n- `createInstructions`: a payment-agent instruction that creates an\n account fails with the same `reason` values as `createAccount`,\n but `params.field` is never returned there: the response carries\n the other `params` keys only, because this operation has no\n public field names to map to.\n- Other operations may also set `reason`. Treat a `reason` you do\n not recognize as absent, as above, and never assume an operation\n that is not listed here omits it.\n\n| `reason` | Meaning | `params` |\n| --- | --- | --- |\n| `field_required` | A required request field is missing. | `field` |\n| `field_invalid` | A field is present but unusable. | `field`, `constraint`, `rail` |\n| `field_too_long` | A field is longer than the rail allows. | `field`, `max`, `actual`, `rail` |\n| `field_too_short` | A field is shorter than the rail allows. | `field`, `min`, `actual` |\n| `address_incomplete` | An address lacks parts the route needs. | `subject`, `fields` |\n| `unsupported_network` | The network is not supported. | `network` |\n| `unsupported_asset` | The asset does not exist on the network. | `asset`, `network` |\n| `no_route_available` | No payment route covers the request. | `direction`, `rail`, `currency`, `network` |\n| `onboarding_required` | The customer has not completed onboarding for a capability. | `capability` |\n| `entity_not_active` | Onboarding for a capability exists but is not yet usable. | `capability`, `status` |\n| `destination_unreachable` | The destination cannot be reached over the requested rail. | `rail`, `alternative`, `direction` |\n| `limit_exceeded` | An amount exceeds a ceiling. | `limit`, `max`, `configured`, `currency` |\n| `resource_not_found` | The named resource does not exist. | `resource` |\n| `duplicate_resource` | A matching resource already exists. | `resource` |\n| `request_rejected` | The request was refused and the reason is not disclosed. | none |\n| `signature_required` | The request must be signed. | none |\n| `immutable_field` | The field cannot be changed on an existing account; create a new one. | none |\n| `endorsement_required` | The signer-group change needs signatures from the group's governing members. Also returned, under governance enforcement, when an API key creates an x402 spend mandate. Also returned, under governance enforcement, when an `operate` API key sets an account's refund wallet (`return_address` or `return_crypto_address`) to an address that is not one of the customer's saved crypto destinations on the same network: save it as a crypto destination first. | none |\n| `insufficient_endorsements` | The signatures do not meet the signer group's governance quorum (403). When `params` are present, the group `signer_group_id` got `have` of the `need` distinct governing members it requires. When they are absent, no count is reported; usually no signature was counted at all, because one did not verify over the request's intent with the key of a member of a group allowed to endorse it, came from a payment-agent or card-settlement key, or repeated a signer. | `signer_group_id`, `have`, `need` (all or none) |\n| `webauthn_wrong_type` | A passkey signature was not an assertion: its `clientDataJSON.type` is not `webauthn.get` (for example, the output of a registration). Sign again with `navigator.credentials.get` (400 `validation_error`). | none |\n| `webauthn_user_not_present` | A passkey assertion lacks the user-present (UP) flag, so nobody confirmed it on the authenticator (400 `validation_error`). | none |\n| `webauthn_user_not_verified` | A passkey assertion lacks the user-verified (UV) flag. Refused only where Dakota enforces user verification (400 `validation_error`). | none |\n| `webauthn_rp_mismatch` | A passkey is bound to a relying party ID that is not allowed. Refused only where Dakota enforces the RP ID check (400 `validation_error`). | none |\n| `webauthn_origin_mismatch` | A passkey assertion was made on an origin that is not allowed. Refused only where Dakota enforces the origin check (400 `validation_error`). | none |\n| `stale_signer_group_version` | The signer group changed since the signatures were made; read its `version` and sign again. | none |\n| `below_threshold` | The removal would leave the signer group below a threshold it must keep. | none |\n| `invalid_governing_group` | The governing signer group is missing or no longer valid. | none |\n| `check_unavailable` | A required safety check could not run, so nothing was sent; retry later with the same idempotency key. | none |\n| `api_key_expired` | The API key is past its `expires_at` (401). Use a current key. | none |\n| `ip_not_allowed` | The request came from an address outside the API key's `allowed_cidrs` (403). | none |\n| `session_required` | Only a person's own signed-in session may do this; an API key cannot. Nothing was changed. | none |\n| `unmeetable_signer_groups` | Governance enforcement cannot be turned on while the listed signer groups could never be governed under it. Nothing was changed. | none |\n| `policy_attached` | Under governance enforcement, a policy still attached to a wallet cannot be deleted (409). Nothing was changed. Detach it from each wallet first. `wallet_ids` lists up to 20 of the wallets, comma-separated; `wallet_count` is the total. | `wallet_ids`, `wallet_count` |\n","example":"field_too_long","uniqueKey":"reason","typeLabel":"string"},"code":{"type":"string","description":"A stable snake_case error code for the signer-group governance\nrefusals, equal to `reason` for them: `endorsement_required`,\n`insufficient_endorsements`, `stale_signer_group_version`,\n`below_threshold`, `invalid_governing_group` and `policy_attached`,\nand the passkey refusals of a signed request (`webauthn_wrong_type`,\n`webauthn_user_not_present`, `webauthn_user_not_verified`,\n`webauthn_rp_mismatch` and `webauthn_origin_mismatch`, on a 400\n`validation_error`). Absent for every other problem.\n","example":"insufficient_endorsements","uniqueKey":"code","typeLabel":"string"},"params":{"type":"object","description":"Parameters of `reason`. Every value is a string: a number, a\ntoken from a closed set, or the public name of a request field\n(`field` is expressed in this operation's request body, and is\nomitted when the offending value has no public name). Never free\ntext. Present only alongside `reason`, and only when the reason\nhas parameters.\n","additionalProperties":{"type":"string","uniqueKey":"params.additionalProperties","typeLabel":"string"},"example":{"field":"payment_reference","max":"35","actual":"40","rail":"swift"},"uniqueKey":"params","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9d0155ab-0186-4033-97ea-b2479ae0da6f":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"a9b7f703-4a74-42e1-bdf3-fc2ee843fff5":{"url":"https://api.platform.sandbox.dakota.xyz","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"dakota-49818541","siteName":"Dakota","title":"Create a cardholder - Dakota","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T17:01:07.400Z","originalFileLocation":"api-reference/cards/create-a-cardholder.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a cardholder for the given customer, gated on the cards capability being available. The cardholder is created synchronously and returns in pending status, then transitions to active via a cardholder.updated webhook. The request body is one of three shapes, chosen by which fields are present: - CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on file; optional email): for an INDIVIDUAL customer. Name is taken from the individual on the customer\u0026#x27;s latest approved application; email too, unless the individual has none on file, in which case the request email is required. - CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on file; optional email): for a BUSINESS customer, creates a cardholder from an existing person returned by GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the person has none on file, in which case the request email is required. - CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a BUSINESS customer, creates a cardholder from contact details supplied directly, without an existing person to reference. An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the second or third; sending person_id together with first_name/last_name is ambiguous and refused. Shared email addresses between persons are not supported: whenever a shape takes its email from the request (a new-person request\u0026#x27;s email, or one supplied for a person with none on file), an email matching a person already on the application is refused with #cardholder-person-exists rather than silently creating a second person under the same address. person_id is validated the same way whether it fails to parse into any application person or the customer has no approved application at all: both are the same 400 field violation on person_id, so a caller can never use the response to probe for another customer\u0026#x27;s application or persons.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dakota\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a cardholder - Dakota\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a cardholder for the given customer, gated on the cards capability being available. The cardholder is created synchronously and returns in pending status, then transitions to active via a cardholder.updated webhook. The request body is one of three shapes, chosen by which fields are present: - CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on file; optional email): for an INDIVIDUAL customer. Name is taken from the individual on the customer\u0026#x27;s latest approved application; email too, unless the individual has none on file, in which case the request email is required. - CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on file; optional email): for a BUSINESS customer, creates a cardholder from an existing person returned by GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the person has none on file, in which case the request email is required. - CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a BUSINESS customer, creates a cardholder from contact details supplied directly, without an existing person to reference. An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the second or third; sending person_id together with first_name/last_name is ambiguous and refused. Shared email addresses between persons are not supported: whenever a shape takes its email from the request (a new-person request\u0026#x27;s email, or one supplied for a person with none on file), an email matching a person already on the application is refused with #cardholder-person-exists rather than silently creating a second person under the same address. person_id is validated the same way whether it fails to parse into any application person or the customer has no approved application at all: both are the same 400 field violation on person_id, so a caller can never use the response to probe for another customer\u0026#x27;s application or persons.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dakota\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dakota-49818541.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Create+a+cardholder\u0026amp;description=Create+a+cardholder+for+the+given+customer%2C+gated+on+the+cards+capability+being+available.%0AThe+cardholder+is+created+synchronously+and+returns+in+%60pending%60+stat\u0026amp;theme=b4f99b33160b9781c71dd798\u0026amp;signature=e8f37c94d192bd5d35c203e1ff5b80824b57669456a81ab0d7bec749b8b76c63\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a cardholder - Dakota\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a cardholder for the given customer, gated on the cards capability being available. The cardholder is created synchronously and returns in pending status, then transitions to active via a cardholder.updated webhook. The request body is one of three shapes, chosen by which fields are present: - CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on file; optional email): for an INDIVIDUAL customer. Name is taken from the individual on the customer\u0026#x27;s latest approved application; email too, unless the individual has none on file, in which case the request email is required. - CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on file; optional email): for a BUSINESS customer, creates a cardholder from an existing person returned by GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the person has none on file, in which case the request email is required. - CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a BUSINESS customer, creates a cardholder from contact details supplied directly, without an existing person to reference. An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the second or third; sending person_id together with first_name/last_name is ambiguous and refused. Shared email addresses between persons are not supported: whenever a shape takes its email from the request (a new-person request\u0026#x27;s email, or one supplied for a person with none on file), an email matching a person already on the application is refused with #cardholder-person-exists rather than silently creating a second person under the same address. person_id is validated the same way whether it fails to parse into any application person or the customer has no approved application at all: both are the same 400 field violation on person_id, so a caller can never use the response to probe for another customer\u0026#x27;s application or persons.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dakota-49818541.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Create+a+cardholder\u0026amp;description=Create+a+cardholder+for+the+given+customer%2C+gated+on+the+cards+capability+being+available.%0AThe+cardholder+is+created+synchronously+and+returns+in+%60pending%60+stat\u0026amp;theme=b4f99b33160b9781c71dd798\u0026amp;signature=e8f37c94d192bd5d35c203e1ff5b80824b57669456a81ab0d7bec749b8b76c63\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dakota-49818541/PW4ddHpkUE3rJR0e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dakota\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8e4410\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cards/create-a-cardholder.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dakota.xyz/#organization\",\"name\":\"Dakota\",\"url\":\"https://docs.dakota.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dakota-49818541/-tkRmX-DtPxqfDgt/images/dakota-logo-black.png?fit=max\u0026auto=format\u0026n=-tkRmX-DtPxqfDgt\u0026q=85\u0026s=c409f7b8cec2e984bd0c79735f637bfe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dakota.xyz#website\",\"name\":\"Dakota\",\"url\":\"https://docs.dakota.xyz\",\"publisher\":{\"@id\":\"https://docs.dakota.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder#webpage\",\"url\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder\",\"name\":\"Create a cardholder\",\"description\":\"Create a cardholder for the given customer, gated on the cards capability being available. The cardholder is created synchronously and returns in pending status, then transitions to active via a cardholder.updated webhook. The request body is one of three shapes, chosen by which fields are present: - CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on file; optional email): for an INDIVIDUAL customer. Name is taken from the individual on the customer's latest approved application; email too, unless the individual has none on file, in which case the request email is required. - CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on file; optional email): for a BUSINESS customer, creates a cardholder from an existing person returned by GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the person has none on file, in which case the request email is required. - CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a BUSINESS customer, creates a cardholder from contact details supplied directly, without an existing person to reference. An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the second or third; sending person_id together with first_name/last_name is ambiguous and refused. Shared email addresses between persons are not supported: whenever a shape takes its email from the request (a new-person request's email, or one supplied for a person with none on file), an email matching a person already on the application is refused with #cardholder-person-exists rather than silently creating a second person under the same address. person_id is validated the same way whether it fails to parse into any application person or the customer has no approved application at all: both are the same 400 field violation on person_id, so a caller can never use the response to probe for another customer's application or persons.\",\"dateModified\":\"2026-11-19T17:01:07.400Z\",\"isPartOf\":{\"@id\":\"https://docs.dakota.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cards\",\"item\":\"https://docs.dakota.xyz/api-reference/cards/report-a-card-dispute-and-optionally-file-it\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a cardholder\",\"item\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder#apireference\",\"headline\":\"Create a cardholder\",\"name\":\"Create a cardholder\",\"description\":\"Create a cardholder for the given customer, gated on the cards capability being available. The cardholder is created synchronously and returns in pending status, then transitions to active via a cardholder.updated webhook. The request body is one of three shapes, chosen by which fields are present: - CreateCardholderForIndividualCustomerRequest (optional phone, required when none is on file; optional email): for an INDIVIDUAL customer. Name is taken from the individual on the customer's latest approved application; email too, unless the individual has none on file, in which case the request email is required. - CreateCardholderFromPersonRequest (person_id; optional phone, required when none is on file; optional email): for a BUSINESS customer, creates a cardholder from an existing person returned by GET /customers/{customer_id}/persons. Name comes from that person; email too, unless the person has none on file, in which case the request email is required. - CreateCardholderForNewPersonRequest (first_name, last_name, email, phone): for a BUSINESS customer, creates a cardholder from contact details supplied directly, without an existing person to reference. An INDIVIDUAL customer only accepts the first shape; a BUSINESS customer only accepts the second or third; sending person_id together with first_name/last_name is ambiguous and refused. Shared email addresses between persons are not supported: whenever a shape takes its email from the request (a new-person request's email, or one supplied for a person with none on file), an email matching a person already on the application is refused with #cardholder-person-exists rather than silently creating a second person under the same address. person_id is validated the same way whether it fails to parse into any application person or the customer has no approved application at all: both are the same 400 field violation on person_id, so a caller can never use the response to probe for another customer's application or persons.\",\"url\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dakota.xyz/api-reference/cards/create-a-cardholder#webpage\"},\"dateModified\":\"2026-11-19T17:01:07.400Z\",\"publisher\":{\"@id\":\"https://docs.dakota.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dakota.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dakota\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dakota\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cards/create-a-cardholder.md","siteName":"Dakota","nav":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"https://support.dakota.xyz"},{"anchor":"Contact us","icon":"envelope","href":"https://dakota.xyz/talk-to-sales"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/try-it-now"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"Errors","href":"/api-reference/errors"},{"title":"State Lifecycles","href":"/api-reference/state-lifecycles"}]},{"group":"Customers","pages":[{"title":"List all customer records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers","href":"/api-reference/customers/list-all-customer-records"},{"title":"Create a customer record","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer-record"},{"title":"Update sub-client association for a customer","deprecated":true,"version":null,"openapi":"/openapi.yaml patch /customers/{customer_id}/sub-client","href":"/api-reference/customers/update-sub-client-association-for-a-customer"},{"title":"Retrieve a customer record by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}","href":"/api-reference/customers/retrieve-a-customer-record-by-id"},{"title":"Delete a customer record","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/{customer_id}","href":"/api-reference/customers/delete-a-customer-record"},{"title":"List available SWIFT FX currencies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}/fx-currencies","href":"/api-reference/customers/list-available-swift-fx-currencies"},{"title":"List a customer's capabilities and what's needed to unlock them","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}/capabilities","href":"/api-reference/customers/list-a-customers-capabilities-and-whats-needed-to-unlock-them"},{"title":"Get a customer's limits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}/limits","href":"/api-reference/customers/get-a-customers-limits"},{"title":"Get sub-client summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/sub-client-summary","href":"/api-reference/customers/get-sub-client-summary"},{"title":"Mint a fresh application link for re-engaging an approved customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customer_id}/re-engagement","href":"/api-reference/customers/mint-a-fresh-application-link-for-re-engaging-an-approved-customer"},{"title":"Withdraw a customer's onboarding application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customer_id}/applications/{application_id}/withdraw","href":"/api-reference/customers/withdraw-a-customers-onboarding-application"}]},{"group":"Wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Create a new wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /wallets","href":"/api-reference/wallets/create-a-new-wallet"},{"title":"Get a single wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /wallets/{wallet_id}","href":"/api-reference/wallets/get-a-single-wallet"},{"title":"Get policies attached to a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /wallets/{wallet_id}/policies","href":"/api-reference/wallets/get-policies-attached-to-a-wallet"},{"title":"Get wallet balances across all networks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /wallets/{wallet_id}/balances","href":"/api-reference/wallets/get-wallet-balances-across-all-networks"},{"title":"Sign typed data with a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /wallets/{wallet_id}/sign","href":"/api-reference/wallets/sign-typed-data-with-a-wallet"},{"title":"Send a transaction from a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /wallets/{wallet_id}/transactions","href":"/api-reference/wallets/send-a-transaction-from-a-wallet"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Create a one-off transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions","href":"/api-reference/transactions/create-a-one-off-transfer"},{"title":"Request a directional FX quote or estimate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fx/quotes","href":"/api-reference/transactions/request-a-directional-fx-quote-or-estimate"},{"title":"Get an owned one-off FX quote","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fx/quotes/{quote_id}","href":"/api-reference/transactions/get-an-owned-one-off-fx-quote"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions/{transaction_id}","href":"/api-reference/transactions/get-a-transaction"},{"title":"Get the request for information about a transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions/{transaction_id}/rfi","href":"/api-reference/transactions/get-the-request-for-information-about-a-transaction"},{"title":"Answer a request for information about a transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transaction_id}/rfi/response","href":"/api-reference/transactions/answer-a-request-for-information-about-a-transaction"},{"title":"Cancel a transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transaction_id}/cancellations","href":"/api-reference/transactions/cancel-a-transaction"},{"title":"Get an upload URL for a file for a request for information","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transactions/{transaction_id}/rfi/document-uploads","href":"/api-reference/transactions/get-an-upload-url-for-a-file-for-a-request-for-information"}]},{"group":"Recipients","pages":[{"title":"Get a specific recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml get /recipients/{recipient_id}","href":"/api-reference/recipients/get-a-specific-recipient"},{"title":"Update a recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml put /recipients/{recipient_id}","href":"/api-reference/recipients/update-a-recipient"},{"title":"Delete a recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /recipients/{recipient_id}","href":"/api-reference/recipients/delete-a-recipient"},{"title":"Delete a destination","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /recipients/{recipient_id}/destinations/{destination_id}","href":"/api-reference/recipients/delete-a-destination"},{"title":"Update a destination's supported currencies","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /recipients/{recipient_id}/destinations/{destination_id}","href":"/api-reference/recipients/update-a-destinations-supported-currencies"},{"title":"List a customer's recipients","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}/recipients","href":"/api-reference/recipients/list-a-customers-recipients"},{"title":"Create a new recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/{customer_id}/recipients","href":"/api-reference/recipients/create-a-new-recipient"},{"title":"List destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /recipients/{recipient_id}/destinations","href":"/api-reference/recipients/list-destinations"},{"title":"Add a destination for a recipient","deprecated":null,"version":null,"openapi":"/openapi.yaml post /recipients/{recipient_id}/destinations","href":"/api-reference/recipients/add-a-destination-for-a-recipient"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts","href":"/api-reference/accounts/create-an-account"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}","href":"/api-reference/accounts/get-an-account"},{"title":"Delete an account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{account_id}","href":"/api-reference/accounts/delete-an-account"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{account_id}","href":"/api-reference/accounts/update-an-account"}]},{"group":"Auto Transactions","pages":[{"title":"Get details of a specific auto account transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auto-transactions/{auto_transaction_id}","href":"/api-reference/auto-transactions/get-details-of-a-specific-auto-account-transaction"},{"title":"List transactions that were created automatically by auto accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /auto-transactions","href":"/api-reference/auto-transactions/list-transactions-that-were-created-automatically-by-auto-accounts"}]},{"group":"Onboarding","pages":[{"title":"Bulk import customers from Sumsub share tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/bulk-import-sumsub-tokens","href":"/api-reference/onboarding/bulk-import-customers-from-sumsub-share-tokens"},{"title":"Import customers from Persona Connect share tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers/import-persona-tokens","href":"/api-reference/onboarding/import-customers-from-persona-connect-share-tokens"},{"title":"Update associated individual","deprecated":null,"version":null,"openapi":"/openapi.yaml put /applications/{application_id}/associated-individuals/{individual_id}","href":"/api-reference/onboarding/update-associated-individual"},{"title":"Remove associated individual from business application","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /applications/{application_id}/associated-individuals/{individual_id}","href":"/api-reference/onboarding/remove-associated-individual-from-business-application"},{"title":"Update business application details","deprecated":null,"version":null,"openapi":"/openapi.yaml put /applications/{application_id}/business-details","href":"/api-reference/onboarding/update-business-application-details"},{"title":"Get EDD record for application","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}/edd","href":"/api-reference/onboarding/get-edd-record-for-application"},{"title":"Create or update EDD record","deprecated":null,"version":null,"openapi":"/openapi.yaml put /applications/{application_id}/edd","href":"/api-reference/onboarding/create-or-update-edd-record"},{"title":"Update individual application details","deprecated":null,"version":null,"openapi":"/openapi.yaml put /applications/{application_id}/individual-details","href":"/api-reference/onboarding/update-individual-application-details"},{"title":"Get an onboarding application","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}","href":"/api-reference/onboarding/get-an-onboarding-application"},{"title":"What this application still needs to accept, and who may accept it","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}/legal-acceptance","href":"/api-reference/onboarding/what-this-application-still-needs-to-accept-and-who-may-accept-it"},{"title":"Read a legal document as this application's customer is shown it","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}/legal-documents/{document_key}","href":"/api-reference/onboarding/read-a-legal-document-as-this-applications-customer-is-shown-it"},{"title":"Download a document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}/documents/{document_id}","href":"/api-reference/onboarding/download-a-document"},{"title":"Delete an onboarding document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /applications/{application_id}/documents/{document_id}","href":"/api-reference/onboarding/delete-an-onboarding-document"},{"title":"Get a Persona import job with per-token results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/persona-import-jobs/{job_id}","href":"/api-reference/onboarding/get-a-persona-import-job-with-per-token-results"},{"title":"List all onboarding applications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications","href":"/api-reference/onboarding/list-all-onboarding-applications"},{"title":"List Persona import jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/persona-import-jobs","href":"/api-reference/onboarding/list-persona-import-jobs"},{"title":"Answer a request for information","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{id}/rfi/resubmit","href":"/api-reference/onboarding/answer-a-request-for-information"},{"title":"List all documents for an application","deprecated":null,"version":null,"openapi":"/openapi.yaml get /applications/{application_id}/documents","href":"/api-reference/onboarding/list-all-documents-for-an-application"},{"title":"Upload an application document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/documents","href":"/api-reference/onboarding/upload-an-application-document"},{"title":"Submit an application for verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/submissions","href":"/api-reference/onboarding/submit-an-application-for-verification"},{"title":"Submit an attestation for an application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/attestations","href":"/api-reference/onboarding/submit-an-attestation-for-an-application"},{"title":"Create an application document upload session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/document-uploads","href":"/api-reference/onboarding/create-an-application-document-upload-session"},{"title":"Add associated individual to business application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/associated-individuals","href":"/api-reference/onboarding/add-associated-individual-to-business-application"},{"title":"Verify a document upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/documents/{document_id}/verifications","href":"/api-reference/onboarding/verify-a-document-upload"},{"title":"Upload an individual document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/associated-individuals/{individual_id}/documents","href":"/api-reference/onboarding/upload-an-individual-document"},{"title":"Get presigned URL for individual document upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /applications/{application_id}/associated-individuals/{individual_id}/document-uploads","href":"/api-reference/onboarding/get-presigned-url-for-individual-document-upload"}]},{"group":"Policies","pages":[{"title":"List all policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /policies","href":"/api-reference/policies/list-all-policies"},{"title":"Create a new policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /policies","href":"/api-reference/policies/create-a-new-policy"},{"title":"Remove a rule from a policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/remove-a-rule-from-a-policy"},{"title":"Update an existing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/update-an-existing-rule"},{"title":"Attach policy to a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml put /policies/{policy_id}/wallets/{wallet_id}","href":"/api-reference/policies/attach-policy-to-a-wallet"},{"title":"Detach policy from a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /policies/{policy_id}/wallets/{wallet_id}","href":"/api-reference/policies/detach-policy-from-a-wallet"},{"title":"Get a specific policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /policies/{policy_id}","href":"/api-reference/policies/get-a-specific-policy"},{"title":"Delete a policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /policies/{policy_id}","href":"/api-reference/policies/delete-a-policy"},{"title":"Get wallets attached to a policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /policies/{policy_id}/wallets","href":"/api-reference/policies/get-wallets-attached-to-a-policy"},{"title":"Add a new rule to a policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /policies/{policy_id}/rules","href":"/api-reference/policies/add-a-new-rule-to-a-policy"}]},{"group":"Signer Groups","pages":[{"title":"Get signer groups for the authenticated client","deprecated":null,"version":null,"openapi":"/openapi.yaml get /signer-groups","href":"/api-reference/signer-groups/get-signer-groups-for-the-authenticated-client"},{"title":"Create a new signer group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /signer-groups","href":"/api-reference/signer-groups/create-a-new-signer-group"},{"title":"Create a new signer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /signers","href":"/api-reference/signer-groups/create-a-new-signer"},{"title":"Update a signer group's governance","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /signer-groups/{signer_group_id}/governance","href":"/api-reference/signer-groups/update-a-signer-groups-governance"},{"title":"Attach a signer group to a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml put /wallets/{wallet_id}/signer-groups/{signer_group_id}","href":"/api-reference/signer-groups/attach-a-signer-group-to-a-wallet"},{"title":"Detach a signer group from a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /wallets/{wallet_id}/signer-groups/{signer_group_id}","href":"/api-reference/signer-groups/detach-a-signer-group-from-a-wallet"},{"title":"Get a signer group by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /signer-groups/{signer_group_id}","href":"/api-reference/signer-groups/get-a-signer-group-by-id"},{"title":"Get wallets attached to a signer group","deprecated":null,"version":null,"openapi":"/openapi.yaml get /signer-groups/{signer_group_id}/wallets","href":"/api-reference/signer-groups/get-wallets-attached-to-a-signer-group"},{"title":"Get signer groups attached to a wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /wallets/{wallet_id}/signer-groups","href":"/api-reference/signer-groups/get-signer-groups-attached-to-a-wallet"},{"title":"Remove a signer from a signer group","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /signer-groups/{signer_group_id}/signers/{signer_id}","href":"/api-reference/signer-groups/remove-a-signer-from-a-signer-group"},{"title":"Delete a signer by public key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /signers/{public_key}","href":"/api-reference/signer-groups/delete-a-signer-by-public-key"},{"title":"Add a signer to a signer group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /signer-groups/{signer_group_id}/signers","href":"/api-reference/signer-groups/add-a-signer-to-a-signer-group"},{"title":"Remove signers from a signer group, with signatures","deprecated":null,"version":null,"openapi":"/openapi.yaml post /signer-groups/{signer_group_id}/signer-removals","href":"/api-reference/signer-groups/remove-signers-from-a-signer-group-with-signatures"}]},{"group":"Authentication","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api-keys","href":"/api-reference/authentication/list-api-keys"},{"title":"Create a new API key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys","href":"/api-reference/authentication/create-a-new-api-key"},{"title":"Delete all API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api-keys","href":"/api-reference/authentication/delete-all-api-keys"},{"title":"Create an API key for a client (Admin only)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys/admin","href":"/api-reference/authentication/create-an-api-key-for-a-client-admin-only"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api-keys/{api_key_id}","href":"/api-reference/authentication/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api-keys/{api_key_id}","href":"/api-reference/authentication/update-an-api-key"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys/{api_key_id}/rotate","href":"/api-reference/authentication/rotate-an-api-key"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /users","href":"/api-reference/users/list-users"},{"title":"Create a new user","deprecated":null,"version":null,"openapi":"/openapi.yaml post /users","href":"/api-reference/users/create-a-new-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /users/{user_id}","href":"/api-reference/users/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /users/{user_id}","href":"/api-reference/users/update-a-user"}]},{"group":"Webhooks","pages":[{"title":"List webhook targets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/targets","href":"/api-reference/webhooks/list-webhook-targets"},{"title":"Create a webhook target","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/targets","href":"/api-reference/webhooks/create-a-webhook-target"},{"title":"Get a webhook target","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/targets/{webhook_target_id}","href":"/api-reference/webhooks/get-a-webhook-target"},{"title":"Delete a webhook target","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/targets/{webhook_target_id}","href":"/api-reference/webhooks/delete-a-webhook-target"},{"title":"Update a webhook target","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhooks/targets/{webhook_target_id}","href":"/api-reference/webhooks/update-a-webhook-target"},{"title":"Get a webhook delivery record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{event_id}","href":"/api-reference/webhooks/get-a-webhook-delivery-record"},{"title":"List webhook delivery history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhook-delivery-history"},{"title":"Replay a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/events/{event_id}/replay","href":"/api-reference/webhooks/replay-a-webhook-delivery"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events","href":"/api-reference/events/list-events"}]},{"group":"Info","pages":[{"title":"Get countries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /capabilities/countries","href":"/api-reference/info/get-countries"},{"title":"Get supported blockchain networks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /capabilities/networks","href":"/api-reference/info/get-supported-blockchain-networks"}]},{"group":"Sandbox","pages":[{"title":"Simulate an inbound payment event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/simulate/inbound","href":"/api-reference/sandbox/simulate-an-inbound-payment-event"},{"title":"Simulate an onboarding state transition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/simulate/onboarding","href":"/api-reference/sandbox/simulate-an-onboarding-state-transition"},{"title":"Simulate a card authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/simulate/transaction","href":"/api-reference/sandbox/simulate-a-card-authorization"},{"title":"Get simulation status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sandbox/simulations/{simulation_id}","href":"/api-reference/sandbox/get-simulation-status"},{"title":"List available simulation scenarios","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sandbox/scenarios","href":"/api-reference/sandbox/list-available-simulation-scenarios"},{"title":"Fund a sandbox wallet from the testnet faucet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/wallets/{wallet_id}/faucet","href":"/api-reference/sandbox/fund-a-sandbox-wallet-from-the-testnet-faucet"},{"title":"Advance a paused simulation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/simulations/{simulation_id}/advance","href":"/api-reference/sandbox/advance-a-paused-simulation"},{"title":"Advance a simulated card transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/cards/simulate/transaction/{card_transaction_id}","href":"/api-reference/sandbox/advance-a-simulated-card-transaction"},{"title":"Advance a simulated card transaction (deprecated, use POST)","deprecated":true,"version":null,"openapi":"/openapi.yaml patch /sandbox/cards/simulate/transaction/{card_transaction_id}","href":"/api-reference/sandbox/advance-a-simulated-card-transaction-deprecated-use-post"}]},{"group":"Self Serve","pages":[{"title":"Create Stripe Checkout session for credit purchase","deprecated":null,"version":null,"openapi":"/openapi.yaml post /self-serve/credits/purchase","href":"/api-reference/self-serve/create-stripe-checkout-session-for-credit-purchase"},{"title":"Get prepaid credit balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /self-serve/credits/balance","href":"/api-reference/self-serve/get-prepaid-credit-balance"},{"title":"List prepaid credit ledger entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /self-serve/credits/ledger","href":"/api-reference/self-serve/list-prepaid-credit-ledger-entries"},{"title":"List available credit purchase tiers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /self-serve/credits/tiers","href":"/api-reference/self-serve/list-available-credit-purchase-tiers"},{"title":"Get the self-serve client's pricing config (fee schedule)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /self-serve/credits/pricing","href":"/api-reference/self-serve/get-the-self-serve-clients-pricing-config-fee-schedule"}]},{"group":"Cards","pages":[{"title":"Report a card dispute, and optionally file it","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /card_dispute_reports","href":"/api-reference/cards/report-a-card-dispute-and-optionally-file-it"},{"title":"Get a cardholder","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /cardholders/{cardholder_id}","href":"/api-reference/cards/get-a-cardholder"},{"title":"Delete a cardholder","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml delete /cardholders/{cardholder_id}","href":"/api-reference/cards/delete-a-cardholder"},{"title":"Update a cardholder","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml patch /cardholders/{cardholder_id}","href":"/api-reference/cards/update-a-cardholder"},{"title":"Get a card","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /cards/{card_id}","href":"/api-reference/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml patch /cards/{card_id}","href":"/api-reference/cards/update-a-card"},{"title":"Replace a card's spend limit","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml put /cards/{card_id}/spend_limit","href":"/api-reference/cards/replace-a-cards-spend-limit"},{"title":"List a customer's persons","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /customers/{customer_id}/persons","href":"/api-reference/cards/list-a-customers-persons"},{"title":"Get a cardholder's application","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /cardholders/{cardholder_id}/application","href":"/api-reference/cards/get-a-cardholders-application"},{"title":"Get card art","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /card_art/{card_art_id}","href":"/api-reference/cards/get-card-art"},{"title":"Get a card transaction","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /card_transactions/{card_transaction_id}","href":"/api-reference/cards/get-a-card-transaction"},{"title":"List card art","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /card_art","href":"/api-reference/cards/list-card-art"},{"title":"List the card spend options available to the client","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /cards/spend_options","href":"/api-reference/cards/list-the-card-spend-options-available-to-the-client"},{"title":"List card transactions","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /card_transactions","href":"/api-reference/cards/list-card-transactions"},{"title":"Report a card found","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /cards/{card_id}/found_report","href":"/api-reference/cards/report-a-card-found"},{"title":"List cards","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /customers/{customer_id}/cards","href":"/api-reference/cards/list-cards"},{"title":"Create a card","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /customers/{customer_id}/cards","href":"/api-reference/cards/create-a-card"},{"title":"Create a card reveal session","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /cards/{card_id}/reveal_session","href":"/api-reference/cards/create-a-card-reveal-session"},{"title":"Report a card lost or stolen","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /cards/{card_id}/lost_stolen_report","href":"/api-reference/cards/report-a-card-lost-or-stolen"},{"title":"List cardholders","description":"Get a paginated list of cardholders for the given customer ID, optionally filtered by external ID.","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /customers/{customer_id}/cardholders","href":"/api-reference/cards/list-cardholders"},{"title":"Create a cardholder","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /customers/{customer_id}/cardholders","href":"/api-reference/cards/create-a-cardholder"},{"title":"Get a wallet's card enablement","description":"Returns the wallet's card-settlement enablement state. For a wallet\nthat is not yet enabled (`not_enabled`), `settlement_destination` is\nthe Dakota-configured destination the enablement will pin;\nafterwards it is the destination recorded for the wallet. It is\ninformational: it is not part of the intent and is not something to\nsign. Discovery only — no side effects.\n","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml get /wallets/{wallet_id}/card_enablement","href":"/api-reference/cards/get-a-wallets-card-enablement"},{"title":"Enable card settlement on a wallet","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /wallets/{wallet_id}/card_enablement","href":"/api-reference/cards/enable-card-settlement-on-a-wallet"},{"title":"Submit requested information for a cardholder's application","deprecated":null,"version":null,"tag":"Sandbox only","openapi":"/openapi.yaml post /cardholders/{cardholder_id}/application/information","href":"/api-reference/cards/submit-requested-information-for-a-cardholders-application"}]},{"group":"RD Marketing Fee","pages":[{"title":"List the wallets you hold outside Dakota","deprecated":null,"version":null,"openapi":"/openapi.yaml get /rd-marketing-fee/declared-wallets","href":"/api-reference/rd-marketing-fee/list-the-wallets-you-hold-outside-dakota"},{"title":"Declare a wallet you hold outside Dakota","deprecated":null,"version":null,"openapi":"/openapi.yaml post /rd-marketing-fee/declared-wallets","href":"/api-reference/rd-marketing-fee/declare-a-wallet-you-hold-outside-dakota"},{"title":"Get your payout destination for one deployment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /rd-marketing-fee/payout-destinations/{asset}/{network}","href":"/api-reference/rd-marketing-fee/get-your-payout-destination-for-one-deployment"},{"title":"Register your payout destination for one deployment","deprecated":null,"version":null,"openapi":"/openapi.yaml put /rd-marketing-fee/payout-destinations/{asset}/{network}","href":"/api-reference/rd-marketing-fee/register-your-payout-destination-for-one-deployment"},{"title":"One month of this client's marketing-fee statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /rd-marketing-fee/statements/{month}","href":"/api-reference/rd-marketing-fee/one-month-of-this-clients-marketing-fee-statement"},{"title":"Remove a wallet you hold outside Dakota","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /rd-marketing-fee/declared-wallets/{address}","href":"/api-reference/rd-marketing-fee/remove-a-wallet-you-hold-outside-dakota"},{"title":"The months this client has a marketing-fee statement for","deprecated":null,"version":null,"openapi":"/openapi.yaml get /rd-marketing-fee/statements","href":"/api-reference/rd-marketing-fee/the-months-this-client-has-a-marketing-fee-statement-for"},{"title":"Get your RD marketing-fee payout destination","deprecated":null,"version":null,"openapi":"/openapi.yaml get /rd-marketing-fee/payout-destination","href":"/api-reference/rd-marketing-fee/get-your-rd-marketing-fee-payout-destination"},{"title":"Register your RD marketing-fee payout destination","deprecated":null,"version":null,"openapi":"/openapi.yaml put /rd-marketing-fee/payout-destination","href":"/api-reference/rd-marketing-fee/register-your-rd-marketing-fee-payout-destination"}]},{"group":"Agentic Payments","pages":[{"title":"Create a hosted payment agent (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents","href":"/api-reference/agentic-payments/create-a-hosted-payment-agent-beta"},{"title":"Accept instructions — actuate proposals (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /instructions","href":"/api-reference/agentic-payments/accept-instructions-—-actuate-proposals-beta"},{"title":"List the calling client's scheduled payments (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scheduled-payments","href":"/api-reference/agentic-payments/list-the-calling-clients-scheduled-payments-beta"},{"title":"Schedule a payment directly (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /scheduled-payments","href":"/api-reference/agentic-payments/schedule-a-payment-directly-beta"},{"title":"Get a hosted payment agent (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-agents/{payment_agent_id}","href":"/api-reference/agentic-payments/get-a-hosted-payment-agent-beta"},{"title":"List an agent's x402 authorization holds (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-agents/{payment_agent_id}/x402/holds","href":"/api-reference/agentic-payments/list-an-agents-x402-authorization-holds-beta"},{"title":"Live progress of an in-flight drafting turn (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-agents/{payment_agent_id}/proposals/progress","href":"/api-reference/agentic-payments/live-progress-of-an-in-flight-drafting-turn-beta"},{"title":"Get an instruction (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /instructions/{instruction_id}","href":"/api-reference/agentic-payments/get-an-instruction-beta"},{"title":"Get the client's registered agentic policy (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agentic-policy","href":"/api-reference/agentic-payments/get-the-clients-registered-agentic-policy-beta"},{"title":"Register the client's agentic policy (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agentic-policy","href":"/api-reference/agentic-payments/register-the-clients-agentic-policy-beta"},{"title":"Get an agent's x402 wallet (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-agents/{payment_agent_id}/x402","href":"/api-reference/agentic-payments/get-an-agents-x402-wallet-beta"},{"title":"Enable x402 payments for an agent (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/x402","href":"/api-reference/agentic-payments/enable-x402-payments-for-an-agent-beta"},{"title":"Revoke a hosted agent (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/revoke","href":"/api-reference/agentic-payments/revoke-a-hosted-agent-beta"},{"title":"Draft payment proposals from a conversation (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/proposals","href":"/api-reference/agentic-payments/draft-payment-proposals-from-a-conversation-beta"},{"title":"List an agent's x402 spend mandates (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-agents/{payment_agent_id}/x402/mandates","href":"/api-reference/agentic-payments/list-an-agents-x402-spend-mandates-beta"},{"title":"Create an x402 spend mandate (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/x402/mandates","href":"/api-reference/agentic-payments/create-an-x402-spend-mandate-beta"},{"title":"Cancel one scheduled payment (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /scheduled-payments/{scheduled_payment_id}/cancel","href":"/api-reference/agentic-payments/cancel-one-scheduled-payment-beta"},{"title":"Sign an x402 payment authorization (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/x402/signatures","href":"/api-reference/agentic-payments/sign-an-x402-payment-authorization-beta"},{"title":"Cancel an x402 spend mandate (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-agents/{payment_agent_id}/x402/mandates/{mandate_id}/cancel","href":"/api-reference/agentic-payments/cancel-an-x402-spend-mandate-beta"}]},{"group":"Mandates","pages":[{"title":"List the calling client's mandates (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /mandates","href":"/api-reference/mandates/list-the-calling-clients-mandates-beta"},{"title":"Create a mandate directly (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /mandates","href":"/api-reference/mandates/create-a-mandate-directly-beta"},{"title":"List a mandate's versions (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /mandates/{mandate_id}/versions","href":"/api-reference/mandates/list-a-mandates-versions-beta"},{"title":"Get a mandate's remaining budget (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /mandates/{mandate_id}/budget","href":"/api-reference/mandates/get-a-mandates-remaining-budget-beta"},{"title":"Get a mandate (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /mandates/{mandate_id}","href":"/api-reference/mandates/get-a-mandate-beta"},{"title":"Amend a mandate — append a new version (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /mandates/{mandate_id}/amend","href":"/api-reference/mandates/amend-a-mandate-—-append-a-new-version-beta"},{"title":"Cancel a mandate (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /mandates/{mandate_id}/cancel","href":"/api-reference/mandates/cancel-a-mandate-beta"},{"title":"Approve a mandate (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /mandates/{mandate_id}/approve","href":"/api-reference/mandates/approve-a-mandate-beta"}]},{"group":"Legal","pages":[{"title":"Get a legal document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /legal/documents/{document_key}","href":"/api-reference/legal/get-a-legal-document"},{"title":"List current legal documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /legal/documents","href":"/api-reference/legal/list-current-legal-documents"}]},{"group":"Insights","pages":[{"title":"Get the customer's account insight report (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customer_id}/insights","href":"/api-reference/insights/get-the-customers-account-insight-report-beta"},{"title":"Get the client-level portfolio insight report (BETA)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /insights","href":"/api-reference/insights/get-the-client-level-portfolio-insight-report-beta"}]},{"group":"Account Verifications","pages":[{"title":"List account verification micro-deposits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account-verifications","href":"/api-reference/account-verifications/list-account-verification-micro-deposits"}]},{"group":"Payouts","pages":[{"title":"Get your developer fee statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /developer-fees/statement","href":"/api-reference/payouts/get-your-developer-fee-statement"},{"title":"Get your fee payout destination","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fee-payout-destination","href":"/api-reference/payouts/get-your-fee-payout-destination"},{"title":"Register or replace your fee payout destination","deprecated":null,"version":null,"openapi":"/openapi.yaml put /fee-payout-destination","href":"/api-reference/payouts/register-or-replace-your-fee-payout-destination"},{"title":"Remove your fee payout destination","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /fee-payout-destination","href":"/api-reference/payouts/remove-your-fee-payout-destination"}]}]}]},"basePath":"","title":"Create a cardholder - Dakota","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}