{
"error": {
"code": "payload_too_large",
"message": "Request body is too large",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#payload_too_large"
}
}
{
"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"
}
}
Beneficiaries
Import a Beneficiary base
Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.
POST
/
v1
/
beneficiaries
/
import
Import verified Beneficiaries with their bank accounts
How many rows were rejected. Equals the number of failed results.
{"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-import","slug":"/api-reference/beneficiaries-import","pageMetadata":{"title":"Import a Beneficiary base","openapi":"POST /v1/beneficiaries/import","description":"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; `results` carries the outcome of each.","href":"/api-reference/beneficiaries-import"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; \", _jsx(_components.code, {\n children: \"results\"\n }), \" carries the outcome of each.\"]\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-import.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":"Import a Beneficiary base","openapi":"POST /v1/beneficiaries/import","description":"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; `results` carries the outcome of each.","href":"/api-reference/beneficiaries-import"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; `results` carries the outcome of each.","operationId":"BeneficiariesController_import","parameters":[],"requestBody":"e43d3312-5eac-4114-9d03-26370f8c4c98","responses":{"200":"2f6f86ac-0914-4807-b954-c424845ce3a3","400":"ec9c28bc-bb12-4524-a3a9-3426268bff5f","401":"bc37acc9-d140-425e-9077-464aad52a1b1","403":"e1b35337-ae2b-4fc3-852f-82103e2df950","409":"50a4e306-3152-49e3-a52a-f96a875ff968","413":"d4773996-8e11-4ca2-8e06-aad87a88ed71","429":"0800b498-b59c-41eb-b882-61c7a8fa6e4d"},"security":["cd5fb487-0ac2-4906-8a69-ec36793dae5b"],"summary":"Import verified Beneficiaries with their bank accounts","tags":["Beneficiaries"],"method":"post","type":"path","servers":["23957774-ce69-4779-ae1b-7bae81a3b325"],"path":"/v1/beneficiaries/import","baseUrlOptions":["https://api.usecleff.com"],"title":"Import verified Beneficiaries with their bank accounts","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"description":"Rows to import (1..500). Each row is validated on its own.","type":"array","items":{"type":"object","properties":{"beneficiary_type":{"type":"string","enum":["person","business"],"isRequired":true,"uniqueKey":"rows.items.[INDEX].beneficiary_type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"rows.items.[INDEX].email","typeLabel":"string\u003cemail>"},"acknowledged":{"type":"boolean","description":"Must be true: your attestation that you have verified this recipient's identity. The row is created already compliant.","isRequired":true,"uniqueKey":"rows.items.[INDEX].acknowledged","typeLabel":"boolean"},"bank":{"type":"object","description":"Required. The bank account to register for this recipient, in the same shape as POST /v1/beneficiaries/{id}/bank-accounts. If you do not hold bank details, use POST /v1/beneficiaries/bulk-invites instead.","required":["account_holder_name","country","currency"],"properties":{"account_holder_name":{"type":"string","isRequired":true,"uniqueKey":"rows.items.[INDEX].bank.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":"rows.items.[INDEX].bank.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":"rows.items.[INDEX].bank.currency","typeLabel":"string"},"account_number":{"type":"string","description":"US account number, digits only. Required for a US bank, the only country accepted today.","uniqueKey":"rows.items.[INDEX].bank.account_number","typeLabel":"string"},"routing_code":{"type":"string","description":"US ABA routing number, checksum-validated. Required for a US bank.","uniqueKey":"rows.items.[INDEX].bank.routing_code","typeLabel":"string"},"iban":{"type":"string","description":"IBAN, for IBAN countries. Not accepted yet: only a US bank can be registered today.","uniqueKey":"rows.items.[INDEX].bank.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":"rows.items.[INDEX].bank.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":"rows.items.[INDEX].bank.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":"rows.items.[INDEX].bank.pix_key","typeLabel":"string"},"bank_name":{"type":"string","uniqueKey":"rows.items.[INDEX].bank.bank_name","typeLabel":"string"},"account_type":{"type":"string","enum":["checking","savings"],"description":"ACH account type (US). Defaults to checking at enrollment when unset.","uniqueKey":"rows.items.[INDEX].bank.account_type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"rows.items.[INDEX].bank","typeLabel":"object"},"phone":{"type":"string","description":"Optional contact phone. Used for the recipient-enrollment provider KYC step; never an identity field.","uniqueKey":"rows.items.[INDEX].phone","typeLabel":"string"},"nickname":{"type":"string","description":"Cleff-only display label, preferred over the legal name. Never sent to a provider.","uniqueKey":"rows.items.[INDEX].nickname","typeLabel":"string"},"first_name":{"type":"string","description":"Person: given name","uniqueKey":"rows.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Person: family name","uniqueKey":"rows.items.[INDEX].last_name","typeLabel":"string"},"country_of_residence":{"type":"string","description":"Person: ISO 3166-1 alpha-2 country of residence","uniqueKey":"rows.items.[INDEX].country_of_residence","typeLabel":"string"},"date_of_birth":{"type":"string","description":"Person: date of birth (YYYY-MM-DD)","uniqueKey":"rows.items.[INDEX].date_of_birth","typeLabel":"string"},"business_name":{"type":"string","description":"Business: legal business name","uniqueKey":"rows.items.[INDEX].business_name","typeLabel":"string"},"country_of_incorporation":{"type":"string","description":"Business: ISO 3166-1 alpha-2 country of incorporation","uniqueKey":"rows.items.[INDEX].country_of_incorporation","typeLabel":"string"},"registration_number":{"type":"string","description":"Business: Cleff-owned KYB record only. Never transmitted to Routefusion.","uniqueKey":"rows.items.[INDEX].registration_number","typeLabel":"string"},"tax_id":{"type":"string","description":"Tax identifier (Routefusion tax_number)","uniqueKey":"rows.items.[INDEX].tax_id","typeLabel":"string"},"postal_address":{"type":"object","description":"Optional mailing/legal address","properties":{"line1":{"type":"string","description":"Street address line 1 (required when an address is present)","uniqueKey":"rows.items.[INDEX].postal_address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address line 2 (suite, unit, etc.)","uniqueKey":"rows.items.[INDEX].postal_address.line2","typeLabel":"string"},"city":{"type":"string","description":"City / locality (required when an address is present)","uniqueKey":"rows.items.[INDEX].postal_address.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region","uniqueKey":"rows.items.[INDEX].postal_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal / ZIP code","uniqueKey":"rows.items.[INDEX].postal_address.postal_code","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 mailing country (required when an address is present)","uniqueKey":"rows.items.[INDEX].postal_address.country","typeLabel":"string"}},"uniqueKey":"rows.items.[INDEX].postal_address","typeLabel":"object"}},"required":["beneficiary_type","email","acknowledged","bank"],"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rows","typeLabel":"object[]"}},"required":["rows"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rows":[{"email":"jsmith@example.com","acknowledged":true,"bank":{"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>"},"phone":"\u003cstring>","nickname":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","country_of_residence":"\u003cstring>","date_of_birth":"\u003cstring>","business_name":"\u003cstring>","country_of_incorporation":"\u003cstring>","registration_number":"\u003cstring>","tax_id":"\u003cstring>","postal_address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postal_code":"\u003cstring>","country":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2f6f86ac-0914-4807-b954-c424845ce3a3":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"description":"One result per request row, in input order.","type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"Zero-based position of the row in the request.","isRequired":true,"uniqueKey":"results.items.[INDEX].index","typeLabel":"number"},"status":{"type":"string","enum":["created","failed"],"isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"beneficiary_id":{"type":"string","description":"Present on created rows.","uniqueKey":"results.items.[INDEX].beneficiary_id","typeLabel":"string"},"bank_account_id":{"type":"string","description":"Present on created rows.","uniqueKey":"results.items.[INDEX].bank_account_id","typeLabel":"string"},"payout_usable":{"type":"boolean","description":"Present on created rows: whether a Payout to this bank account would be accepted. The Beneficiary is created and compliant either way.","uniqueKey":"results.items.[INDEX].payout_usable","typeLabel":"boolean"},"error":{"type":"object","description":"Present on failed rows.","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code, from the same set the error envelope uses.","isRequired":true,"uniqueKey":"results.items.[INDEX].error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].error.message","typeLabel":"string"},"field":{"type":"string","description":"The offending field, when the failure names one.","uniqueKey":"results.items.[INDEX].error.field","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].error","typeLabel":"object"}},"required":["index","status"],"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"created_count":{"type":"number","description":"How many rows landed. Equals the number of `created` results.","isRequired":true,"uniqueKey":"created_count","typeLabel":"number"},"failed_count":{"type":"number","description":"How many rows were rejected. Equals the number of `failed` results.","isRequired":true,"uniqueKey":"failed_count","typeLabel":"number"}},"required":["results","created_count","failed_count"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"index":123,"status":"created","beneficiary_id":"\u003cstring>","bank_account_id":"\u003cstring>","payout_usable":true,"error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}}],"created_count":123,"failed_count":123}}},"exampleType":"generated"}},"exampleType":"generated"},"ec9c28bc-bb12-4524-a3a9-3426268bff5f":{"description":"The request failed validation; row contents are reported per row.","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":"rows","code":"is_required","message":"rows should not be null or undefined"}],"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":"rows","code":"is_required","message":"rows should not be null or undefined"}],"docs_url":"https://docs.usecleff.com/errors#validation_failed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bc37acc9-d140-425e-9077-464aad52a1b1":{"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"},"e1b35337-ae2b-4fc3-852f-82103e2df950":{"description":"Only an admin API key may import.","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_ops","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_ops","environment":"sandbox"},"docs_url":"https://docs.usecleff.com/errors#forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"50a4e306-3152-49e3-a52a-f96a875ff968":{"description":"Another request claimed one of the emails during the import; the batch is not written. Retry it.","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":"BENEFICIARY_EMAIL_ALREADY_EXISTS","message":"A beneficiary with this email already exists","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#beneficiary_email_already_exists"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BENEFICIARY_EMAIL_ALREADY_EXISTS","message":"A beneficiary with this email already exists","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#beneficiary_email_already_exists"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d4773996-8e11-4ca2-8e06-aad87a88ed71":{"description":"The upload is larger than the request body limit.","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":"payload_too_large","message":"Request body is too large","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#payload_too_large"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"payload_too_large","message":"Request body is too large","request_id":"req_abc123","occurred_at":"2026-07-07T12:00:00.000Z","actor":null,"docs_url":"https://docs.usecleff.com/errors#payload_too_large"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0800b498-b59c-41eb-b882-61c7a8fa6e4d":{"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":{"cd5fb487-0ac2-4906-8a69-ec36793dae5b":{"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":"Import a Beneficiary base - Cleff API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T22:17:22.232Z","originalFileLocation":"api-reference/beneficiaries-import.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=\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.\">\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=\"Import a Beneficiary base - Cleff API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.\">\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-import\">\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=Beneficiaries\u0026amp;title=Import+a+Beneficiary+base\u0026amp;description=Creates+up+to+500+Beneficiaries+in+one+call%2C+each+with+their+bank+account+and+compliance+acknowledgment.+Rows+succeed+or+fail+independently%3B+%60results%60+carries+t\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=5a859b8b418fde74b9156037ab374b3c45e591b6e5a03e91c54e04074d2356d8\">\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=\"Import a Beneficiary base - Cleff API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cleff.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Import+a+Beneficiary+base\u0026amp;description=Creates+up+to+500+Beneficiaries+in+one+call%2C+each+with+their+bank+account+and+compliance+acknowledgment.+Rows+succeed+or+fail+independently%3B+%60results%60+carries+t\u0026amp;theme=7e252cb4f803b62f4977cf56\u0026amp;signature=5a859b8b418fde74b9156037ab374b3c45e591b6e5a03e91c54e04074d2356d8\">\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-import\">\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-import.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-import#webpage\",\"url\":\"https://docs.usecleff.com/api-reference/beneficiaries-import\",\"name\":\"Import a Beneficiary base\",\"description\":\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.\",\"dateModified\":\"2026-10-01T22:17:22.232Z\",\"isPartOf\":{\"@id\":\"https://docs.usecleff.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-import#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-import#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\":\"Import a Beneficiary base\",\"item\":\"https://docs.usecleff.com/api-reference/beneficiaries-import\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-import#apireference\",\"headline\":\"Import a Beneficiary base\",\"name\":\"Import a Beneficiary base\",\"description\":\"Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.\",\"url\":\"https://docs.usecleff.com/api-reference/beneficiaries-import\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecleff.com/api-reference/beneficiaries-import#webpage\"},\"dateModified\":\"2026-10-01T22:17:22.232Z\",\"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","description":"Creates a Beneficiary scoped to the caller’s Business and environment. Submitting acknowledged=true transitions to compliant immediately.","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}","description":"Replaces the editable profile fields (name, alias, email, identity fields). Changing a PII trigger field (legal name, date of birth, country, tax id) on a compliant Beneficiary auto-raises reacknowledgment_required, blocking new Payouts until re-acknowledged. Identity-shape violations are rejected (422) with the row unchanged. The email cannot change while the Beneficiary has a destination on file: resending the current email, in any letter case, is not a change, and the refusal is `BENEFICIARY_EMAIL_LOCKED`.","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","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}","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":"Import a Beneficiary base - 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"]}