Beneficiary details used to create this account holder. Which shape is returned follows country_of_citizenship: US individual when it is US, Non-US individual for any other country, Business when holder_type is business.
Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.
ISO 8601 UTC timestamp when the account holder was created.
Example:
"2026-01-15T10:30:00Z"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Augustus Docs","colors":{"primary":"#0031F5","light":"#4D73FF","dark":"#0031F5"},"logo":{"light":"https://mintcdn.com/getivy/oqhoqqx6p7BtjsUH/logo/augustus-logo-dark.svg?fit=max\u0026auto=format\u0026n=oqhoqqx6p7BtjsUH\u0026q=85\u0026s=da91415989d012f863e55f449522f7d0","dark":"https://mintcdn.com/getivy/oqhoqqx6p7BtjsUH/logo/augustus-logo-light.svg?fit=max\u0026auto=format\u0026n=oqhoqqx6p7BtjsUH\u0026q=85\u0026s=21f2748ece91c32d480c5dc586871e9e"},"favicon":"https://mintcdn.com/getivy/wwTOXrkOZZzmrHOI/a54274d-small-favIcon.png?fit=max\u0026auto=format\u0026n=wwTOXrkOZZzmrHOI\u0026q=85\u0026s=0b7de733c4bb5d43522b3c6b3c13631b","api":{"mdx":{"server":["https://api.sandbox.augustus.com","https://api.augustus.com"]}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FCFCFC","dark":"#121212"}},"navbar":{"links":[{"href":"mailto:help@augustus.com","label":"Contact Us"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.augustus.com"}},"footer":{"socials":{"website":"https://augustus.com","linkedin":"https://www.linkedin.com/company/augustusbank"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","add-mcp","cursor","vscode","download-spec"],"display":"header"},"markdown":{"instructions":["Treat the published Augustus OpenAPI specification (https://api.augustus.com/openapi/2026-05-01.json) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.","Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is required.","Cite or link the relevant docs.augustus.com page when answering integration questions.","Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.","Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.","The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"getivy","hasAudioNarration":false,"actualSubdomain":"getivy","customDomains":["docs.augustus.com"],"gitSource":{"type":"github","owner":"augustus","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae27e804f1bcceb1a6103c5","collectionId":"c53d5b71-4727-4b53-9408-82db1721c72a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae27e804f1bcceb1a6103c5"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae309a128177df25e856217","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":191},{"language":"default","tag":"2026-05-01","count":103},{"language":"default","tag":"2023-01-01 (Ivy)","count":88},{"language":"default","tag":"Webhook Events","count":60},{"language":"default","tag":"REST API","count":40},{"language":"default","tag":"Webhooks","count":37},{"language":"default","tag":"WebhookEventExamples","count":36},{"language":"default","tag":"Accounts","count":34},{"language":"default","tag":"Documentation","count":24},{"language":"default","tag":"Payments","count":24}],"searchSettings":{"isFiltersEnabled":false}},"assistantConfig":{},"basePath":"","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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#topbar-cta-button span[class*=rounded],.callout,.card,.code-block,.code-group,.code-group [class*=rounded],.expandable,.expandable [class*=rounded],.frame,.frame [class*=rounded],.nav-dropdown-trigger{border-radius:4px!important}.permissions-table table{width:100%!important;min-width:0!important;table-layout:fixed!important}.permissions-table td,.permissions-table th{width:11%!important;min-width:0!important;white-space:normal!important;padding-left:.25rem!important;padding-right:.25rem!important;text-align:center!important}.permissions-table td:first-child,.permissions-table th:first-child{width:45%!important;text-align:left!important;padding-left:.5rem!important}.api-ref-link{display:inline-flex!important;align-items:center;gap:.5rem;margin-top:-.25rem;font-size:.875rem;text-decoration:none!important}.api-ref-link,.api-ref-link:hover{border-bottom:none!important}.api-ref-link__method,.api-ref-link__path{font-family:ui-monospace,SFMono-Regular,Menlo,monospace}.api-ref-link__method{font-size:.75rem;font-weight:700;padding:.125rem .4rem;border-radius:4px!important;background:rgb(var(--primary)/.12);color:rgb(var(--primary))}.dark .api-ref-link__method{background:rgb(var(--primary-light)/.15);color:rgb(var(--primary-light))}.api-ref-link__path{font-size:.8125rem;background:0 0!important;padding:0!important}.api-ref-link__cta{opacity:.7}.api-ref-link:hover .api-ref-link__cta{opacity:1;border-bottom:1px solid currentColor}"}],"page":{"pagePath":"v1/objects/account-holder","slug":"/v1/objects/account-holder","pageMetadata":{"title":"The account holder object","description":"The person or business an account is opened for, with the identity details Augustus screens.","openapi-schema":"https://api.augustus.com/openapi/2026-05-01.json AccountHolderResourceDto","href":"/v1/objects/account-holder"},"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: \"The person or business an account is opened for, with the identity details Augustus screens.\"\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The account holder object","description":"The person or business an account is opened for, with the identity details Augustus screens.","openapi-schema":"https://api.augustus.com/openapi/2026-05-01.json AccountHolderResourceDto","href":"/v1/objects/account-holder"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Unique identifier of the account holder.","example":"68e0a1b2c3d4e5f60718293a","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","description":"Resource type discriminator.","enum":["account_holder"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"holder_type":{"type":"string","enum":["natural_person","business"],"description":"Type of the account holder.","isRequired":true,"uniqueKey":"holder_type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","active","closed"],"description":"Current account holder status.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"beneficiary_data":{"oneOf":[{"type":"object","title":"US individual","description":"Beneficiary details used to create this account holder. Which shape is returned follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US individual** for any other country, **Business** when `holder_type` is `business`.","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"oneOf":[{"type":"object","title":"SSN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["ssn"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^\\d{3}-\\d{2}-\\d{4}$","example":"123-45-6789","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.0.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.0","typeLabel":"SSN · object"},{"type":"object","title":"ITIN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["itin"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^9\\d{2}-\\d{2}-\\d{4}$","example":"912-34-5678","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.1.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification.oneOf.1","typeLabel":"ITIN · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.identification","typeLabel":"SSN · object | ITIN · object"},"country_of_citizenship":{"type":"string","description":"ISO 3166-1 alpha-2 country code of citizenship.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0.country_of_citizenship","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.0","typeLabel":"US individual · object"},{"type":"object","title":"Non-US individual","description":"Beneficiary details used to create this account holder. Which shape is returned follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US individual** for any other country, **Business** when `holder_type` is `business`.","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"type":"object","properties":{"type":{"type":"string","enum":["id"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.identification.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","minLength":1,"example":"X1234567","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.identification.value","typeLabel":"string"}},"required":["type","value"],"additionalProperties":false,"description":"Government-issued identification with type: \"id\" (generic government-issued ID).","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.identification","typeLabel":"object"},"country_of_citizenship":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code of citizenship.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1.country_of_citizenship","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.1","typeLabel":"Non-US individual · object"},{"type":"object","title":"Business","description":"Beneficiary details used to create this account holder. Which shape is returned follows `country_of_citizenship`: **US individual** when it is `US`, **Non-US individual** for any other country, **Business** when `holder_type` is `business`.","required":["legal_business_name","doing_business_as","registered_address","physical_address","registration_number","year_of_incorporation","state_of_incorporation","country_of_incorporation","beneficial_owners","control_person"],"properties":{"legal_business_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the business.","example":"Acme Sandbox Ltd.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.legal_business_name","typeLabel":"string"},"doing_business_as":{"oneOf":[{"type":"string","description":"Trade name the business operates under, if different from the legal name.","maxLength":255,"example":"Acme Payments","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.doing_business_as.oneOf.0","typeLabel":"string"},{"type":"null","description":"Trade name the business operates under, if different from the legal name.","maxLength":255,"example":"Acme Payments","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.doing_business_as.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.doing_business_as","typeLabel":"string | null"},"registered_address":{"oneOf":[{"type":"object","title":"US address","description":"Registered legal address of the business. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Registered legal address of the business. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registered_address","typeLabel":"US address · object | Non-US address · object"},"physical_address":{"oneOf":[{"type":"object","title":"US address","description":"Physical operating address of the business. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Physical operating address of the business. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.physical_address","typeLabel":"US address · object | Non-US address · object"},"registration_number":{"oneOf":[{"type":"object","title":"EIN","description":"Business registration number: type \"ein\" (Employer Identification Number, format ##-#######) or \"ssn\" (Social Security Number, format ###-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["ein"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^\\d{2}-\\d{7}$","example":"12-3456789","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.0.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.0","typeLabel":"EIN · object"},{"type":"object","title":"SSN","description":"Business registration number: type \"ein\" (Employer Identification Number, format ##-#######) or \"ssn\" (Social Security Number, format ###-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["ssn"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^\\d{3}-\\d{2}-\\d{4}$","example":"123-45-6789","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.1.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number.oneOf.1","typeLabel":"SSN · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.registration_number","typeLabel":"EIN · object | SSN · object"},"year_of_incorporation":{"type":"integer","minimum":1800,"maximum":3000,"description":"Four-digit year the business was incorporated.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.year_of_incorporation","typeLabel":"integer"},"state_of_incorporation":{"type":"string","minLength":1,"description":"State or subdivision where the business is incorporated.","example":"Delaware","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.state_of_incorporation","typeLabel":"string"},"country_of_incorporation":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code where the business is incorporated.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.country_of_incorporation","typeLabel":"enum\u003cstring>"},"beneficial_owners":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","title":"US individual","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"oneOf":[{"type":"object","title":"SSN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["ssn"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^\\d{3}-\\d{2}-\\d{4}$","example":"123-45-6789","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.0.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.0","typeLabel":"SSN · object"},{"type":"object","title":"ITIN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["itin"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^9\\d{2}-\\d{2}-\\d{4}$","example":"912-34-5678","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.1.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification.oneOf.1","typeLabel":"ITIN · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.identification","typeLabel":"SSN · object | ITIN · object"},"country_of_citizenship":{"type":"string","description":"ISO 3166-1 alpha-2 country code of citizenship.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0.country_of_citizenship","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.0","typeLabel":"US individual · object"},{"type":"object","title":"Non-US individual","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"type":"object","properties":{"type":{"type":"string","enum":["id"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.identification.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","minLength":1,"example":"X1234567","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.identification.value","typeLabel":"string"}},"required":["type","value"],"additionalProperties":false,"description":"Government-issued identification with type: \"id\" (generic government-issued ID).","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.identification","typeLabel":"object"},"country_of_citizenship":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code of citizenship.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1.country_of_citizenship","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX].oneOf.1","typeLabel":"Non-US individual · object"}],"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners.items.[INDEX]","typeLabel":"US individual · object | Non-US individual · object"},"description":"Beneficial owners of the business. At least one required.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.beneficial_owners","typeLabel":"(US individual · object | Non-US individual · object)[]"},"control_person":{"oneOf":[{"type":"object","description":"Individual with primary responsibility for controlling, managing, or directing the business. Follows the same US / non-US split as `beneficiary_data`, based on the control person's own `country_of_citizenship`.","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship","title"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"oneOf":[{"type":"object","title":"SSN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["ssn"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^\\d{3}-\\d{2}-\\d{4}$","example":"123-45-6789","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.0.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.0","typeLabel":"SSN · object"},{"type":"object","title":"ITIN","description":"Government-issued identification with type: \"ssn\" (Social Security Number, format ###-##-####) or \"itin\" (Individual Taxpayer ID, format 9##-##-####).","required":["type","value"],"properties":{"type":{"type":"string","enum":["itin"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","pattern":"^9\\d{2}-\\d{2}-\\d{4}$","example":"912-34-5678","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.1.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification.oneOf.1","typeLabel":"ITIN · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.identification","typeLabel":"SSN · object | ITIN · object"},"country_of_citizenship":{"type":"string","description":"ISO 3166-1 alpha-2 country code of citizenship.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.country_of_citizenship","typeLabel":"enum\u003cstring>"},"title":{"type":"string","minLength":1,"maxLength":255,"description":"Role of the control person at the business (e.g., \"CEO\", \"President\", \"Managing Director\").","example":"CEO","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0.title","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.0","typeLabel":"object"},{"type":"object","description":"Individual with primary responsibility for controlling, managing, or directing the business. Follows the same US / non-US split as `beneficiary_data`, based on the control person's own `country_of_citizenship`.","required":["legal_name","residential_address","date_of_birth","identification","country_of_citizenship","title"],"properties":{"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal name of the account holder.","example":"Jordan Rivera","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.legal_name","typeLabel":"string"},"residential_address":{"oneOf":[{"type":"object","title":"US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"548 Market St","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"San Francisco","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"State, province, or region.","example":"CA","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.state","typeLabel":"string"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"94103","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.postal_code","typeLabel":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.0","typeLabel":"US address · object"},{"type":"object","title":"Non-US address","description":"Residential address of the account holder. **US address** requires `country_code: US` and a two-letter `state`. **Non-US address** accepts any other country and allows `state` to be null.","required":["line_1","line_2","city","state","postal_code","country_code"],"properties":{"line_1":{"type":"string","minLength":1,"maxLength":255,"description":"Primary street address.","example":"Unter den Linden 77","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary street address, or null if not recorded.","maxLength":255,"example":"Apartment 4B","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.line_2","typeLabel":"string | null"},"city":{"type":"string","minLength":1,"maxLength":255,"description":"City or locality.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.city","typeLabel":"string"},"state":{"oneOf":[{"type":"string","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region, or null if not recorded.","example":"Berlin","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.state","typeLabel":"string | null"},"postal_code":{"type":"string","minLength":1,"maxLength":30,"description":"Postal or ZIP code.","example":"10115","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.postal_code","typeLabel":"string"},"country_code":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1.country_code","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address.oneOf.1","typeLabel":"Non-US address · object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.residential_address","typeLabel":"US address · object | Non-US address · object"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).","example":"1990-01-15","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.date_of_birth","typeLabel":"string\u003cdate>"},"identification":{"type":"object","properties":{"type":{"type":"string","enum":["id"],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.identification.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","minLength":1,"example":"X1234567","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.identification.value","typeLabel":"string"}},"required":["type","value"],"additionalProperties":false,"description":"Government-issued identification with type: \"id\" (generic government-issued ID).","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.identification","typeLabel":"object"},"country_of_citizenship":{"type":"string","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","MK","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX","BQ","CW","GG","IM","JE","ME","BL","MF","RS","SX","SS","XK"],"example":"DE","description":"ISO 3166-1 alpha-2 country code of citizenship.","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.country_of_citizenship","typeLabel":"enum\u003cstring>"},"title":{"type":"string","minLength":1,"maxLength":255,"description":"Role of the control person at the business (e.g., \"CEO\", \"President\", \"Managing Director\").","example":"CEO","isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1.title","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2.control_person","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"beneficiary_data.oneOf.2","typeLabel":"Business · object"}],"isRequired":true,"uniqueKey":"beneficiary_data","typeLabel":"US individual · object | Non-US individual · object | Business · object"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500,"uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.","example":{"invoice_id":"INV-2026-0042"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the account holder was created.","example":"2026-01-15T10:30:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"required":["id","type","holder_type","status","beneficiary_data","metadata","created_at"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"id":"68e0a1b2c3d4e5f60718293a","type":"account_holder","beneficiary_data":{"legal_name":"Jordan Rivera","residential_address":{"line_1":"548 Market St","line_2":"Apartment 4B","city":"San Francisco","state":"CA","postal_code":"94103","country_code":"US"},"date_of_birth":"1990-01-15","identification":{"type":"ssn","value":"123-45-6789"},"country_of_citizenship":"US"},"metadata":{"invoice_id":"INV-2026-0042"},"created_at":"2026-01-15T10:30:00Z"}}},"originalFileLocation":"https://api.augustus.com/openapi/2026-05-01.json"},"subdomain":"getivy","siteName":"Augustus Docs","title":"The account holder object - Augustus Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T08:54:05.460Z","originalFileLocation":"v1/objects/account-holder.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The person or business an account is opened for, with the identity details Augustus screens.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Augustus Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The account holder object - Augustus Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The person or business an account is opened for, with the identity details Augustus screens.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Augustus Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.augustus.com/v1/objects/account-holder\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://getivy.mintlify.app/_mintlify/api/og/v2?division=Account+Holders\u0026amp;title=The+account+holder+object\u0026amp;description=The+person+or+business+an+account+is+opened+for%2C+with+the+identity+details+Augustus+screens.\u0026amp;theme=57def4e394075c5f3611700a\u0026amp;signature=fc29ba099df12a16952d3928d31a3537b7c81863c291e27da878abb7680050a0\">\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=\"The account holder object - Augustus Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The person or business an account is opened for, with the identity details Augustus screens.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getivy.mintlify.app/_mintlify/api/og/v2?division=Account+Holders\u0026amp;title=The+account+holder+object\u0026amp;description=The+person+or+business+an+account+is+opened+for%2C+with+the+identity+details+Augustus+screens.\u0026amp;theme=57def4e394075c5f3611700a\u0026amp;signature=fc29ba099df12a16952d3928d31a3537b7c81863c291e27da878abb7680050a0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/getivy/nrpPfWsPZzCJWvyD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Augustus Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0031F5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.augustus.com/v1/objects/account-holder\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/objects/account-holder.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.augustus.com/#organization\",\"name\":\"Augustus Docs\",\"url\":\"https://docs.augustus.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/getivy/oqhoqqx6p7BtjsUH/logo/augustus-logo-dark.svg?fit=max\u0026auto=format\u0026n=oqhoqqx6p7BtjsUH\u0026q=85\u0026s=da91415989d012f863e55f449522f7d0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.augustus.com#website\",\"name\":\"Augustus Docs\",\"url\":\"https://docs.augustus.com\",\"publisher\":{\"@id\":\"https://docs.augustus.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.augustus.com/v1/objects/account-holder#webpage\",\"url\":\"https://docs.augustus.com/v1/objects/account-holder\",\"name\":\"The account holder object\",\"description\":\"The person or business an account is opened for, with the identity details Augustus screens.\",\"dateModified\":\"2026-10-29T08:54:05.460Z\",\"isPartOf\":{\"@id\":\"https://docs.augustus.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.augustus.com/v1/objects/account-holder#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.augustus.com/v1/objects/account-holder#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Augustus Docs\",\"item\":\"https://docs.augustus.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The account holder object\",\"item\":\"https://docs.augustus.com/v1/objects/account-holder\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.augustus.com/v1/objects/account-holder#apireference\",\"headline\":\"The account holder object\",\"name\":\"The account holder object\",\"description\":\"The person or business an account is opened for, with the identity details Augustus screens.\",\"url\":\"https://docs.augustus.com/v1/objects/account-holder\",\"mainEntityOfPage\":{\"@id\":\"https://docs.augustus.com/v1/objects/account-holder#webpage\"},\"dateModified\":\"2026-10-29T08:54:05.460Z\",\"publisher\":{\"@id\":\"https://docs.augustus.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.augustus.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Augustus Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Augustus Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/basics/introduction"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"2026-05-01","icon":"building-columns","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/v1/introduction"},{"title":"Authentication","href":"/v1/authentication"},{"title":"Scopes","href":"/v1/scopes"},{"title":"Versioning","href":"/v1/versioning"},{"title":"Errors","href":"/v1/errors"},{"title":"Idempotency","href":"/v1/idempotency"},{"title":"Pagination","href":"/v1/pagination"},{"title":"Webhooks","href":"/v1/webhooks"},{"title":"Simulations","href":"/v1/simulations"},{"title":"Postman collection","href":"/v1/postman-collection"}]},{"group":"API Access","pages":[{"group":"API Keys","pages":[{"title":"The API key object","href":"/v1/objects/api-key"},{"title":"Introspect current API key","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/api_key","href":"/api-reference/api-key/introspect-current-api-key"},{"title":"List scopes","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/scopes","href":"/api-reference/scopes/list-scopes"}]},{"group":"API Versions","pages":[{"title":"List API versions","description":"Returns the catalogue of publicly available Augustus Banking API versions, ordered oldest to newest. New accounts and unpinned merchants resolve to the entry with `is_latest: true`. Public: no authentication required.","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/api_versions","href":"/api-reference/api-versions/list-api-versions"}]}]},{"group":"Accounts","pages":[{"group":"Account Holders","pages":[{"title":"The account holder object","href":"/v1/objects/account-holder"},{"title":"List account holders","description":"Lists account holders for the merchant with cursor-based pagination.","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/account_holders","href":"/api-reference/account-holders/list-account-holders"},{"title":"Create account holder","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/account_holders","href":"/api-reference/account-holders/create-account-holder"},{"title":"Retrieve account holder","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/account_holders/{id}","href":"/api-reference/account-holders/retrieve-account-holder"},{"title":"Update account holder","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/account_holders/{id}","href":"/api-reference/account-holders/update-account-holder"}]},{"group":"Account Programs","pages":[{"title":"The account program object","href":"/v1/objects/account-program"},{"title":"The account program balance object","href":"/v1/objects/account-program-balance"},{"title":"List account programs","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/account_programs","href":"/api-reference/account-programs/list-account-programs"},{"title":"Retrieve account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/account_programs/{id}","href":"/api-reference/account-programs/retrieve-account-program"},{"title":"Retrieve account program balance","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/account_programs/{id}/balance","href":"/api-reference/account-programs/retrieve-account-program-balance"}]},{"group":"Accounts","pages":[{"title":"The account object","href":"/v1/objects/account"},{"title":"The account balance object","href":"/v1/objects/account-balance"},{"title":"List accounts","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/accounts","href":"/api-reference/accounts/create-account"},{"title":"Retrieve account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/accounts/{id}","href":"/api-reference/accounts/retrieve-account"},{"title":"Retrieve account balance","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/accounts/{id}/balance","href":"/api-reference/accounts/retrieve-account-balance"},{"title":"Freeze account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/accounts/{id}/freeze","href":"/api-reference/accounts/freeze-account"},{"title":"Unfreeze account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/accounts/{id}/unfreeze","href":"/api-reference/accounts/unfreeze-account"},{"title":"Close account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/accounts/{id}/close","href":"/api-reference/accounts/close-account"}]}]},{"group":"Reconciliation","pages":[{"group":"Transactions","pages":[{"title":"The transaction object","href":"/v1/objects/transaction"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Retrieve transaction","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/transactions/{id}","href":"/api-reference/transactions/retrieve-transaction"}]}]},{"group":"Payments","pages":[{"group":"Counterparties","pages":[{"title":"The counterparty object","href":"/v1/objects/counterparty"},{"title":"List counterparties","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/counterparties","href":"/api-reference/counterparties/list-counterparties"},{"title":"Create counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/counterparties","href":"/api-reference/counterparties/create-counterparty"},{"title":"Retrieve counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/counterparties/{id}","href":"/api-reference/counterparties/retrieve-counterparty"},{"title":"Update counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/counterparties/{id}","href":"/api-reference/counterparties/update-counterparty"},{"title":"Activate counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/counterparties/{id}/activate","href":"/api-reference/counterparties/activate-counterparty"}]},{"group":"Payouts","pages":[{"title":"The payout object","href":"/v1/objects/payout"},{"title":"List payouts","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Create payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/payouts","href":"/api-reference/payouts/create-payout"},{"title":"Retrieve payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/payouts/{id}","href":"/api-reference/payouts/retrieve-payout"}]},{"group":"Payout Tracking Events","pages":[{"title":"The payout tracking event object","href":"/v1/objects/payout-tracking-event"},{"title":"List payout tracking events","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/payout_tracking_events","href":"/api-reference/payout-tracking-events/list-payout-tracking-events"},{"title":"Retrieve payout tracking event","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/payout_tracking_events/{id}","href":"/api-reference/payout-tracking-events/retrieve-payout-tracking-event"}]},{"group":"Deposits","pages":[{"title":"The deposit object","href":"/v1/objects/deposit"},{"title":"List deposits","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/deposits","href":"/api-reference/deposits/list-deposits"},{"title":"Retrieve deposit","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/deposits/{id}","href":"/api-reference/deposits/retrieve-deposit"}]},{"group":"Returns","pages":[{"title":"The return object","href":"/v1/objects/return"},{"title":"List returns","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Create return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/returns","href":"/api-reference/returns/create-return"},{"title":"Retrieve return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/returns/{id}","href":"/api-reference/returns/retrieve-return"}]}]},{"group":"Conversions","pages":[{"group":"Quotes","pages":[{"title":"Get indicative quote","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/quotes/indicative","href":"/api-reference/quotes/get-indicative-quote"}]},{"group":"Conversions","pages":[{"title":"The conversion object","href":"/v1/objects/conversion"},{"title":"List conversions","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/conversions","href":"/api-reference/conversions/list-conversions"},{"title":"Create conversion","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/conversions","href":"/api-reference/conversions/create-conversion"},{"title":"Retrieve conversion","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/conversions/{id}","href":"/api-reference/conversions/retrieve-conversion"}]}]},{"group":"Webhooks","pages":[{"group":"Webhook Events","pages":[{"title":"payout.initiated","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout.initiated","href":"/v1/webhook-events/payout-initiated"},{"title":"payout.submitted","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout.submitted","href":"/v1/webhook-events/payout-submitted"},{"title":"payout.sent","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout.sent","href":"/v1/webhook-events/payout-sent"},{"title":"payout.failed","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout.failed","href":"/v1/webhook-events/payout-failed"},{"title":"payout.returned","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout.returned","href":"/v1/webhook-events/payout-returned"},{"title":"payout_tracking_event.created","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook payout_tracking_event.created","href":"/v1/webhook-events/payout-tracking-event-created"},{"title":"return.initiated","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook return.initiated","href":"/v1/webhook-events/return-initiated"},{"title":"return.submitted","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook return.submitted","href":"/v1/webhook-events/return-submitted"},{"title":"return.sent","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook return.sent","href":"/v1/webhook-events/return-sent"},{"title":"return.failed","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook return.failed","href":"/v1/webhook-events/return-failed"},{"title":"return.returned","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook return.returned","href":"/v1/webhook-events/return-returned"},{"title":"deposit.settled","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook deposit.settled","href":"/v1/webhook-events/deposit-settled"},{"title":"conversion.created","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook conversion.created","href":"/v1/webhook-events/conversion-created"},{"title":"conversion.completed","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook conversion.completed","href":"/v1/webhook-events/conversion-completed"},{"title":"conversion.failed","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook conversion.failed","href":"/v1/webhook-events/conversion-failed"},{"title":"account_holder.active","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook account_holder.active","href":"/v1/webhook-events/account-holder-active"},{"title":"account_holder.closed","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook account_holder.closed","href":"/v1/webhook-events/account-holder-closed"},{"title":"counterparty.updated","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.updated","href":"/v1/webhook-events/counterparty-updated"},{"title":"counterparty.pending","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.pending","href":"/v1/webhook-events/counterparty-pending"},{"title":"counterparty.active","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.active","href":"/v1/webhook-events/counterparty-active"},{"title":"counterparty.rejected","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.rejected","href":"/v1/webhook-events/counterparty-rejected"},{"title":"counterparty.blocked","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.blocked","href":"/v1/webhook-events/counterparty-blocked"},{"title":"counterparty.unblocked","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook counterparty.unblocked","href":"/v1/webhook-events/counterparty-unblocked"},{"title":"ping.test","openapi":"https://api.augustus.com/openapi/2026-05-01.json webhook ping.test","href":"/v1/webhook-events/ping-test"}]},{"group":"Webhook Subscriptions","pages":[{"title":"The webhook subscription object","href":"/v1/objects/webhook-subscription"},{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/webhook_subscriptions","href":"/api-reference/webhook-subscriptions/list-webhook-subscriptions"},{"title":"Create webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/webhook_subscriptions","href":"/api-reference/webhook-subscriptions/create-webhook-subscription"},{"title":"Retrieve webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/webhook_subscriptions/{id}","href":"/api-reference/webhook-subscriptions/retrieve-webhook-subscription"},{"title":"Update webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/webhook_subscriptions/{id}","href":"/api-reference/webhook-subscriptions/update-webhook-subscription"},{"title":"Delete webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json delete /v1/webhook_subscriptions/{id}","href":"/api-reference/webhook-subscriptions/delete-webhook-subscription"},{"title":"Send test event","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/webhook_subscriptions/{id}/send_test_event","href":"/api-reference/webhook-subscriptions/send-test-event"}]},{"group":"Webhook Deliveries","pages":[{"title":"The webhook delivery object","href":"/v1/objects/webhook-delivery"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/webhook_deliveries","href":"/api-reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Retrieve webhook delivery","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/webhook_deliveries/{id}","href":"/api-reference/webhook-deliveries/retrieve-webhook-delivery"},{"title":"Redeliver webhook","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/webhook_deliveries/{id}/redeliver","href":"/api-reference/webhook-deliveries/redeliver-webhook"}]},{"group":"Events","pages":[{"title":"The event object","href":"/v1/objects/event"},{"title":"List events","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/events","href":"/api-reference/events/list-events"},{"title":"Retrieve event","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json get /v1/events/{id}","href":"/api-reference/events/retrieve-event"}]}]},{"group":"Sandbox Simulations","pages":[{"group":"Deposits","pages":[{"title":"Simulate an incoming deposit","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/deposits","href":"/api-reference/simulations/simulate-an-incoming-deposit"}]},{"group":"Payouts","pages":[{"title":"Send a payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/payouts/{id}/send","href":"/api-reference/simulations/send-a-payout"},{"title":"Reject a payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/payouts/{id}/reject","href":"/api-reference/simulations/reject-a-payout"},{"title":"Return a settled payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/payouts/{id}/return","href":"/api-reference/simulations/return-a-settled-payout"}]},{"group":"Returns","pages":[{"title":"Send a return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/returns/{id}/send","href":"/api-reference/simulations/send-a-return"},{"title":"Reject a return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/returns/{id}/reject","href":"/api-reference/simulations/reject-a-return"},{"title":"Return a sent return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/returns/{id}/return","href":"/api-reference/simulations/return-a-sent-return"}]},{"group":"Counterparties","pages":[{"title":"Reject a counterparty verification","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/counterparties/{id}/reject","href":"/api-reference/simulations/reject-a-counterparty-verification"}]},{"group":"Conversions","pages":[{"title":"Complete a controlled conversion","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/conversions/{id}/complete","href":"/api-reference/simulations/complete-a-controlled-conversion"},{"title":"Fail a controlled conversion","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/conversions/{id}/fail","href":"/api-reference/simulations/fail-a-controlled-conversion"}]},{"group":"Accounts","pages":[{"title":"Create an account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/accounts","href":"/api-reference/simulations/create-an-account"},{"title":"Freeze an operating account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/accounts/{id}/freeze","href":"/api-reference/simulations/freeze-an-operating-account"},{"title":"Unfreeze an operating account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/accounts/{id}/unfreeze","href":"/api-reference/simulations/unfreeze-an-operating-account"},{"title":"Drain an operating account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/accounts/{id}/drain","href":"/api-reference/simulations/drain-an-operating-account"},{"title":"Close an operating account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/accounts/{id}/close","href":"/api-reference/simulations/close-an-operating-account"}]},{"group":"Account Programs","pages":[{"title":"Create an account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/account_programs","href":"/api-reference/simulations/create-an-account-program"},{"title":"Freeze an account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/account_programs/{id}/freeze","href":"/api-reference/simulations/freeze-an-account-program"},{"title":"Unfreeze an account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/account_programs/{id}/unfreeze","href":"/api-reference/simulations/unfreeze-an-account-program"},{"title":"Drain an account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/account_programs/{id}/drain","href":"/api-reference/simulations/drain-an-account-program"},{"title":"Close an account program","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2026-05-01.json post /v1/simulations/account_programs/{id}/close","href":"/api-reference/simulations/close-an-account-program"}]}]}]},{"dropdown":"2023-01-01 (Ivy)","icon":"credit-card","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/reference/introduction"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Versioning","href":"/reference/api-versions"},{"title":"Metadata","href":"/reference/metadata"},{"title":"Idempotency","href":"/reference/idempotency"},{"title":"Errors","href":"/reference/errors"}]},{"group":"Pay by Bank","pages":[{"title":"Instant Bank Transfer","href":"/docs/pay-by-bank/instant-bank-transfer"},{"title":"Manual Bank Transfer","href":"/docs/pay-by-bank/manual-bank-transfer"},{"title":"Settlements","href":"/docs/pay-by-bank/settlements"},{"title":"Refunds","href":"/docs/pay-by-bank/refunds"}]},{"group":"REST API","pages":[{"group":"Bank","pages":[{"title":"Search a Bank","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/banks/search","href":"/api-reference/bank/search-a-bank"},{"title":"List Banks","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/banks/list","href":"/api-reference/bank/list-banks"},{"title":"Retrieve a Bank","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/banks/details","href":"/api-reference/bank/retrieve-a-bank"}]},{"group":"Banking","pages":[{"title":"Retrieve Account Balance","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/balance/retrieve","href":"/api-reference/banking/retrieve-account-balance"}]},{"group":"Capabilities","pages":[{"title":"Retrieve your Capabilities","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/merchant/capabilities/details","href":"/api-reference/capabilities/retrieve-your-capabilities"}]},{"group":"Checkout","pages":[{"title":"Create a Checkout Session","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/checkout/session/create","href":"/api-reference/checkout/create-a-checkout-session"},{"title":"Expire a Checkout Session","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/checkout/session/expire","href":"/api-reference/checkout/expire-a-checkout-session"},{"title":"Retrieve a Checkout Session","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/checkout/session/details","href":"/api-reference/checkout/retrieve-a-checkout-session"}]},{"group":"Counterparty","pages":[{"title":"Create a counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/create","href":"/api-reference/counterparty/create-a-counterparty"},{"title":"Retrieve a counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/retrieve","href":"/api-reference/counterparty/retrieve-a-counterparty"},{"title":"List counterparties","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/list","href":"/api-reference/counterparty/list-counterparties"},{"title":"Update a counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/update","href":"/api-reference/counterparty/update-a-counterparty"},{"title":"Activate a counterparty","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/activate","href":"/api-reference/counterparty/activate-a-counterparty"}]},{"group":"Customer","pages":[{"title":"Create a Customer","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/customer/create","href":"/api-reference/customer/create-a-customer"},{"title":"Retrieve a Customer","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/customer/retrieve","href":"/api-reference/customer/retrieve-a-customer"},{"title":"Search Customers","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/customer/search","href":"/api-reference/customer/search-customers"},{"title":"Delete a Customer","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/customer/delete","href":"/api-reference/customer/delete-a-customer"},{"title":"Update a Customer","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/customer/update","href":"/api-reference/customer/update-a-customer"}]},{"group":"Deposit","pages":[{"title":"Retrieve a deposit","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/deposit/retrieve","href":"/api-reference/deposit/retrieve-a-deposit"}]},{"group":"Order","pages":[{"title":"Retrieve an Order","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/order/details","href":"/api-reference/order/retrieve-an-order"},{"title":"Create an Order","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/order/create","href":"/api-reference/order/create-an-order"},{"title":"Expire an Order","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/order/expire","href":"/api-reference/order/expire-an-order"}]},{"group":"Payout","pages":[{"title":"Payout available balances","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/beneficiary-payout/create","href":"/api-reference/payout/payout-available-balances"},{"title":"Retrieve a payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/payout/retrieve","href":"/api-reference/payout/retrieve-a-payout"},{"title":"List payouts","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/payout/list","href":"/api-reference/payout/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/payout/create","href":"/api-reference/payout/create-a-payout"}]},{"group":"Refund","pages":[{"title":"Create a refund","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/refund/create","href":"/api-reference/refund/create-a-refund"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/refund/retrieve","href":"/api-reference/refund/retrieve-a-refund"}]},{"group":"Return","pages":[{"title":"Retrieve a return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/return/retrieve","href":"/api-reference/return/retrieve-a-return"},{"title":"Create a return","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/return/create","href":"/api-reference/return/create-a-return"}]},{"group":"Subaccount","pages":[{"title":"Retrieve a Subaccount","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/subaccount/retrieve","href":"/api-reference/subaccount/retrieve-a-subaccount"},{"title":"Create a Subaccount","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/subaccount/create","href":"/api-reference/subaccount/create-a-subaccount"}]},{"group":"Transactions","pages":[{"title":"List transaction history","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/transaction/list","href":"/api-reference/transactions/list-transaction-history"}]},{"group":"VoP","pages":[{"title":"Verify payee bank account","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/payee/verify","href":"/api-reference/vop/verify-payee-bank-account"}]},{"group":"Webhook","pages":[{"title":"Trigger a specific webhook","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook/trigger","href":"/api-reference/webhook/trigger-a-specific-webhook"}]},{"group":"Webhook-Subscription","pages":[{"title":"Ping a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook-subscription/ping","href":"/api-reference/webhook-subscription/ping-a-webhook-subscription"},{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook-subscription/list","href":"/api-reference/webhook-subscription/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook-subscription/create","href":"/api-reference/webhook-subscription/create-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook-subscription/delete","href":"/api-reference/webhook-subscription/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/2023-01-01.json post /api/service/webhook-subscription/update","href":"/api-reference/webhook-subscription/update-a-webhook-subscription"}]}]},{"group":"Webhook Events","pages":[{"group":"WebhookEventExamples","pages":[{"title":"Test","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/test","href":"/api-reference/webhookeventexamples/test"},{"title":"order_created","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/order_created","href":"/api-reference/webhookeventexamples/order_created"},{"title":"order_updated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/order_updated","href":"/api-reference/webhookeventexamples/order_updated"},{"title":"refund.initiated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/refund.initiated","href":"/api-reference/webhookeventexamples/refundinitiated"},{"title":"refund.succeeded","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/refund.succeeded","href":"/api-reference/webhookeventexamples/refundsucceeded"},{"title":"refund.failed","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/refund.failed","href":"/api-reference/webhookeventexamples/refundfailed"},{"title":"checkout_session_created","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/checkout_session_created","href":"/api-reference/webhookeventexamples/checkout_session_created"},{"title":"checkout_session_updated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/checkout_session_updated","href":"/api-reference/webhookeventexamples/checkout_session_updated"},{"title":"checkout_session_expired","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/checkout_session_expired","href":"/api-reference/webhookeventexamples/checkout_session_expired"},{"title":"checkout_session_completed","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/checkout_session_completed","href":"/api-reference/webhookeventexamples/checkout_session_completed"},{"title":"payout.initiated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout.initiated","href":"/api-reference/webhookeventexamples/payoutinitiated"},{"title":"payout.paid","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout.paid","href":"/api-reference/webhookeventexamples/payoutpaid"},{"title":"payout.failed","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout.failed","href":"/api-reference/webhookeventexamples/payoutfailed"},{"title":"deposit.received","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/deposit.received","href":"/api-reference/webhookeventexamples/depositreceived"},{"title":"fx.initiated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/fx.initiated","href":"/api-reference/webhookeventexamples/fxinitiated"},{"title":"fx.succeeded","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/fx.succeeded","href":"/api-reference/webhookeventexamples/fxsucceeded"},{"title":"fx.failed","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/fx.failed","href":"/api-reference/webhookeventexamples/fxfailed"},{"title":"return.initiated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/return.initiated","href":"/api-reference/webhookeventexamples/returninitiated"},{"title":"return.succeeded","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/return.succeeded","href":"/api-reference/webhookeventexamples/returnsucceeded"},{"title":"return.failed","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/return.failed","href":"/api-reference/webhookeventexamples/returnfailed"},{"title":"return.returned","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/return.returned","href":"/api-reference/webhookeventexamples/returnreturned"},{"title":"counterparty.updated","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.updated","href":"/api-reference/webhookeventexamples/counterpartyupdated"},{"title":"counterparty.pending","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.pending","href":"/api-reference/webhookeventexamples/counterpartypending"},{"title":"counterparty.active","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.active","href":"/api-reference/webhookeventexamples/counterpartyactive"},{"title":"counterparty.rejected","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.rejected","href":"/api-reference/webhookeventexamples/counterpartyrejected"},{"title":"counterparty.blocked","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.blocked","href":"/api-reference/webhookeventexamples/counterpartyblocked"},{"title":"counterparty.unblocked","deprecated":null,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/counterparty.unblocked","href":"/api-reference/webhookeventexamples/counterpartyunblocked"},{"title":"merchant_updated","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/merchant_updated","href":"/api-reference/webhookeventexamples/merchant_updated"},{"title":"refund_succeeded","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/refund_succeeded","href":"/api-reference/webhookeventexamples/refund_succeeded"},{"title":"refund_failed","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/refund_failed","href":"/api-reference/webhookeventexamples/refund_failed"},{"title":"user_payout.initiated","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/user_payout.initiated","href":"/api-reference/webhookeventexamples/user_payoutinitiated"},{"title":"user_payout.paid","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/user_payout.paid","href":"/api-reference/webhookeventexamples/user_payoutpaid"},{"title":"user_payout.failed","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/user_payout.failed","href":"/api-reference/webhookeventexamples/user_payoutfailed"},{"title":"payout_report_requested","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout_report_requested","href":"/api-reference/webhookeventexamples/payout_report_requested"},{"title":"payout_created","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout_created","href":"/api-reference/webhookeventexamples/payout_created"},{"title":"payout_updated","deprecated":true,"version":null,"openapi":"https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/payout_updated","href":"/api-reference/webhookeventexamples/payout_updated"}]}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/webhook-getting-started/introduction"},{"title":"Authentication","href":"/webhook-getting-started/authentication"}]}]}]}]},"title":"The account holder object - Augustus Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}