{
"error": {
"code": "BANK_ACCOUNT_VALIDATION_FAILED",
"message": "routing_code must be a 9-digit US ABA routing number",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"details": [
{
"field": "routing_code",
"code": "aba_malformed",
"message": "routing_code must be a 9-digit US ABA routing number"
}
],
"docs_url": "https://docs.usecleff.com/errors#bank_account_validation_failed"
}
}
{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}
Bank accounts
Register a bank account
Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.
ISO 3166-1 alpha-2 of the bank country. Only US is accepted today, because it is the only country a payout can reach; any other is refused with BANK_ACCOUNT_VALIDATION_FAILED (country_not_payable).
ISO 4217 currency code. Must be the bank country's currency, USD for a US bank; any other is refused with BANK_ACCOUNT_VALIDATION_FAILED (currency_not_payable).
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Cleff API","description":"What it is: Cleff is a payout orchestration platform. A business registers each payee (a Beneficiary), funds its Cleff Account and sends payout instructions. Cleff validates, routes and tracks each payout to disbursement. It is available through a REST/JSON API (api.usecleff.com) and a dashboard (app.usecleff.com).\n\nWho it’s for: Businesses that pay people at volume: contractors, traders and agents. The beachhead is prop trading firms, but the architecture isn’t tied to that industry.\n\nWhat sets it apart:\n\n- It does not hold or move funds. Cleff sends instructions to downstream providers, so it positions itself as infrastructure and not a money services business.\n- ACH is the default rail. RTP and FedNow are available once a Business is approved for them.\n- Sandbox is open as soon as you verify your email. Production unlocks after business verification.\n- It has webhooks, idempotency and approvals, and the docs are built for AI agents: llms.txt, per-page .md, an MCP server and an installable skill.","colors":{"primary":"#0E1216","light":"#42D898","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-White.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=39ae818520b68ee890b4d5008a4bc08d","href":"https://www.usecleff.com"},"favicon":{"light":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137","dark":"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=09077340a0ea4762bc3828d9966ea137"},"api":{"openapi":"openapi.json","examples":{"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"decoration":"grid","color":{"light":"#F8FAFB","dark":"#0E1216"}},"navbar":{"links":[{"href":"https://app.usecleff.com/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.usecleff.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/cleff-inc","website":"https://www.usecleff.com","github":"https://github.com/usecleff"},"links":[{"header":"COMPANY","items":[{"label":"Brand Assets","href":"https://usecleff.com/brand-assets"},{"label":"Contact","href":"mailto:support@usecleff.com"}]},{"header":"LEGAL","items":[{"label":"Terms \u0026 Conditions","href":"https://usecleff.com/legal/terms"},{"label":"Privacy Policy","href":"https://usecleff.com/legal/privacy"}]}]},"seo":{"metatags":{"og:site_name":"Cleff API Docs","og:type":"website","robots":"index, follow, max-snippet:-1, max-image-preview:large","theme-color":"#0E1216"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cleff","hasAudioNarration":false,"actualSubdomain":"cleff","customDomains":["docs.usecleff.com"],"gitSource":{"type":"github","owner":"usecleff","repo":"cleff","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adba51ff69436d352bb4820","collectionId":"8ec4aa8d-643d-44f7-b69f-9f5b98e9747f","liveDeploymentHistoryId":"6adba51ff69436d352bb4820","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adba51ff69436d352bb4820","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Reference","count":34},{"language":"default","tag":"Beneficiaries","count":18},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Payouts","count":11},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Essentials","count":5},{"language":"default","tag":"Bank accounts","count":3},{"language":"default","tag":"Collection invites","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@usecleff.com"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/beneficiaries-bank-accounts-create","slug":"/api-reference/beneficiaries-bank-accounts-create","pageMetadata":{"title":"Register a bank account","openapi":"POST /v1/beneficiaries/{id}/bank-accounts","description":"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.","href":"/api-reference/beneficiaries-bank-accounts-create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\"\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={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Agents:`}),` fetch this page as plain markdown at\n`,_jsx(_components.code,{children:`https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create.md`}),`.`]})})}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":"Register a bank account","openapi":"POST /v1/beneficiaries/{id}/bank-accounts","description":"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.","href":"/api-reference/beneficiaries-bank-accounts-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.","operationId":"BeneficiariesController_registerBankAccount","parameters":["65bdda25-9c34-4514-b3b8-49cbb459f56d"],"requestBody":"1ad382b5-132f-48c8-af02-f198b0ac114d","responses":{"201":"6b32abc3-f85b-463f-a31e-2bafa2761f7f","400":"e0cad846-b932-4806-b30e-05c442ecb9e9","401":"3efc402b-b5ad-4c30-bc2c-46acda1644c0","403":"caf30635-84e5-414c-9c9e-3e9699177411","404":"7e78354c-da5d-42aa-84b3-43751c55a62f","422":"517e45db-8621-4595-8a8c-fe17bb826766","429":"b1f384e5-8298-4d2a-8845-fac84ed45a5e"},"security":["72ff5e1a-eedf-40fd-9de8-29ba8d5378a2"],"summary":"Register a bank account for a Beneficiary","tags":["Beneficiaries"],"method":"post","type":"path","servers":["23957774-ce69-4779-ae1b-7bae81a3b325"],"path":"/v1/beneficiaries/{id}/bank-accounts","baseUrlOptions":["https://api.usecleff.com"],"title":"Register a bank account for a Beneficiary","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"65bdda25-9c34-4514-b3b8-49cbb459f56d":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_holder_name":{"type":"string","isRequired":true,"uniqueKey":"account_holder_name","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 of the bank country. Only `US` is accepted today, because it is the only country a payout can reach; any other is refused with `BANK_ACCOUNT_VALIDATION_FAILED` (`country_not_payable`).","isRequired":true,"uniqueKey":"country","typeLabel":"string"},"currency":{"type":"string","description":"ISO 4217 currency code. Must be the bank country's currency, `USD` for a US bank; any other is refused with `BANK_ACCOUNT_VALIDATION_FAILED` (`currency_not_payable`).","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"account_number":{"type":"string","description":"US account number, digits only. Required for a US bank, the only country accepted today.","uniqueKey":"account_number","typeLabel":"string"},"routing_code":{"type":"string","description":"US ABA routing number, checksum-validated. Required for a US bank.","uniqueKey":"routing_code","typeLabel":"string"},"iban":{"type":"string","description":"IBAN, for IBAN countries. Not accepted yet: only a US bank can be registered today.","uniqueKey":"iban","typeLabel":"string"},"swift_bic":{"type":"string","description":"SWIFT/BIC, for cross-border SWIFT routing. Not accepted yet: only a US bank can be registered today.","uniqueKey":"swift_bic","typeLabel":"string"},"clabe":{"type":"string","description":"CLABE, for a Mexican bank. Not accepted yet: only a US bank can be registered today.","uniqueKey":"clabe","typeLabel":"string"},"pix_key":{"type":"string","description":"Pix key, for a Brazilian bank. Not accepted yet: only a US bank can be registered today.","uniqueKey":"pix_key","typeLabel":"string"},"bank_name":{"type":"string","uniqueKey":"bank_name","typeLabel":"string"},"account_type":{"type":"string","enum":["checking","savings"],"description":"ACH account type (US). Defaults to checking at enrollment when unset.","uniqueKey":"account_type","typeLabel":"enum\u003cstring>"}},"required":["account_holder_name","country","currency"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_holder_name":"\u003cstring>","country":"\u003cstring>","currency":"\u003cstring>","account_number":"\u003cstring>","routing_code":"\u003cstring>","iban":"\u003cstring>","swift_bic":"\u003cstring>","clabe":"\u003cstring>","pix_key":"\u003cstring>","bank_name":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6b32abc3-f85b-463f-a31e-2bafa2761f7f":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bank_account":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"bank_account.id","typeLabel":"string"},"kind":{"type":"string","enum":["bank","card"],"description":"Whether this destination is a bank account or a card. This list carries both, because a Payout may be sent to either.","isRequired":true,"uniqueKey":"bank_account.kind","typeLabel":"enum\u003cstring>"},"account_holder_name":{"type":"string","isRequired":true,"uniqueKey":"bank_account.account_holder_name","typeLabel":"string"},"currency":{"type":"string","description":"ISO 4217 currency code","isRequired":true,"uniqueKey":"bank_account.currency","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 of the bank country","isRequired":true,"uniqueKey":"bank_account.country","typeLabel":"string"},"status":{"type":"string","enum":["verified","pending_verification","suspended"],"isRequired":true,"uniqueKey":"bank_account.status","typeLabel":"enum\u003cstring>"},"validation_status":{"type":"string","enum":["unvalidated","validated"],"description":"Cleff-side format/modulus validation outcome. Distinct from ownership verification on `status`.","isRequired":true,"uniqueKey":"bank_account.validation_status","typeLabel":"enum\u003cstring>"},"payout_usable":{"type":"boolean","description":"Derived: true only when the account is `validated`, `verified`, not a card past its last valid day, AND not rail-rejected. The single flag a Payout destination check should read.","isRequired":true,"uniqueKey":"bank_account.payout_usable","typeLabel":"boolean"},"last4":{"type":"string","description":"Last 4 of the account identifier; masked","isRequired":true,"uniqueKey":"bank_account.last4","typeLabel":"string"},"account_type":{"oneOf":[{"type":"string","enum":["checking","savings"],"description":"ACH account type; null when not captured. Non-sensitive, no decryption.","isRequired":true,"uniqueKey":"bank_account.account_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["checking","savings"],"description":"ACH account type; null when not captured. Non-sensitive, no decryption.","isRequired":true,"uniqueKey":"bank_account.account_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank_account.account_type","typeLabel":"enum\u003cstring> | null"},"default":{"type":"boolean","nullable":false,"default":false,"description":"True for the destination a payout that names no `destination_id` goes to: the Beneficiary's declared destination, or else the only destination they hold that is verified, validated and in date. At most one item is the default. On a register response it reflects the Beneficiary's destinations at that moment. It can have `payout_usable: false`: a declared card that has expired is refused, and no other destination is paid in its place.","isRequired":true,"uniqueKey":"bank_account.default","typeLabel":"boolean"},"bank_name":{"oneOf":[{"type":"string","description":"Name of the bank, when one was sent at registration. null for a card, and for a bank without one.","isRequired":true,"uniqueKey":"bank_account.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the bank, when one was sent at registration. null for a card, and for a bank without one.","isRequired":true,"uniqueKey":"bank_account.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank_account.bank_name","typeLabel":"string | null"},"card_valid_through":{"oneOf":[{"type":"string","format":"date","description":"Last day a card is valid, in UTC, as `YYYY-MM-DD`. null for a bank account.","isRequired":true,"uniqueKey":"bank_account.card_valid_through.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Last day a card is valid, in UTC, as `YYYY-MM-DD`. null for a bank account.","isRequired":true,"uniqueKey":"bank_account.card_valid_through.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank_account.card_valid_through","typeLabel":"string\u003cdate> | null"},"name":{"type":"string","description":"A label to show in a picker, built from the masked fields: for example `Chase USD ••1234 checking` or `Card ••1234 · exp 08/27`. Use `id` to identify the destination, not this.","isRequired":true,"uniqueKey":"bank_account.name","typeLabel":"string"},"rail_rejection_reason":{"oneOf":[{"type":"object","description":"Why the payment rail will not pay this destination: a refusal at registration, with the captured reason (e.g. a routing number the sponsor bank won't accept), or a payout the rail failed or returned for a reason about the destination, as the failure code and the rail's code (e.g. `account_closed (R02)`). null when the rail never refused it. Reflects only the rail outcome, never KYC/compliance.","uniqueKey":"bank_account.rail_rejection_reason.oneOf.0","typeLabel":"object"},{"type":"null","description":"Why the payment rail will not pay this destination: a refusal at registration, with the captured reason (e.g. a routing number the sponsor bank won't accept), or a payout the rail failed or returned for a reason about the destination, as the failure code and the rail's code (e.g. `account_closed (R02)`). null when the rail never refused it. Reflects only the rail outcome, never KYC/compliance.","uniqueKey":"bank_account.rail_rejection_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank_account.rail_rejection_reason","typeLabel":"object | null"}},"required":["id","kind","account_holder_name","currency","country","status","validation_status","payout_usable","last4","account_type","default","bank_name","card_valid_through","name"],"isRequired":true,"uniqueKey":"bank_account","typeLabel":"object"}},"required":["bank_account"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bank_account":{"id":"\u003cstring>","kind":"bank","account_holder_name":"\u003cstring>","currency":"\u003cstring>","country":"\u003cstring>","status":"verified","validation_status":"unvalidated","payout_usable":true,"last4":"\u003cstring>","account_type":"checking","default":false,"bank_name":"\u003cstring>","card_valid_through":"2023-12-25","name":"\u003cstring>","rail_rejection_reason":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e0cad846-b932-4806-b30e-05c442ecb9e9":{"description":"The request body failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"account_number","code":"missing_account_identifier","message":"must include at least one of iban, account_number, swift_bic, clabe, or pix_key"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"Request validation failed","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"account_number","code":"missing_account_identifier","message":"must include at least one of iban, account_number, swift_bic, clabe, or pix_key"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3efc402b-b5ad-4c30-bc2c-46acda1644c0":{"description":"The API key is missing, invalid or revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Unauthorized","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#unauthorized"}}}},"exampleType":"examples"}},"exampleType":"examples"},"caf30635-84e5-414c-9c9e-3e9699177411":{"description":"The API key's role cannot make this request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"Forbidden resource","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_read_only","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7e78354c-da5d-42aa-84b3-43751c55a62f":{"description":"No Beneficiary with this id.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Beneficiary 3f9c2b1a-6d4e-4f8a-b2c7-9e1d0a5b7c3f not found","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#not_found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Beneficiary 3f9c2b1a-6d4e-4f8a-b2c7-9e1d0a5b7c3f not found","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"517e45db-8621-4595-8a8c-fe17bb826766":{"description":"The bank details cannot be paid (malformed routing, or a country or currency no payout reaches), or the Beneficiary is archived.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"BANK_ACCOUNT_VALIDATION_FAILED","message":"routing_code must be a 9-digit US ABA routing number","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"routing_code","code":"aba_malformed","message":"routing_code must be a 9-digit US ABA routing number"}],"docs_url":"https://docs.usecleff.com/errors#bank_account_validation_failed"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BANK_ACCOUNT_VALIDATION_FAILED","message":"routing_code must be a 9-digit US ABA routing number","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":{"user_id":"usr_...","membership_id":"mem_...","role":"business_admin","environment":"sandbox"},"details":[{"field":"routing_code","code":"aba_malformed","message":"routing_code must be a 9-digit US ABA routing number"}],"docs_url":"https://docs.usecleff.com/errors#bank_account_validation_failed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"b1f384e5-8298-4d2a-8845-fac84ed45a5e":{"description":"Too many requests for this Business and environment.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"error.occurred_at","typeLabel":"string\u003cdate-time>"},"actor":{"oneOf":[{"type":"object","required":["user_id","membership_id","role","environment"],"properties":{"user_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.user_id","typeLabel":"string"},"membership_id":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.membership_id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"error.actor.oneOf.0.role","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","production"],"isRequired":true,"uniqueKey":"error.actor.oneOf.0.environment","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"error.actor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.actor","typeLabel":"object | null"},"docs_url":{"type":"string","isRequired":true,"uniqueKey":"error.docs_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","occurred_at","actor","docs_url"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Slow down and retry after the window.","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#rate_limited"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"72ff5e1a-eedf-40fd-9de8-29ba8d5378a2":{"api_key":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"}}},"servers":{"23957774-ce69-4779-ae1b-7bae81a3b325":{"url":"https://api.usecleff.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"ck_\u003cenv>_\u003cid>_\u003csecret>","type":"http","description":"Cleff API key, created in the dashboard under Settings → API keys","scopes":[],"schemeName":"api_key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Cleff API key, created in the dashboard under Settings → API keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi.json"},"subdomain":"cleff","siteName":"Cleff API","title":"Register a bank account - Cleff API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T22:17:22.236Z","originalFileLocation":"api-reference/beneficiaries-bank-accounts-create.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=\"system\"}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=\"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/cleff-favicon.png?fit=max\u0026amp;auto=format\u0026amp;n=Vp4Ivrsqo5WIMAII\u0026amp;q=85\u0026amp;s=09077340a0ea4762bc3828d9966ea137\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Register a bank account - Cleff API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cleff API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Bank+accounts\u0026amp;title=Register+a+bank+account\u0026amp;description=Registers+a+destination+on+behalf+of+the+Beneficiary.+The+identifier+is+encrypted+at+rest%3B+the+response+is+the+masked+projection+%28last4+only%29.+When+the+owning+B\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=96395fd9bd047416ea89648dac58d12191deb0c062417fd75d158b66ed4d20dd\">\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=\"Register a bank account - Cleff API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Bank+accounts\u0026amp;title=Register+a+bank+account\u0026amp;description=Registers+a+destination+on+behalf+of+the+Beneficiary.+The+identifier+is+encrypted+at+rest%3B+the+response+is+the+masked+projection+%28last4+only%29.+When+the+owning+B\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=96395fd9bd047416ea89648dac58d12191deb0c062417fd75d158b66ed4d20dd\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/cleff/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cleff API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E1216\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0E1216\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/beneficiaries-bank-accounts-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usecleff.com/#organization\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cleff/Vp4Ivrsqo5WIMAII/images/Cleff-Brand-Black.svg?fit=max\u0026auto=format\u0026n=Vp4Ivrsqo5WIMAII\u0026q=85\u0026s=76d5efab56d934dba1ef8f82c6f3e3da\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usecleff.com#website\",\"name\":\"Cleff API\",\"url\":\"https://docs.usecleff.com\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create#webpage\",\"url\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create\",\"name\":\"Register a bank account\",\"description\":\"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\",\"dateModified\":\"2026-10-01T22:17:22.236Z\",\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiaries\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bank accounts\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-list\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Register a bank account\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create#apireference\",\"headline\":\"Register a bank account\",\"name\":\"Register a bank account\",\"description\":\"Registers a destination on behalf of the Beneficiary. The identifier is encrypted at rest; the response is the masked projection (last4 only). When the owning Beneficiary is compliant, the account is verified immediately.\",\"url\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-bank-accounts-create#webpage\"},\"dateModified\":\"2026-10-01T22:17:22.236Z\",\"publisher\":{\"@id\":\"https://docs.usecleff.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cleff API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cleff API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"rocket","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Reference","pages":[{"group":"Beneficiaries","pages":[{"title":"Beneficiaries","href":"/api-reference/beneficiaries"},{"title":"Create a Beneficiary","openapi":"POST /v1/beneficiaries","href":"/api-reference/beneficiaries-create"},{"title":"Import a Beneficiary base","openapi":"POST /v1/beneficiaries/import","href":"/api-reference/beneficiaries-import"},{"title":"Update a Beneficiary","openapi":"PUT /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-update"},{"title":"List Beneficiaries","openapi":"GET /v1/beneficiaries","href":"/api-reference/beneficiaries-list"},{"title":"Retrieve a Beneficiary","openapi":"GET /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-get"},{"title":"Export Beneficiaries","openapi":"GET /v1/beneficiaries/export","href":"/api-reference/beneficiaries-export"},{"title":"Archive a Beneficiary","openapi":"DELETE /v1/beneficiaries/{id}","href":"/api-reference/beneficiaries-archive"},{"title":"Acknowledge compliance","openapi":"POST /v1/beneficiaries/{id}/compliance-acknowledgment","href":"/api-reference/beneficiaries-acknowledge"},{"title":"Set a declared destination","openapi":"PUT /v1/beneficiaries/{id}/declared-destination","href":"/api-reference/beneficiaries-declared-destination-update"},{"group":"Collection invites","pages":[{"title":"Invite Beneficiaries to submit details","openapi":"POST /v1/beneficiaries/collection-invites","href":"/api-reference/beneficiaries-collection-invites"},{"title":"Bulk-invite Beneficiaries","openapi":"POST /v1/beneficiaries/bulk-invites","href":"/api-reference/beneficiaries-bulk-invites"},{"title":"Cancel a collection request","openapi":"DELETE /v1/beneficiaries/{id}/collection-requests/{requestId}","href":"/api-reference/beneficiaries-collection-requests-cancel"}]},{"group":"Bank accounts","pages":[{"title":"List bank accounts","openapi":"GET /v1/beneficiaries/{id}/bank-accounts","description":"Returns all statuses; identifiers are masked to last4. The full IBAN/account number is never serialized.","href":"/api-reference/beneficiaries-bank-accounts-list"},{"title":"Register a bank account","openapi":"POST /v1/beneficiaries/{id}/bank-accounts","href":"/api-reference/beneficiaries-bank-accounts-create"},{"title":"Delete a destination","openapi":"DELETE /v1/beneficiaries/{id}/bank-accounts/{accountId}","description":"Deletes a destination, a bank account or a card, so it can no longer be paid or chosen: it leaves `GET /v1/beneficiaries/{id}/bank-accounts` and the Beneficiary’s collection link, and a payout that names it is refused. Payouts already created to it keep showing its last four digits, and one that is approved or on compliance hold is still sent to it. If it was the Beneficiary’s declared destination, `declared_destination_id` is cleared and the Beneficiary is told by email. Refused with `DESTINATION_HAS_PENDING_PAYOUT` while a payout awaiting approval is headed to it: reject that payout, then delete. Idempotent: deleting a destination that is already deleted succeeds.","href":"/api-reference/beneficiaries-bank-accounts-delete"}]}]},{"group":"Funding","pages":[{"title":"Overview","href":"/api-reference/funding"},{"title":"Get Cleff Account","openapi":"GET /v1/funding/account","href":"/api-reference/funding-account-get"},{"title":"Top up sandbox balance","openapi":"POST /v1/business/funding-account/sandbox-balance","href":"/api-reference/funding-sandbox-balance"}]},{"group":"Payouts","pages":[{"title":"Overview","href":"/api-reference/payouts"},{"title":"Create a Payout","openapi":"POST /v1/payouts","href":"/api-reference/payouts-create"},{"title":"Bulk-create Payouts","openapi":"POST /v1/payouts/bulk","href":"/api-reference/payouts-bulk-create"},{"title":"List Payouts","openapi":"GET /v1/payouts","href":"/api-reference/payouts-list"},{"title":"Retrieve a Payout","openapi":"GET /v1/payouts/{payoutId}","href":"/api-reference/payouts-get"},{"title":"Approve a Payout","openapi":"POST /v1/payouts/{payoutId}/approve","href":"/api-reference/payouts-approve"},{"title":"Reject a Payout","openapi":"POST /v1/payouts/{payoutId}/reject","href":"/api-reference/payouts-reject"},{"title":"Submit a Decision","openapi":"POST /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-create"},{"title":"List Decisions","openapi":"GET /v1/payouts/{payoutId}/decisions","href":"/api-reference/payouts-decisions-list"}]},{"group":"Webhooks","pages":[{"title":"Create or rotate a webhook subscription","openapi":"POST /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-create"},{"title":"Get the webhook subscription","openapi":"GET /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-get"},{"title":"Update the webhook subscription","openapi":"PATCH /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-update"},{"title":"Delete the webhook subscription","openapi":"DELETE /v1/webhook-subscriptions","href":"/api-reference/webhook-subscriptions-delete"},{"title":"Payout events","href":"/api-reference/webhook-events-payout"},{"title":"Beneficiary events","href":"/api-reference/webhook-events-beneficiary"}]}]}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Register a bank account - Cleff API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}