{
"code": "customer/onboarding-v3-managed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "This customer cannot be used with this route.",
"status": 409
}
{
"code": "customer/onboarding-v3-managed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "This customer cannot be used with this route.",
"status": 409
}
Upload an identity document for a customer or business representative as part of the KYC or KYB verification process. Documents are submitted as multipart form data. Accepted file formats are PDF, JPEG, and PNG, validated by file signature rather than extension. Maximum file size is 10 MB per file, or 8 MB for identity documents (passport, drivers, id_card, residence_permit, br_digital_drivers, br_digital_id). The target and documentType fields determine how SpherePay routes and processes the upload — individual customers, business customers, and business representatives each have their own set of accepted document types.
Documents for individual customers are uploaded with target: "customer". Documents for business representatives (UBOs) use target: "business_representative" and the targetId must be the representative’s ID, not the customer’s.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
ID Document
Other Document
Business
ID Document
Other Document
Transfer
Upload identity documents for individual customers. Requires country of issuance and optionally the document side (front/back).
country
string
required
The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA). See Country Codes.
Example:
"USA"
documentType
enum<string>
required
ID documents for individual customers. See Document Guideline for requirements.
Available options:
passport,
drivers,
id_card,
residence_permit,
br_digital_drivers,
br_digital_id
Example:
"passport"
file
file
required
The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.
target
enum<string>
required
The target entity for which the document is being uploaded
Available options:
customer
Example:
"customer"
targetId
string
required
The unique identifier of the target entity for which the document is being uploaded
Minimum string length: 1
Example:
"customer_66c4168d418a410eae282b83883bdc39"
description
string
Optional description or notes about the document
Example:
"Front side of driver's license"
side
enum<string>
The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.
Available options:
front,
back
Example:
"front"
Response
ID Document
Other Document
Business Customer Document
ID Document
Other Document
Transfer
Response for an ID document uploaded for an individual customer.
country
string
required
The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA)
Example:
"USA"
createdAt
string
required
The date and time the document was created
Example:
"2025-12-31T10:30:00.000Z"
description
string
required
The description of the document
Example:
"Passport photo page"
documentType
enum<string>
required
The type of the document
Available options:
drivers,
passport,
id_card,
residence_permit,
br_digital_drivers,
br_digital_id
Example:
"passport"
fileName
string
required
The name of the document file
Example:
"passport_front_20250101.pdf"
fileSize
number
required
The size of the document in bytes
Example:
2048576
id
string
required
The unique identifier of the document
Example:
"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
mimeType
string
required
The MIME type of the document file
Example:
"application/pdf"
side
enum<string>
required
The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.
Available options:
front,
back
Example:
"front"
target
enum<string>
required
The target entity for which the document is being uploaded
Available options:
customer
Example:
"customer"
targetId
string
required
The unique identifier of the target entity for which the document is being uploaded
Example:
"customer_66c4168d418a410eae282b83883bdc39"
Last modified on August 19, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SpherePay","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/spherepayco/uywNRH6jm1-R-nPL/logo/sphere-light.svg?fit=max\u0026auto=format\u0026n=uywNRH6jm1-R-nPL\u0026q=85\u0026s=783c82452519d50b023b9866c8a1ba48","dark":"https://mintcdn.com/spherepayco/uywNRH6jm1-R-nPL/logo/sphere-dark.svg?fit=max\u0026auto=format\u0026n=uywNRH6jm1-R-nPL\u0026q=85\u0026s=841362b62b2d8a0da3d2b69d22c62d88"},"favicon":"https://mintcdn.com/spherepayco/a4WF4v5_QYD1dXam/favicon.png?fit=max\u0026auto=format\u0026n=a4WF4v5_QYD1dXam\u0026q=85\u0026s=b3c29639701db7176e6ac8f2b03f68a7","api":{"playground":{"display":"none"}},"navbar":{"primary":{"type":"button","label":"Sphere Dashboard ↗","href":"https://spherepay.co/dashboard"}},"icons":{"library":"lucide"},"styling":{"codeblocks":"dark","latex":true},"metadata":{"timestamp":true},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"es","href":"es/introduction"},{"language":"pt-BR","href":"pt-BR/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spherepayco","hasAudioNarration":false,"actualSubdomain":"spherepayco","customDomains":["docs.spherepay.co"],"gitSource":{"type":"github","owner":"sphere-laboratories","repo":"mintlify-docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb548f102c05d39eace92b","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"en","tag":"API Reference","count":56},{"language":"es","tag":"Referencia de la API","count":56},{"language":"pt-BR","tag":"Referência da API","count":56},{"language":"en","tag":"Concepts","count":30},{"language":"es","tag":"Conceptos","count":30},{"language":"pt-BR","tag":"Conceitos","count":30},{"language":"en","tag":"Onboarding","count":27},{"language":"es","tag":"Incorporación","count":27},{"language":"pt-BR","tag":"Onboarding","count":27},{"language":"en","tag":"Money movement","count":24},{"language":"es","tag":"Movimiento de dinero","count":24},{"language":"pt-BR","tag":"Movimentação de dinheiro","count":24},{"language":"en","tag":"Webhooks","count":13},{"language":"es","tag":"Webhooks","count":13},{"language":"pt-BR","tag":"Webhooks","count":13},{"language":"en","tag":"Accounts","count":9},{"language":"en","tag":"Transfers","count":9},{"language":"en","tag":"Get Started","count":9},{"language":"es","tag":"Cuentas","count":9},{"language":"es","tag":"Transferencias","count":9},{"language":"es","tag":"Comenzar","count":9},{"language":"pt-BR","tag":"Contas","count":9},{"language":"pt-BR","tag":"Transferências","count":9},{"language":"pt-BR","tag":"Começar","count":9},{"language":"en","tag":"Virtual Accounts","count":7},{"language":"es","tag":"Cuentas Virtuales","count":7},{"language":"pt-BR","tag":"Contas Virtuais","count":7},{"language":"en","tag":"Documents \u0026 Verification","count":6},{"language":"es","tag":"Documentos y Verificación","count":6},{"language":"pt-BR","tag":"Documentos e Verificação","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@spherepay.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6a02974593b34b4b8541d063","deploymentId":"69f39b63abf2e25489b5290d","questionText":"What currencies are supported?","status":"active","generatedBy":"manual","createdAt":"2026-05-12T02:58:13.452Z","updatedAt":"2026-05-12T02:58:13.452Z","__v":0},{"_id":"6a02973893b34b4b8541d023","deploymentId":"69f39b63abf2e25489b5290d","questionText":"How do I create a transfer?","status":"active","generatedBy":"manual","createdAt":"2026-05-12T02:58:00.452Z","updatedAt":"2026-05-12T02:58:00.452Z","__v":0},{"_id":"6a02972c93b34b4b8541cfef","deploymentId":"69f39b63abf2e25489b5290d","questionText":"How do I onboard a business?","status":"active","generatedBy":"manual","createdAt":"2026-05-12T02:57:48.946Z","updatedAt":"2026-05-12T02:57:48.946Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"update-tag\"]{padding:2px 8px;border:1px solid var(--gray-200, #e5e7eb);background:transparent;color:var(--gray-600, #4b5563);font-size:0.6875rem;font-weight:600;letter-spacing:0.04em;text-transform:uppercase;border-radius:4px;line-height:1.4}.dark [data-component-part=\"update-tag\"]{border-color:var(--gray-700, #374151);color:var(--gray-300, #d1d5db)}[data-component-part=\"update-tag-list\"]{margin-top:0.5rem;gap:0.375rem}nav[class*=\"navbar\"] ul li a.link{border-radius:0!important;background:transparent!important;border-bottom:2px solid transparent;transition:border-color 120ms ease, color 120ms ease}nav[class*=\"navbar\"] ul li a.link:hover{background:transparent!important;color:#18181b!important;border-bottom-color:rgba(37, 99, 235, 0.4)}.dark nav[class*=\"navbar\"] ul li a.link:hover{color:#60A5FA!important;border-bottom-color:rgba(96, 165, 250, 0.4)}nav[class*=\"navbar\"] ul li a.link[aria-current=\"page\"]{background:transparent!important;border-bottom-color:var(--mintlify-primary, #2563EB);color:#18181b!important}.dark nav[class*=\"navbar\"] ul li a.link[aria-current=\"page\"]{color:#fafafa!important;border-bottom-color:#60A5FA}nav[class*=\"navbar\"][class*=\"justify-center\"]{justify-content:flex-start!important}button:has(>div>svg.lucide-search){width:auto!important;min-width:220px;padding-left:14px!important;padding-right:12px!important;justify-content:space-between!important}button:has(>div>svg.lucide-search) .truncate.min-w-0{display:block!important}a[href=\"https://spherepay.co/dashboard\"] span[class*=\"bg-primary-dark\"]{border-radius:6px!important;background-color:#2970FF!important;transition:background-color 120ms ease}a[href=\"https://spherepay.co/dashboard\"]:hover span[class*=\"bg-primary-dark\"]{background-color:#155EEF!important;opacity:1!important}a[href=\"https://spherepay.co/dashboard\"] svg{display:none!important}[data-component-part=\"card-icon\"]{width:44px!important;height:44px!important;display:flex!important;align-items:center;justify-content:center;background:rgba(209, 224, 255, 0.5);border-radius:10px;margin-bottom:1rem}.dark [data-component-part=\"card-icon\"]{background:rgba(96, 165, 250, 0.15)}ul.space-y-px:has(>li>a[href*=\"/api-reference/\"]):not(:has(ul)){margin-left:24px;padding-left:4px;border-left:1.5px solid #E5E7EB}ul.space-y-px:has(>li>a[href*=\"/api-reference/\"]):not(:has(ul)) a[href*=\"/api-reference/\"]{padding-left:16px!important}.dark ul.space-y-px:has(>li>a[href*=\"/api-reference/\"]):not(:has(ul)){border-left-color:rgba(255, 255, 255, 0.12)}#sidebar button[aria-expanded]>div:has(>svg[viewBox=\"0 -9 3 24\"]){margin-left:auto}#sidebar:has(a[href*=\"/api-reference/\"]){border-right:1px solid #E5E7EB}.dark #sidebar:has(a[href*=\"/api-reference/\"]){border-right-color:rgba(255, 255, 255, 0.1)}.sidebar-group-icon{display:none!important}#navbar-transition{border-bottom-color:#E5E7EB!important}@media (min-width: 1024px){#navbar-transition::after{content:\"\";position:absolute;left:0;right:0;top:64px;height:1px;background:#E5E7EB;pointer-events:none}}#navbar .flex-1{border-bottom-color:transparent!important}.dark #navbar-transition{border-bottom-color:rgba(255, 255, 255, 0.1)!important}.dark #navbar-transition::after{background:rgba(255, 255, 255, 0.1)}"}],"page":{"pagePath":"api-reference/document/post","slug":"/api-reference/document/post","pageMetadata":{"title":"Upload KYC and KYB Identity Documents","sidebarTitle":"Upload Document","openapi":"openapi/spherepay.yaml POST /v2/document","description":"Upload a document for a customer.","href":"/api-reference/document/post"},"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: \"Upload a document for a customer.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Upload an identity document for a customer or business representative as part of the KYC or KYB verification process. Documents are submitted as multipart form data. Accepted file formats are PDF, JPEG, and PNG, validated by file signature rather than extension. Maximum file size is 10 MB per file, or 8 MB for identity documents (`,_jsx(_components.code,{children:`passport`}),`, `,_jsx(_components.code,{children:`drivers`}),`, `,_jsx(_components.code,{children:`id_card`}),`, `,_jsx(_components.code,{children:`residence_permit`}),`, `,_jsx(_components.code,{children:`br_digital_drivers`}),`, `,_jsx(_components.code,{children:`br_digital_id`}),`). The `,_jsx(_components.code,{children:`target`}),` and `,_jsx(_components.code,{children:`documentType`}),` fields determine how SpherePay routes and processes the upload — individual customers, business customers, and business representatives each have their own set of accepted document types.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Documents for individual customers are uploaded with `,_jsx(_components.code,{children:`target: \"customer\"`}),`. Documents for business representatives (UBOs) use `,_jsx(_components.code,{children:`target: \"business_representative\"`}),` and the `,_jsx(_components.code,{children:`targetId`}),` must be the representative’s ID, not the customer’s.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Upload KYC and KYB Identity Documents","sidebarTitle":"Upload Document","openapi":"openapi/spherepay.yaml POST /v2/document","description":"Upload a document for a customer.","href":"/api-reference/document/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/spherepayco/27b80abc67bf6551/snippets/demoAppUrl.js"],"openApiReferenceData":{"operation":{"description":"Upload a document for a customer.","operationId":"postV2Document","parameters":[],"requestBody":"067a64ea-0a06-4d03-b7b4-d90c849cafd9","responses":{"201":"ba4f08f0-4a5f-4dbe-bdbb-b7759f7e1fc4","400":"9477d0e3-1479-4547-b3cd-9be4906e30dd","404":"69cc63b5-2ac5-4e26-ac96-195e685ac91b","409":"fff6528c-6570-4ac1-beb4-7021de056967","422":"ba9397c1-61ac-49fe-8875-eb49e8eec947"},"summary":"Upload Document","method":"post","type":"path","servers":["4cfe9135-ea06-4da5-aceb-a7fd710f8dd7","555a21b5-fc66-4e5f-842f-dedad3cc9816"],"security":["d2c5e951-bc5c-4c0e-9398-d81153991947"],"path":"/v2/document","baseUrlOptions":["https://api.spherepay.co","https://api.sandbox.spherepay.co"],"title":"Upload Document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"multipart/form-data":{"schema":{"oneOf":[{"type":"object","title":"ID Document","description":"Upload identity documents for individual customers. Requires country of issuance and optionally the document side (front/back).","required":["targetId","file","country","target","documentType"],"example":{"country":"USA","description":"Passport photo page","documentType":"passport","file":"(binary)","side":"front","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"country":{"description":"The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA). See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","isRequired":true,"uniqueKey":"oneOf.0.country","typeLabel":"string"},"documentType":{"description":"ID documents for individual customers. See [Document Guideline](/concepts/onboarding/identification-types) for requirements.","enum":["passport","drivers","id_card","residence_permit","br_digital_drivers","br_digital_id"],"example":"passport","type":"string","isRequired":true,"uniqueKey":"oneOf.0.documentType","typeLabel":"enum\u003cstring>"},"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.0.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.0.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.targetId","typeLabel":"string"},"description":{"description":"Optional description or notes about the document","example":"Front side of driver's license","type":"string","uniqueKey":"oneOf.0.description","typeLabel":"string"},"side":{"description":"The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.","enum":["front","back"],"example":"front","type":"string","uniqueKey":"oneOf.0.side","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0","typeLabel":"ID Document · object"},{"type":"object","title":"Other Document","description":"Upload non-ID documents for individual customers, such as liveness report, tax forms, or source-of-funds documentation.","required":["targetId","file","target","documentType"],"example":{"description":"Passport photo page","documentType":"passport","file":"(binary)","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"documentType":{"description":"Non-ID documents for individual customers.","enum":["proof_of_address_document","liveness_report_document","w8_ben_document","source_of_funds_document"],"example":"proof_of_address_document","type":"string","isRequired":true,"uniqueKey":"oneOf.1.documentType","typeLabel":"enum\u003cstring>"},"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.1.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.1.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.targetId","typeLabel":"string"},"description":{"description":"Optional description or notes about the document","example":"Front side of driver's license","type":"string","uniqueKey":"oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"Other Document · object"},{"type":"object","title":"Business","description":"Upload company documents for business customers, such as incorporation certificates, shareholder registries, or proof of address.","required":["targetId","file","target","documentType"],"example":{"description":"Certificate of incorporation","documentType":"incorporation_cert_document","file":"(binary)","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"documentType":{"description":"Company documents for business customers. See [Business Document Guideline](/concepts/onboarding/identification-types) for requirements.","enum":["proof_of_address_document","incorporation_cert_document","incorporation_articles_document","shareholder_registry_document","directors_registry_document","w8_ben_e_document","corporate_resolution_document","bank_statement_document","financial_statements_document","source_of_funds_document","regulated_activity_document","flow_of_funds_document","proof_of_nature_of_business_document"],"example":"incorporation_cert_document","type":"string","isRequired":true,"uniqueKey":"oneOf.2.documentType","typeLabel":"enum\u003cstring>"},"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.2.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.2.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.targetId","typeLabel":"string"},"description":{"description":"Optional description or notes about the document","example":"Front side of driver's license","type":"string","uniqueKey":"oneOf.2.description","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"Business · object"},{"type":"object","title":"ID Document","description":"Upload an ID document for a business representative.","required":["targetId","file","country","target","documentType"],"example":{"country":"USA","description":"Passport photo page","documentType":"passport","file":"(binary)","side":"front","target":"business_representative","targetId":"business_representative_66c4168d418a410eae282b83883bdc39"},"properties":{"country":{"description":"The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA). See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","isRequired":true,"uniqueKey":"oneOf.3.country","typeLabel":"string"},"documentType":{"description":"ID documents for business representatives. See [Document Guideline](/concepts/onboarding/identification-types) for requirements.","enum":["passport","drivers","id_card","residence_permit","br_digital_drivers","br_digital_id"],"example":"passport","type":"string","isRequired":true,"uniqueKey":"oneOf.3.documentType","typeLabel":"enum\u003cstring>"},"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.3.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["business_representative"],"example":"business_representative","type":"string","isRequired":true,"uniqueKey":"oneOf.3.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.targetId","typeLabel":"string"},"description":{"description":"Optional description or notes about the document","example":"Front side of driver's license","type":"string","uniqueKey":"oneOf.3.description","typeLabel":"string"},"side":{"description":"The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.","enum":["front","back"],"example":"front","type":"string","uniqueKey":"oneOf.3.side","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3","typeLabel":"ID Document · object"},{"type":"object","title":"Other Document","description":"Upload other documents for business representatives.","required":["targetId","file","target","documentType"],"example":{"description":"Passport photo page","documentType":"passport","file":"(binary)","target":"business_representative","targetId":"business_representative_66c4168d418a410eae282b83883bdc39"},"properties":{"documentType":{"description":"Other documents for business representatives.","enum":["proof_of_address_document","liveness_report_document","w9_document","w8_ben_document","source_of_funds_document"],"example":"proof_of_address_document","type":"string","isRequired":true,"uniqueKey":"oneOf.4.documentType","typeLabel":"enum\u003cstring>"},"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.4.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["business_representative"],"example":"business_representative","type":"string","isRequired":true,"uniqueKey":"oneOf.4.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.4.targetId","typeLabel":"string"},"description":{"description":"Optional description or notes about the document","example":"Front side of driver's license","type":"string","uniqueKey":"oneOf.4.description","typeLabel":"string"}},"uniqueKey":"oneOf.4","typeLabel":"Other Document · object"},{"type":"object","title":"Transfer","description":"Upload supporting documents for transfers/payouts (e.g., invoices, contracts). Documents are uploaded first before linking to a transfer later.","required":["target","file"],"example":{"description":"Invoice for third-party payment","file":"(binary)","target":"transfer"},"properties":{"file":{"description":"The document file to upload. Accepted formats: PDF, JPEG, PNG. Maximum file size: 8MB. Minimum file size: 10KB.","format":"binary","type":"string","isRequired":true,"uniqueKey":"oneOf.5.file","typeLabel":"file"},"target":{"description":"The target entity for which the document is being uploaded","enum":["transfer"],"example":"transfer","type":"string","isRequired":true,"uniqueKey":"oneOf.5.target","typeLabel":"enum\u003cstring>"},"description":{"description":"Optional description or notes about the document","example":"Invoice for third-party payment","type":"string","uniqueKey":"oneOf.5.description","typeLabel":"string"}},"uniqueKey":"oneOf.5","typeLabel":"Transfer · object"}],"uniqueKey":"","typeLabel":"ID Document · object · Other Document · object · Business · object · ID Document · object · Other Document · object · Transfer · object"},"examples":{"Example":{"title":"Example","value":{"country":"USA","description":"Passport photo page","documentType":"passport","file":"(binary)","side":"front","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"ba4f08f0-4a5f-4dbe-bdbb-b7759f7e1fc4":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ID Document","description":"Response for an ID document uploaded for an individual customer.","required":["id","targetId","createdAt","fileName","fileSize","mimeType","description","target","documentType","country","side"],"example":{"country":"USA","createdAt":"2025-12-31T10:30:00.000Z","description":"Passport photo page","documentType":"passport","fileName":"passport_front_20250101.pdf","fileSize":2048576,"id":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","mimeType":"application/pdf","side":"front","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"country":{"description":"The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA)","example":"USA","type":"string","isRequired":true,"uniqueKey":"oneOf.0.country","typeLabel":"string"},"createdAt":{"description":"The date and time the document was created","example":"2025-12-31T10:30:00.000Z","type":"string","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string"},"description":{"description":"The description of the document","example":"Passport photo page","type":"string","isRequired":true,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"documentType":{"description":"The type of the document","enum":["drivers","passport","id_card","residence_permit","br_digital_drivers","br_digital_id"],"example":"passport","type":"string","isRequired":true,"uniqueKey":"oneOf.0.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"description":"The name of the document file","example":"passport_front_20250101.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.0.fileName","typeLabel":"string"},"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the document","example":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.0.mimeType","typeLabel":"string"},"side":{"description":"The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.","enum":["front","back"],"example":"front","type":"string","isRequired":true,"uniqueKey":"oneOf.0.side","typeLabel":"enum\u003cstring>"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.0.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","type":"string","isRequired":true,"uniqueKey":"oneOf.0.targetId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"ID Document · object"},{"type":"object","title":"Other Document","description":"Response for a non-identity individual-customer document: proof_of_address_document, liveness_report_document, w8_ben_document, or source_of_funds_document.","required":["id","targetId","createdAt","fileName","fileSize","mimeType","description","target","documentType","country","side"],"example":{"country":"USA","createdAt":"2025-12-31T10:30:00.000Z","description":"Passport photo page","documentType":"passport","fileName":"passport_front_20250101.pdf","fileSize":2048576,"id":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","mimeType":"application/pdf","side":"front","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"country":{"description":"Country associated with the document when one was resolved for the upload","example":"DEU","type":"string","isRequired":true,"uniqueKey":"oneOf.1.country","typeLabel":"string"},"createdAt":{"description":"The date and time the document was created","example":"2025-12-31T10:30:00.000Z","type":"string","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string"},"description":{"description":"The description of the document","example":"Passport photo page","type":"string","isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"documentType":{"description":"Non-ID document type (liveness report, tax form, or source-of-funds declaration)","enum":["passport","drivers","id_card","residence_permit","br_digital_drivers","br_digital_id","proof_of_address_document","liveness_report_document","w8_ben_document","source_of_funds_document"],"example":"proof_of_address_document","type":"string","isRequired":true,"uniqueKey":"oneOf.1.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"description":"The name of the document file","example":"passport_front_20250101.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.1.fileName","typeLabel":"string"},"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the document","example":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.1.mimeType","typeLabel":"string"},"side":{"description":"Document side, if applicable","enum":["front","back"],"example":null,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.side","typeLabel":"enum\u003cstring>"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.1.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","type":"string","isRequired":true,"uniqueKey":"oneOf.1.targetId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"Other Document · object"},{"type":"object","title":"Business Customer Document","description":"Response containing an uploaded company document for a business customer.","required":["id","targetId","createdAt","fileName","fileSize","mimeType","description","target","documentType"],"example":{"createdAt":"2025-12-31T10:30:00.000Z","description":"Certificate of incorporation","documentType":"incorporation_cert_document","fileName":"incorporation_cert.pdf","fileSize":1024000,"id":"documentFile_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7","mimeType":"application/pdf","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"},"properties":{"createdAt":{"description":"The date and time the document was created","example":"2025-12-31T10:30:00.000Z","type":"string","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string"},"description":{"description":"The description of the document","example":"Passport photo page","type":"string","isRequired":true,"uniqueKey":"oneOf.2.description","typeLabel":"string"},"documentType":{"description":"The type of the document","enum":["proof_of_address_document","incorporation_cert_document","incorporation_articles_document","shareholder_registry_document","directors_registry_document","w8_ben_e_document","corporate_resolution_document","bank_statement_document","financial_statements_document","source_of_funds_document","regulated_activity_document","flow_of_funds_document","proof_of_nature_of_business_document"],"example":"incorporation_cert_document","type":"string","isRequired":true,"uniqueKey":"oneOf.2.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"description":"The name of the document file","example":"passport_front_20250101.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.2.fileName","typeLabel":"string"},"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.2.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the document","example":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.2.mimeType","typeLabel":"string"},"target":{"description":"The target entity for which the document is being uploaded","enum":["customer"],"example":"customer","type":"string","isRequired":true,"uniqueKey":"oneOf.2.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","type":"string","isRequired":true,"uniqueKey":"oneOf.2.targetId","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"Business Customer Document · object"},{"type":"object","title":"ID Document","description":"Response for an ID document uploaded for a business representative.","required":["id","targetId","createdAt","fileName","fileSize","mimeType","description","target","documentType","country","side"],"example":{"country":"USA","createdAt":"2025-12-31T10:30:00.000Z","description":"Passport photo page","documentType":"passport","fileName":"passport_front_20250101.pdf","fileSize":2048576,"id":"documentFile_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8","mimeType":"application/pdf","side":"front","target":"business_representative","targetId":"business_representative_66c4168d418a410eae282b83883bdc39"},"properties":{"country":{"description":"The ISO3166-1 Alpha-3 country code associated with the document (e.g., USA, GBR, FRA)","example":"USA","type":"string","isRequired":true,"uniqueKey":"oneOf.3.country","typeLabel":"string"},"createdAt":{"description":"The date and time the document was created","example":"2025-12-31T10:30:00.000Z","type":"string","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string"},"description":{"description":"The description of the document","example":"Passport photo page","type":"string","isRequired":true,"uniqueKey":"oneOf.3.description","typeLabel":"string"},"documentType":{"description":"The type of the document","enum":["drivers","passport","id_card","residence_permit","br_digital_drivers","br_digital_id"],"example":"passport","type":"string","isRequired":true,"uniqueKey":"oneOf.3.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"description":"The name of the document file","example":"passport_front_20250101.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.3.fileName","typeLabel":"string"},"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.3.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the document","example":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.3.mimeType","typeLabel":"string"},"side":{"description":"The side of the document if it has multiple sides (e.g., front, back). Leave undefined for single-sided documents.","enum":["front","back"],"example":"front","type":"string","isRequired":true,"uniqueKey":"oneOf.3.side","typeLabel":"enum\u003cstring>"},"target":{"enum":["business_representative"],"type":"string","isRequired":true,"uniqueKey":"oneOf.3.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","type":"string","isRequired":true,"uniqueKey":"oneOf.3.targetId","typeLabel":"string"}},"uniqueKey":"oneOf.3","typeLabel":"ID Document · object"},{"type":"object","title":"Other Document","description":"Response for other documents uploaded for business representatives.","required":["id","targetId","createdAt","fileName","fileSize","mimeType","description","target","documentType"],"example":{"createdAt":"2025-12-31T10:30:00.000Z","description":"Passport photo page","documentType":"passport","fileName":"passport_front_20250101.pdf","fileSize":2048576,"id":"documentFile_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8","mimeType":"application/pdf","target":"business_representative","targetId":"business_representative_66c4168d418a410eae282b83883bdc39"},"properties":{"createdAt":{"description":"The date and time the document was created","example":"2025-12-31T10:30:00.000Z","type":"string","isRequired":true,"uniqueKey":"oneOf.4.createdAt","typeLabel":"string"},"description":{"description":"The description of the document","example":"Passport photo page","type":"string","isRequired":true,"uniqueKey":"oneOf.4.description","typeLabel":"string"},"documentType":{"description":"The type of the document","enum":["passport","drivers","id_card","residence_permit","br_digital_drivers","br_digital_id","proof_of_address_document","liveness_report_document","w9_document","w8_ben_document","source_of_funds_document"],"example":"proof_of_address_document","type":"string","isRequired":true,"uniqueKey":"oneOf.4.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"description":"The name of the document file","example":"passport_front_20250101.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.4.fileName","typeLabel":"string"},"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.4.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the document","example":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.4.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.4.mimeType","typeLabel":"string"},"target":{"description":"The target entity for which the document is being uploaded","enum":["business_representative"],"example":"business_representative","type":"string","isRequired":true,"uniqueKey":"oneOf.4.target","typeLabel":"enum\u003cstring>"},"targetId":{"description":"The unique identifier of the target entity for which the document is being uploaded","example":"customer_66c4168d418a410eae282b83883bdc39","type":"string","isRequired":true,"uniqueKey":"oneOf.4.targetId","typeLabel":"string"}},"uniqueKey":"oneOf.4","typeLabel":"Other Document · object"},{"type":"object","title":"Transfer","description":"Response for a supporting document uploaded for a transfer.","required":["target","id","originalFilename","mimeType","fileSize","uploadedAt"],"example":{"fileSize":2048576,"id":"document_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","mimeType":"application/pdf","originalFilename":"invoice_2025.pdf","target":"transfer","uploadedAt":"2025-12-31T10:30:00.000Z"},"properties":{"fileSize":{"description":"The size of the document in bytes","example":2048576,"type":"number","isRequired":true,"uniqueKey":"oneOf.5.fileSize","typeLabel":"number"},"id":{"description":"The unique identifier of the uploaded document","example":"document_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","type":"string","isRequired":true,"uniqueKey":"oneOf.5.id","typeLabel":"string"},"mimeType":{"description":"The MIME type of the document file","example":"application/pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.5.mimeType","typeLabel":"string"},"originalFilename":{"description":"The original filename of the uploaded document","example":"invoice_2025.pdf","type":"string","isRequired":true,"uniqueKey":"oneOf.5.originalFilename","typeLabel":"string"},"target":{"description":"The target entity for which the document was uploaded","enum":["transfer"],"example":"transfer","type":"string","isRequired":true,"uniqueKey":"oneOf.5.target","typeLabel":"enum\u003cstring>"},"uploadedAt":{"oneOf":[{"type":"string","description":"The date and time the document was uploaded","example":"2025-12-31T10:30:00.000Z","isRequired":true,"uniqueKey":"oneOf.5.uploadedAt.oneOf.0","typeLabel":"string"},{"description":"The date and time the document was uploaded","example":"2025-12-31T10:30:00.000Z","isRequired":true,"uniqueKey":"oneOf.5.uploadedAt.oneOf.1","typeLabel":"any"}],"isRequired":true,"uniqueKey":"oneOf.5.uploadedAt","typeLabel":"string | any"}},"uniqueKey":"oneOf.5","typeLabel":"Transfer · object"}],"uniqueKey":"","typeLabel":"ID Document · object · Other Document · object · Business Customer Document · object · ID Document · object · Other Document · object · Transfer · object"},"examples":{"Example":{"title":"Example","value":{"country":"USA","createdAt":"2025-12-31T10:30:00.000Z","description":"Passport photo page","documentType":"passport","fileName":"passport_front_20250101.pdf","fileSize":2048576,"id":"documentFile_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","mimeType":"application/pdf","side":"front","target":"customer","targetId":"customer_66c4168d418a410eae282b83883bdc39"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"9477d0e3-1479-4547-b3cd-9be4906e30dd":{"content":{"application/json":{"examples":{"Bad Request":{"title":"Bad Request","summary":"Bad Request","value":{"code":"address/invalid","correlationId":"28c61e885c6e5eaa78c1a2183a9b883c","detail":"Invalid request parameters","status":400}}},"schema":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"correlationId":{"type":"string","uniqueKey":"correlationId","typeLabel":"string"},"errors":{"items":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"header":{"type":"string","uniqueKey":"errors.items.[INDEX].header","typeLabel":"string"},"parameter":{"type":"string","uniqueKey":"errors.items.[INDEX].parameter","typeLabel":"string"},"pointer":{"type":"string","uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"required":["status","detail"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Bad Request","exampleType":"examples"},"69cc63b5-2ac5-4e26-ac96-195e685ac91b":{"content":{"application/json":{"examples":{"Not Found":{"title":"Not Found","summary":"Not Found","value":{"code":"resource/not-found","correlationId":"28c61e885c6e5eaa78c1a2183a9b883c","detail":"Resource not found","status":404}}},"schema":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"correlationId":{"type":"string","uniqueKey":"correlationId","typeLabel":"string"},"errors":{"items":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"header":{"type":"string","uniqueKey":"errors.items.[INDEX].header","typeLabel":"string"},"parameter":{"type":"string","uniqueKey":"errors.items.[INDEX].parameter","typeLabel":"string"},"pointer":{"type":"string","uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"required":["status","detail"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Not Found","exampleType":"examples"},"fff6528c-6570-4ac1-beb4-7021de056967":{"content":{"application/json":{"examples":{"Customer not available on this route":{"title":"Customer not available on this route","summary":"Customer not available on this route","value":{"code":"customer/onboarding-v3-managed","correlationId":"28c61e885c6e5eaa78c1a2183a9b883c","detail":"This customer cannot be used with this route.","status":409}}},"schema":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"correlationId":{"type":"string","uniqueKey":"correlationId","typeLabel":"string"},"errors":{"items":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"header":{"type":"string","uniqueKey":"errors.items.[INDEX].header","typeLabel":"string"},"parameter":{"type":"string","uniqueKey":"errors.items.[INDEX].parameter","typeLabel":"string"},"pointer":{"type":"string","uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"required":["status","detail"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Conflict - the customer cannot be used with this route","exampleType":"examples"},"ba9397c1-61ac-49fe-8875-eb49e8eec947":{"content":{"application/json":{"examples":{"Validation Error":{"title":"Validation Error","summary":"Validation Error","value":{"code":"validation/failed","correlationId":"28c61e885c6e5eaa78c1a2183a9b883c","detail":"Validation failed","errors":[{"detail":"Invalid email format","pointer":"/email"},{"detail":"Name is required","pointer":"/name"}],"status":422}}},"schema":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"correlationId":{"type":"string","uniqueKey":"correlationId","typeLabel":"string"},"errors":{"items":{"properties":{"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"header":{"type":"string","uniqueKey":"errors.items.[INDEX].header","typeLabel":"string"},"parameter":{"type":"string","uniqueKey":"errors.items.[INDEX].parameter","typeLabel":"string"},"pointer":{"type":"string","uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"required":["status","detail"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Unprocessable Entity - Validation Error","exampleType":"examples"}},"security":{"d2c5e951-bc5c-4c0e-9398-d81153991947":{"bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{"4cfe9135-ea06-4da5-aceb-a7fd710f8dd7":{"description":"Production","url":"https://api.spherepay.co"},"555a21b5-fc66-4e5f-842f-dedad3cc9816":{"description":"Sandbox","url":"https://api.sandbox.spherepay.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi/spherepay.yaml"},"subdomain":"spherepayco","siteName":"SpherePay","title":"Upload KYC and KYB Identity Documents - SpherePay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/document/post","matchLevel":0},"es":{"href":"/es/api-reference/document/post","matchLevel":1},"pt-BR":{"href":"/pt-BR/api-reference/document/post","matchLevel":1}}},"lastModified":"2026-08-19T23:08:53.574Z","gitLastModified":"2026-08-19T23:08:21.000Z","originalFileLocation":"api-reference/document/post.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Upload a document for a customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SpherePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_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/spherepayco/MOEcmEf1ysLzlDTM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Upload KYC and KYB Identity Documents - SpherePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload a document for a customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SpherePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spherepay.co/api-reference/document/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spherepayco.mintlify.site/_mintlify/api/og/v2?division=Documents+%26+Verification\u0026amp;title=Upload+KYC+and+KYB+Identity+Documents\u0026amp;description=Upload+a+document+for+a+customer.\u0026amp;theme=eda2cafc957c45d3c16031d8\u0026amp;signature=6828abd3d87504d3b6a41b8ac4d40548cfba60701daa8a12febacb0e1eefed76\">\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=\"Upload KYC and KYB Identity Documents - SpherePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload a document for a customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spherepayco.mintlify.site/_mintlify/api/og/v2?division=Documents+%26+Verification\u0026amp;title=Upload+KYC+and+KYB+Identity+Documents\u0026amp;description=Upload+a+document+for+a+customer.\u0026amp;theme=eda2cafc957c45d3c16031d8\u0026amp;signature=6828abd3d87504d3b6a41b8ac4d40548cfba60701daa8a12febacb0e1eefed76\">\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/spherepayco/MOEcmEf1ysLzlDTM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SpherePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spherepay.co/api-reference/document/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/document/post.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.spherepay.co/api-reference/document/post\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.spherepay.co/es/api-reference/document/post\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.spherepay.co/pt-BR/api-reference/document/post\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.spherepay.co/api-reference/document/post\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spherepay.co/#organization\",\"name\":\"SpherePay\",\"url\":\"https://docs.spherepay.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spherepayco/uywNRH6jm1-R-nPL/logo/sphere-light.svg?fit=max\u0026auto=format\u0026n=uywNRH6jm1-R-nPL\u0026q=85\u0026s=783c82452519d50b023b9866c8a1ba48\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spherepay.co#website\",\"name\":\"SpherePay\",\"url\":\"https://docs.spherepay.co\",\"publisher\":{\"@id\":\"https://docs.spherepay.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spherepay.co/api-reference/document/post#webpage\",\"url\":\"https://docs.spherepay.co/api-reference/document/post\",\"name\":\"Upload KYC and KYB Identity Documents\",\"description\":\"Upload a document for a customer.\",\"dateModified\":\"2026-08-19T23:08:21.000Z\",\"isPartOf\":{\"@id\":\"https://docs.spherepay.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spherepay.co/api-reference/document/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spherepay.co/api-reference/document/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding\",\"item\":\"https://docs.spherepay.co/api-reference/customer/post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Upload KYC and KYB Identity Documents\",\"item\":\"https://docs.spherepay.co/api-reference/document/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spherepay.co/api-reference/document/post#apireference\",\"headline\":\"Upload KYC and KYB Identity Documents\",\"name\":\"Upload KYC and KYB Identity Documents\",\"description\":\"Upload a document for a customer.\",\"url\":\"https://docs.spherepay.co/api-reference/document/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spherepay.co/api-reference/document/post#webpage\"},\"dateModified\":\"2026-08-19T23:08:21.000Z\",\"publisher\":{\"@id\":\"https://docs.spherepay.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spherepay.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SpherePay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SpherePay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/document/post.md","siteName":"SpherePay","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/introduction"}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/implementation-guides/overview"}]},{"tab":"Solutions","pages":[{"title":"Solutions","href":"/solutions/overview"}]},{"tab":"API Reference","groups":[{"group":"Onboarding","pages":[{"group":"Customers","icon":"user","pages":[{"title":"Create an Individual or Business Customer","sidebarTitle":"Create Customer","openapi":"openapi/spherepay.yaml POST /v2/customer","href":"/api-reference/customer/post"},{"title":"List Customers with Filters and Pagination","sidebarTitle":"List Customers","openapi":"openapi/spherepay.yaml GET /v2/customer","href":"/api-reference/customer/get"},{"title":"Retrieve a Customer with Verification Status","sidebarTitle":"Get Customer","openapi":"openapi/spherepay.yaml GET /v2/customer/{id}","href":"/api-reference/customer/get-id"},{"title":"Update Customer Address, Phone, or Email","sidebarTitle":"Update Customer","openapi":"openapi/spherepay.yaml PATCH /v2/customer/{id}","href":"/api-reference/customer/patch-id"}]},{"group":"Onboarding Links","icon":"link","pages":[{"title":"Create Customer via Link","sidebarTitle":"Create Customer via Link","openapi":"openapi/spherepay.yaml POST /v2/customer/kyc-link","href":"/api-reference/customer/kyc-link"},{"title":"Regenerate a Customer's KYC Link","sidebarTitle":"Regenerate KYC Link","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/kyc-link","description":"Regenerate a hosted KYC link for an existing customer. Only customers created via the onboarding link flow are supported. Supplying `enabledVerificationProfiles` **updates the customer**: the narrowing is persisted before the link is minted, so the hosted questionnaire and the profiles the customer is evaluated against cannot diverge.","href":"/api-reference/customer/kyc"}]},{"group":"Documents \u0026 Verification","icon":"file-check","pages":[{"title":"Upload KYC and KYB Identity Documents","sidebarTitle":"Upload Document","openapi":"openapi/spherepay.yaml POST /v2/document","href":"/api-reference/document/post"},{"title":"Generate a Customer Face Verification Link","sidebarTitle":"Face Verification Link","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/face-verification-link","description":"Generate a face verification link for a customer.","href":"/api-reference/enhanced-due-diligence/face-verification-link"},{"title":"Generate a UBO Face Verification Link for KYB","sidebarTitle":"UBO Face Verification Link","openapi":"openapi/spherepay.yaml POST /v2/business-representative/{id}/face-verification-link","href":"/api-reference/enhanced-due-diligence/ubo-face-verification-link"},{"title":"Send an OTP Code for Customer Verification","sidebarTitle":"Send Verification Code","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/otp-send","href":"/api-reference/enhanced-due-diligence/send-verification-code"},{"title":"Verify a Customer OTP Code for Email or Phone","sidebarTitle":"Verify OTP Code","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/otp-verify","href":"/api-reference/enhanced-due-diligence/verify-verification-code"},{"title":"Record Customer Terms of Service Acceptance","sidebarTitle":"Accept Terms of Service","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/tos-link","href":"/api-reference/enhanced-due-diligence/tos"}]},{"group":"Business Representatives","icon":"users","pages":[{"title":"Register a Business UBO for KYB Verification","sidebarTitle":"Register Representative","openapi":"openapi/spherepay.yaml POST /v2/business-representative","href":"/api-reference/business-representative/post"},{"title":"List All Business Representatives and UBOs","sidebarTitle":"List Representatives","openapi":"openapi/spherepay.yaml GET /v2/business-representative","href":"/api-reference/business-representative/get"},{"title":"Retrieve a Business Representative by ID","sidebarTitle":"Get Representative","openapi":"openapi/spherepay.yaml GET /v2/business-representative/{id}","href":"/api-reference/business-representative/get-id"},{"title":"Update a Business Representative Before KYB","sidebarTitle":"Update Representative","openapi":"openapi/spherepay.yaml PATCH /v2/business-representative/{id}","href":"/api-reference/business-representative/patch-id"},{"title":"Remove a Business Representative or UBO","sidebarTitle":"Delete Representative","openapi":"openapi/spherepay.yaml DELETE /v2/business-representative/{id}","href":"/api-reference/business-representative/delete-id"}]}]},{"group":"Accounts","pages":[{"group":"Bank Accounts","icon":"landmark","pages":[{"title":"Register a Customer Bank Account for Transfers","sidebarTitle":"Register Bank Account","openapi":"openapi/spherepay.yaml POST /v2/bank-account","href":"/api-reference/bank-account/post"},{"title":"List All Registered Customer Bank Accounts","sidebarTitle":"List Bank Accounts","openapi":"openapi/spherepay.yaml GET /v2/bank-account","href":"/api-reference/bank-account/get"},{"title":"Retrieve a Bank Account by ID","sidebarTitle":"Get Bank Account","openapi":"openapi/spherepay.yaml GET /v2/bank-account/{id}","href":"/api-reference/bank-account/get-id"},{"title":"Update Bank Account Payment Rail Settings","sidebarTitle":"Update Bank Account","openapi":"openapi/spherepay.yaml PATCH /v2/bank-account/{id}","href":"/api-reference/bank-account/patch-id"},{"title":"Delete a Registered Customer Bank Account","sidebarTitle":"Delete Bank Account","openapi":"openapi/spherepay.yaml DELETE /v2/bank-account/{id}","href":"/api-reference/bank-account/delete-id"}]},{"group":"Wallets","icon":"wallet","pages":[{"title":"Register a Customer Crypto Wallet for Transfers","sidebarTitle":"Register Wallet","openapi":"openapi/spherepay.yaml POST /v2/wallet","href":"/api-reference/wallet/post"},{"title":"List All Registered Customer Crypto Wallets","sidebarTitle":"List Wallets","openapi":"openapi/spherepay.yaml GET /v2/wallet","href":"/api-reference/wallet/get"},{"title":"Retrieve a Customer Crypto Wallet by ID","sidebarTitle":"Get Wallet","openapi":"openapi/spherepay.yaml GET /v2/wallet/{id}","href":"/api-reference/wallet/get-id"},{"title":"Remove a Registered Customer Crypto Wallet","sidebarTitle":"Delete Wallet","openapi":"openapi/spherepay.yaml DELETE /v2/wallet/{id}","href":"/api-reference/wallet/delete-id"}]}]},{"group":"Money movement","pages":[{"group":"Transfers","icon":"arrow-right-left","pages":[{"title":"Create an On-Ramp or Off-Ramp Transfer","sidebarTitle":"Create Transfer","openapi":"openapi/spherepay.yaml POST /v2/transfer","href":"/api-reference/transfer/post"},{"title":"List On-Ramp and Off-Ramp Transfers","sidebarTitle":"List Transfers","openapi":"openapi/spherepay.yaml GET /v2/transfer","href":"/api-reference/transfer/get"},{"title":"Retrieve a Transfer with Deposit Instructions","sidebarTitle":"Get Transfer","openapi":"openapi/spherepay.yaml GET /v2/transfer/{id}","href":"/api-reference/transfer/get-id"},{"title":"Cancel an Unfunded Pending Transfer","sidebarTitle":"Cancel Transfer","openapi":"openapi/spherepay.yaml DELETE /v2/transfer/{id}","href":"/api-reference/transfer/delete-id"}]},{"group":"Quotes","icon":"calculator","pages":[{"title":"Create a Rate-Locked Quote","sidebarTitle":"Create Quote","openapi":"openapi/spherepay.yaml POST /v2/quote","href":"/api-reference/quote/post"},{"title":"List All Rate-Locked Quotes for Your Account","sidebarTitle":"List Quotes","openapi":"openapi/spherepay.yaml GET /v2/quote","href":"/api-reference/quote/get"},{"title":"Retrieve a Quote by ID","sidebarTitle":"Get Quote","openapi":"openapi/spherepay.yaml GET /v2/quote/{id}","href":"/api-reference/quote/get-id"},{"title":"Update Quote Status","sidebarTitle":"Update Quote","openapi":"openapi/spherepay.yaml PUT /v2/quote/{id}","href":"/api-reference/quote/put-id"}]},{"group":"Virtual Accounts","icon":"credit-card","pages":[{"title":"Create a Virtual Bank Account for Fiat On-Ramp","sidebarTitle":"Create Virtual Account","openapi":"openapi/spherepay.yaml POST /v2/virtual-account","href":"/api-reference/virtual-account/post"},{"title":"List All Onramper Virtual Bank Accounts","sidebarTitle":"List Virtual Accounts","openapi":"openapi/spherepay.yaml GET /v2/virtual-account","href":"/api-reference/virtual-account/get"},{"title":"Retrieve an Onramper Account by ID","sidebarTitle":"Get Virtual Account","openapi":"openapi/spherepay.yaml GET /v2/virtual-account/{virtualAccountId}","href":"/api-reference/virtual-account/get-id"},{"title":"Update an Onramper Account Destination Wallet","sidebarTitle":"Update Virtual Account","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}","href":"/api-reference/virtual-account/patch"},{"title":"List Transfers for an Onramper Account","sidebarTitle":"List Account Transfers","openapi":"openapi/spherepay.yaml GET /v2/virtual-account/{virtualAccountId}/transfer","href":"/api-reference/virtual-account/list-transfers"},{"title":"Deactivate an Onramper Virtual Bank Account","sidebarTitle":"Deactivate Account","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}/deactivate","href":"/api-reference/virtual-account/deactivate"},{"title":"Reactivate a Deactivated Onramper Account","sidebarTitle":"Reactivate Account","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}/reactivate","href":"/api-reference/virtual-account/reactivate"}]},{"group":"Offloader Wallets","icon":"arrow-up-from-line","pages":[{"title":"Create an Offloader Wallet for Crypto Payouts","sidebarTitle":"Create Offloader Wallet","openapi":"openapi/spherepay.yaml POST /v2/offloader-wallet","href":"/api-reference/offloader-wallet/post"},{"title":"List All Offloader Wallets for Your Account","sidebarTitle":"List Offloader Wallets","openapi":"openapi/spherepay.yaml GET /v2/offloader-wallet","href":"/api-reference/offloader-wallet/get"},{"title":"Retrieve an Offloader Wallet by ID","sidebarTitle":"Get Offloader Wallet","openapi":"openapi/spherepay.yaml GET /v2/offloader-wallet/{id}","href":"/api-reference/offloader-wallet/get-id"},{"title":"Update an Offloader Wallet Bank Destination","sidebarTitle":"Update Offloader Wallet","openapi":"openapi/spherepay.yaml PATCH /v2/offloader-wallet/{id}","href":"/api-reference/offloader-wallet/patch-id"}]}]},{"group":"Webhooks","pages":[{"group":"Webhook Endpoints","icon":"plug","pages":[{"title":"Register a Webhook Endpoint for Event Delivery","sidebarTitle":"Create Webhook Endpoint","openapi":"openapi/spherepay.yaml POST /v2/webhook-endpoints","href":"/api-reference/webhook-endpoints/post"},{"title":"List All Registered Webhook Endpoints","sidebarTitle":"List Webhook Endpoints","openapi":"openapi/spherepay.yaml GET /v2/webhook-endpoints","href":"/api-reference/webhook-endpoints/get"},{"title":"Retrieve a Webhook Endpoint by ID","sidebarTitle":"Get Webhook Endpoint","openapi":"openapi/spherepay.yaml GET /v2/webhook-endpoints/{id}","href":"/api-reference/webhook-endpoints/get-id"},{"title":"Delete a Webhook Endpoint","sidebarTitle":"Delete Webhook Endpoint","openapi":"openapi/spherepay.yaml DELETE /v2/webhook-endpoints/{id}","href":"/api-reference/webhook-endpoints/delete-id"}]},{"group":"Events","icon":"bell","pages":[{"title":"List Events and Their Delivery Status","sidebarTitle":"List Events","openapi":"openapi/spherepay.yaml GET /v2/events","href":"/api-reference/events/get"},{"title":"Retrieve an Event with Full Delivery History","sidebarTitle":"Get Event","openapi":"openapi/spherepay.yaml GET /v2/events/{id}","href":"/api-reference/events/get-id"},{"title":"Replay a Failed Event Delivery","sidebarTitle":"Replay Delivery","openapi":"openapi/spherepay.yaml POST /v2/events/replay/{eventDeliveryId}","href":"/api-reference/events/replay"}]}]},{"group":"Sandbox Simulation","pages":[{"title":"Advance a Sandbox Customer","sidebarTitle":"Advance Customer","openapi":"openapi/spherepay.yaml POST /v2/sandbox/customer/{id}/advance","href":"/api-reference/sandbox/customer-advance"},{"title":"Advance a Sandbox Transfer","sidebarTitle":"Advance Transfer","openapi":"openapi/spherepay.yaml POST /v2/sandbox/transfer/{id}/advance","href":"/api-reference/sandbox/transfer-advance"},{"title":"Mint Test Tokens","sidebarTitle":"Mint Test Tokens","openapi":"openapi/spherepay.yaml POST /v2/sandbox/faucet","href":"/api-reference/sandbox/faucet-post"},{"title":"Retrieve a Test Token Mint","sidebarTitle":"Get Mint","openapi":"openapi/spherepay.yaml GET /v2/sandbox/faucet/{id}","href":"/api-reference/sandbox/faucet-get-id"}]}]},{"tab":"Releases","pages":[{"title":"Releases","href":"/changelog"}]},{"tab":"FAQ","href":"https://spherepay-knowledge-base.help.usepylon.com/"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/document/post"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/api-reference/document/post"}]}]},"basePath":"","title":"Upload KYC and KYB Identity Documents - SpherePay","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}