{
"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
}
Use este endpoint para buscar os detalhes completos de um único cliente pelo seu ID único. A resposta inclui o status atual do perfil de verificação do cliente, que indica exatamente quais critérios de KYC/KYB permanecem pendentes antes que o cliente possa iniciar uma transferência. Você também pode inspecionar contas bancárias e carteiras vinculadas por meio deste registro.
Autorizações
Authorization
string
header
obrigatório
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de caminho
id
string
obrigatório
Customer ID
Exemplo:
"customer_f31121c389624d3697cbf3ea8830b7a4"
Resposta
Individual
Business
Response containing information about an individual customer.
createdAt
string
obrigatório
ISO 8601 formatted customer creation timestamp
Exemplo:
"2026-03-09T20:46:31.305Z"
enabledVerificationProfiles
enum<string>[] | null
obrigatório
Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from verificationProfiles, which reports the evaluated profiles and their statuses.
Opções disponíveis:
a,
b,
c,
d
Exemplo:
["a", "c"]
id
string
obrigatório
Customer ID
Exemplo:
"customer_f31121c389624d3697cbf3ea8830b7a4"
tosStatus
enum<string>
obrigatório
Customer Terms of Service acceptance status (incomplete | pending | approved).
Opções disponíveis:
incomplete,
pending,
approved
Exemplo:
"incomplete"
type
enum<string>
obrigatório
Customer type
Opções disponíveis:
individual
Exemplo:
"individual"
updatedAt
string
obrigatório
ISO 8601 formatted customer update timestamp
Exemplo:
"2026-03-09T20:46:31.305Z"
verificationProfiles
object[]
obrigatório
The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to enabledVerificationProfiles, which says which families they are permitted to use. Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See KYC Flow for individuals or KYB Flow for businesses. See Verification Profile for individual status definitions and criteria breakdown or Verification Profile for business status definitions and criteria breakdown.
The customer's date of birth in YYYY-MM-DD format (individual customers only).
Exemplo:
"1990-01-15"
email
string
Customer email address
Exemplo:
"jane.smith@example.com"
firstName
string
Customer first name (individual customers only)
Exemplo:
"Jane"
lastName
string
Customer last name (individual customers only)
Exemplo:
"Smith"
meta
object
Show child attributes
personalInformation
object
Personal information for an individual customer, echoed back from the most recent submission. The tax identification number is omitted from responses for privacy.
Show child attributes
phone
string
Customer phone number
Exemplo:
"+14155550123"
statusDetails
object
Additional context on why the customer's verification reached its current status.
Show child attributes
Exemplo:
{ "message": "Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.", "reasons": [ { "externalReason": "Cannot validate ID — upload a photo of the ID that is clear", "reasonCode": "poor_image_quality", "verificationProfiles": ["kyb_profile_a"] }, { "externalReason": "The tax identification number is not in a valid format for the selected country and ID type.", "reasonCode": "invalid_tax_identification_number", "verificationProfiles": ["kyb_profile_a"] } ], "updatedAt": "2026-07-16T21:04:00Z" }
Última modificação em 22 de junho de 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":"6ae4e40af8344a2328cd117d","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"API Reference","count":52},{"language":"es","tag":"Referencia de la API","count":52},{"language":"pt-BR","tag":"Referência da API","count":52},{"language":"en","tag":"Concepts","count":29},{"language":"es","tag":"Conceptos","count":29},{"language":"pt-BR","tag":"Conceitos","count":29},{"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":"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":"pt-BR/api-reference/customer/get-id","slug":"/pt-BR/api-reference/customer/get-id","pageMetadata":{"title":"Recuperar um Cliente com Status de Verificação","sidebarTitle":"Obter Cliente","openapi":"openapi/spherepay.yaml GET /v2/customer/{id}","source_file":"api-reference/customer/get-id.mdx","source_language":"en","translation_language":"pt-BR","source_commit":"6c9107b","description":"Get information about a customer by their ID","href":"/pt-BR/api-reference/customer/get-id"},"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: \"Get information about a customer by their ID\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Use este endpoint para buscar os detalhes completos de um único cliente pelo seu ID único. A resposta inclui o status atual do perfil de verificação do cliente, que indica exatamente quais critérios de KYC/KYB permanecem pendentes antes que o cliente possa iniciar uma transferência. Você também pode inspecionar contas bancárias e carteiras vinculadas por meio deste registro.`})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Recuperar um Cliente com Status de Verificação","sidebarTitle":"Obter Cliente","openapi":"openapi/spherepay.yaml GET /v2/customer/{id}","source_file":"api-reference/customer/get-id.mdx","source_language":"en","translation_language":"pt-BR","source_commit":"6c9107b","description":"Get information about a customer by their ID","href":"/pt-BR/api-reference/customer/get-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/spherepayco/27b80abc67bf6551/snippets/demoAppUrl.js"],"openApiReferenceData":{"operation":{"description":"Get information about a customer by their ID","operationId":"getV2CustomerById","parameters":["09499fd1-60af-4be6-b71f-51176e3a54a6"],"responses":{"200":"f40cd3db-72cd-42be-817b-c8f0ba09e0a4","400":"acef89f9-471b-4b5d-8c17-5c51a2d2c2a4","404":"27ffd2d6-375b-428d-941b-d46948f220d6","409":"11673d1a-056c-4702-ba1b-be8fcf7c5a8a","422":"7c80b601-253f-4506-aa71-58d9ffea0ea5"},"summary":"Get a customer by ID","method":"get","type":"path","servers":["b5036787-7020-43a8-8dee-cb8b0d270e6a"],"security":["d8f4bc21-1820-4e73-bc5e-ea3b587aeee8"],"path":"/v2/customer/{id}","baseUrlOptions":["https://api.spherepay.co"],"title":"Get a customer by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"09499fd1-60af-4be6-b71f-51176e3a54a6":{"description":"Customer ID","in":"path","name":"id","required":true,"schema":{"example":"customer_f31121c389624d3697cbf3ea8830b7a4","type":"string","isRequired":true,"description":"Customer ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"f40cd3db-72cd-42be-817b-c8f0ba09e0a4":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Individual","description":"Response containing information about an individual customer.","required":["id","enabledVerificationProfiles","verificationProfiles","tosStatus","createdAt","updatedAt","type"],"properties":{"createdAt":{"description":"ISO 8601 formatted customer creation timestamp","example":"2026-03-09T20:46:31.305Z","type":"string","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string"},"enabledVerificationProfiles":{"oneOf":[{"description":"Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from `verificationProfiles`, which reports the evaluated profiles and their statuses.","example":["a","c"],"items":{"enum":["a","b","c","d"],"type":"string","uniqueKey":"oneOf.0.enabledVerificationProfiles.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.enabledVerificationProfiles.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from `verificationProfiles`, which reports the evaluated profiles and their statuses.","example":["a","c"],"items":{"enum":["a","b","c","d"],"type":"string"},"type":"null","isRequired":true,"uniqueKey":"oneOf.0.enabledVerificationProfiles.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.enabledVerificationProfiles","typeLabel":"enum\u003cstring>[] | null"},"id":{"description":"Customer ID","example":"customer_f31121c389624d3697cbf3ea8830b7a4","type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"tosStatus":{"description":"Customer Terms of Service acceptance status (incomplete | pending | approved).","enum":["incomplete","pending","approved"],"example":"incomplete","type":"string","x-enumNames":["Incomplete","Pending","Approved"],"isRequired":true,"uniqueKey":"oneOf.0.tosStatus","typeLabel":"enum\u003cstring>"},"type":{"description":"Customer type","enum":["individual"],"example":"individual","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"ISO 8601 formatted customer update timestamp","example":"2026-03-09T20:46:31.305Z","type":"string","isRequired":true,"uniqueKey":"oneOf.0.updatedAt","typeLabel":"string"},"verificationProfiles":{"description":"The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to `enabledVerificationProfiles`, which says which families they are permitted to use. Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See [KYC Flow](/concepts/onboarding/individual-kyc) for individuals or [KYB Flow](/concepts/onboarding/business-kyb) for businesses. See [Verification Profile](/concepts/onboarding/verification-profile) for individual status definitions and criteria breakdown or [Verification Profile](/concepts/onboarding/verification-profile) for business status definitions and criteria breakdown.","example":[{"criteria":{"complete":["email_address","phone_number","residential_address","tax_identification_number"],"errors":[],"pending":[],"required":["identity_document","liveness_report_document"]},"name":"kyc_profile_a","status":"incomplete"}],"items":{"properties":{"name":{"description":"The name of the verification profile.","enum":["kyc_profile_a","kyb_profile_a","ubo_kyc_profile_a","kyc_profile_b","kyb_profile_b","kyb_profile_c","kyc_profile_c","ubo_kyc_profile_c","kyb_profile_d","kyc_profile_d","ubo_kyc_profile_d"],"example":"kyc_profile_a","type":"string","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"status":{"description":"The status of the verification profile.","enum":["incomplete","pending","approved","rejected","rejected_final","manual_review","resubmission_required"],"example":"incomplete","type":"string","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"criteria":{"description":"The criteria for the verification profile.","example":{"complete":["email_address","phone_number","residential_address","tax_identification_number"],"errors":[],"pending":[],"required":["identity_document","liveness_report_document"]},"properties":{"complete":{"description":"Completed fields.","example":["email_address","phone_number","residential_address","tax_identification_number"],"items":{"type":"string","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.complete.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.complete","typeLabel":"string[]"},"errors":{"description":"The errors that occurred while verifying the fields.","example":[],"items":{"properties":{"name":{"enum":["email_verification","phone_verification","residential_address","identity_document","tax_identification_number","liveness_check","terms_of_service","email_address","phone_number","master_service_agreement","legal_name","trade_name","entity_type","entity_type_description","description","registered_address","operating_address","business_representatives","naics_code","website","incorporated_on","identification_number","registration_number","estimated_annual_revenue","expected_monthly_payments","account_purpose","account_purpose_description","source_of_funds","source_of_funds_description","is_dao","regulated_activities","regulated_activities_description","participates_in_regulated_financial_activity","regulated_financial_activity_description","money_services_description","compliance_screening_explanation","operates_in_prohibited_countries","incorporation_cert_document","incorporation_articles_document","shareholder_registry_document","proof_of_nature_of_business_document","proof_of_address_document","liveness_report_document","ownership_percentage","is_control_person","control_person_added","is_signer","relationship_established_at","title","employment_status","acting_as_intermediary","sex","country_of_birth","nationality","middle_name","occupation_soc_code","w8_ben_document","w9_document","state_of_birth","ip_address","ip_address_approved","expected_monthly_transaction_count","transaction_frequency","expected_counterparty_types","expected_geographies","w8_ben_e_document","corporate_resolution_document","source_of_funds_document","financial_statements_document","bank_statement_document","regulated_activity_document","flow_of_funds_document","kyc_b_approval","kyb_b_approval"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX].detail","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.errors","typeLabel":"object[]"},"pending":{"description":"Pending fields. These fields are currently being verified.","example":[],"items":{"type":"string","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.pending.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.pending","typeLabel":"string[]"},"required":{"description":"Required fields. These fields are required to be completed before the verification profile can be approved.","example":["identity_document","liveness_report_document"],"items":{"type":"string","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.required.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria.required","typeLabel":"string[]"}},"required":["complete","pending","required","errors"],"type":"object","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX].criteria","typeLabel":"object"}},"required":["name","status"],"type":"object","uniqueKey":"oneOf.0.verificationProfiles.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.verificationProfiles","typeLabel":"object[]"},"dateOfBirth":{"description":"The customer's date of birth in YYYY-MM-DD format (individual customers only).","example":"1990-01-15","type":"string","uniqueKey":"oneOf.0.dateOfBirth","typeLabel":"string"},"email":{"description":"Customer email address","example":"jane.smith@example.com","type":"string","uniqueKey":"oneOf.0.email","typeLabel":"string"},"firstName":{"description":"Customer first name (individual customers only)","example":"Jane","type":"string","uniqueKey":"oneOf.0.firstName","typeLabel":"string"},"lastName":{"description":"Customer last name (individual customers only)","example":"Smith","type":"string","uniqueKey":"oneOf.0.lastName","typeLabel":"string"},"meta":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.meta.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"oneOf.0.meta","typeLabel":"object"},"personalInformation":{"description":"Personal information for an individual customer, echoed back from the most recent submission. The tax identification number is omitted from responses for privacy.","properties":{"accountPurpose":{"type":"string","uniqueKey":"oneOf.0.personalInformation.accountPurpose","typeLabel":"string"},"accountPurposeDescription":{"type":"string","uniqueKey":"oneOf.0.personalInformation.accountPurposeDescription","typeLabel":"string"},"actingAsIntermediary":{"description":"Whether the customer is acting as an intermediary on behalf of a third party. Required by some verification providers.","example":false,"type":"boolean","uniqueKey":"oneOf.0.personalInformation.actingAsIntermediary","typeLabel":"boolean"},"countryOfBirth":{"description":"The ISO3166-1 Alpha-3 country code of the country where the customer was born. See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","uniqueKey":"oneOf.0.personalInformation.countryOfBirth","typeLabel":"string"},"employmentStatus":{"type":"string","uniqueKey":"oneOf.0.personalInformation.employmentStatus","typeLabel":"string"},"expectedMonthlyPayments":{"type":"string","uniqueKey":"oneOf.0.personalInformation.expectedMonthlyPayments","typeLabel":"string"},"gender":{"type":"string","uniqueKey":"oneOf.0.personalInformation.gender","typeLabel":"string"},"middleName":{"description":"The customer's middle name. Required for some verification flows.","example":"James","type":"string","uniqueKey":"oneOf.0.personalInformation.middleName","typeLabel":"string"},"nationality":{"description":"The ISO3166-1 Alpha-3 country code of the customer's nationality. Required by some verification providers. See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","uniqueKey":"oneOf.0.personalInformation.nationality","typeLabel":"string"},"occupationSocCode":{"description":"The customer's occupation as a 6-digit Standard Occupational Classification (SOC) code, validated against the supported occupation list. Required for some verification flows.","example":"151252","type":"string","uniqueKey":"oneOf.0.personalInformation.occupationSocCode","typeLabel":"string"},"residencyCountry":{"description":"The ISO3166-1 Alpha-3 country code of the customer's country of residency. Often satisfied by the address country, but some verification providers require it as a separate attribute. See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","uniqueKey":"oneOf.0.personalInformation.residencyCountry","typeLabel":"string"},"sourceOfFunds":{"type":"string","uniqueKey":"oneOf.0.personalInformation.sourceOfFunds","typeLabel":"string"},"stateOfBirth":{"description":"The subdivision code of the state/province where the customer was born, without the country prefix (e.g. `JAL`, not `MX-JAL`). Requires `countryOfBirth`. Required by some verification providers.","example":"JAL","type":"string","uniqueKey":"oneOf.0.personalInformation.stateOfBirth","typeLabel":"string"},"taxIdentificationNumberCountry":{"description":"The ISO3166-1 Alpha-3 country code for the tax identification number. Required when providing tax identification information. See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","uniqueKey":"oneOf.0.personalInformation.taxIdentificationNumberCountry","typeLabel":"string"},"taxIdentificationNumberDescription":{"description":"Description of the tax identification number. Required when type is `other`","type":"string","uniqueKey":"oneOf.0.personalInformation.taxIdentificationNumberDescription","typeLabel":"string"},"taxIdentificationNumberType":{"description":"The type of tax identification number of the customer. Required when providing tax identification information. Please refer to the [Individual Verification Criteria](/concepts/onboarding/verification-profile) for the full list of reference.","example":"ssn","type":"string","uniqueKey":"oneOf.0.personalInformation.taxIdentificationNumberType","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.personalInformation","typeLabel":"object"},"phone":{"description":"Customer phone number","example":"+14155550123","type":"string","uniqueKey":"oneOf.0.phone","typeLabel":"string"},"statusDetails":{"description":"Additional context on why the customer's verification reached its current status.","example":{"message":"Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.","reasons":[{"externalReason":"Cannot validate ID — upload a photo of the ID that is clear","reasonCode":"poor_image_quality","verificationProfiles":["kyb_profile_a"]},{"externalReason":"The tax identification number is not in a valid format for the selected country and ID type.","reasonCode":"invalid_tax_identification_number","verificationProfiles":["kyb_profile_a"]}],"updatedAt":"2026-07-16T21:04:00Z"},"properties":{"reasons":{"items":{"properties":{"reasonCode":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.statusDetails.reasons.items.[INDEX].reasonCode","typeLabel":"string"},"verificationProfiles":{"items":{"type":"string","uniqueKey":"oneOf.0.statusDetails.reasons.items.[INDEX].verificationProfiles.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.statusDetails.reasons.items.[INDEX].verificationProfiles","typeLabel":"string[]"},"externalReason":{"type":"string","uniqueKey":"oneOf.0.statusDetails.reasons.items.[INDEX].externalReason","typeLabel":"string"}},"required":["reasonCode","verificationProfiles"],"type":"object","uniqueKey":"oneOf.0.statusDetails.reasons.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.statusDetails.reasons","typeLabel":"object[]"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.statusDetails.updatedAt","typeLabel":"string"},"message":{"type":"string","uniqueKey":"oneOf.0.statusDetails.message","typeLabel":"string"}},"required":["reasons","updatedAt"],"type":"object","uniqueKey":"oneOf.0.statusDetails","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Individual · object"},{"type":"object","title":"Business","description":"Response containing information about a business customer.","required":["id","enabledVerificationProfiles","verificationProfiles","tosStatus","createdAt","updatedAt","type"],"properties":{"createdAt":{"description":"ISO 8601 formatted customer creation timestamp","example":"2026-03-09T20:46:31.305Z","type":"string","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string"},"enabledVerificationProfiles":{"oneOf":[{"description":"Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from `verificationProfiles`, which reports the evaluated profiles and their statuses.","example":["a","c"],"items":{"enum":["a","b","c","d"],"type":"string","uniqueKey":"oneOf.1.enabledVerificationProfiles.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.enabledVerificationProfiles.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from `verificationProfiles`, which reports the evaluated profiles and their statuses.","example":["a","c"],"items":{"enum":["a","b","c","d"],"type":"string"},"type":"null","isRequired":true,"uniqueKey":"oneOf.1.enabledVerificationProfiles.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.enabledVerificationProfiles","typeLabel":"enum\u003cstring>[] | null"},"id":{"description":"Customer ID","example":"customer_f31121c389624d3697cbf3ea8830b7a4","type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"tosStatus":{"description":"Customer Terms of Service acceptance status (incomplete | pending | approved).","enum":["incomplete","pending","approved"],"example":"incomplete","type":"string","x-enumNames":["Incomplete","Pending","Approved"],"isRequired":true,"uniqueKey":"oneOf.1.tosStatus","typeLabel":"enum\u003cstring>"},"type":{"description":"Customer type","enum":["business"],"example":"business","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"ISO 8601 formatted customer update timestamp","example":"2026-03-09T20:46:31.305Z","type":"string","isRequired":true,"uniqueKey":"oneOf.1.updatedAt","typeLabel":"string"},"verificationProfiles":{"description":"The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to `enabledVerificationProfiles`, which says which families they are permitted to use. Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See [KYC Flow](/concepts/onboarding/individual-kyc) for individuals or [KYB Flow](/concepts/onboarding/business-kyb) for businesses. See [Verification Profile](/concepts/onboarding/verification-profile) for individual status definitions and criteria breakdown or [Verification Profile](/concepts/onboarding/verification-profile) for business status definitions and criteria breakdown.","example":[{"criteria":{"complete":["email_address","phone_number","residential_address","tax_identification_number"],"errors":[],"pending":[],"required":["identity_document","liveness_report_document"]},"name":"kyc_profile_a","status":"incomplete"}],"items":{"properties":{"name":{"description":"The name of the verification profile.","enum":["kyc_profile_a","kyb_profile_a","ubo_kyc_profile_a","kyc_profile_b","kyb_profile_b","kyb_profile_c","kyc_profile_c","ubo_kyc_profile_c","kyb_profile_d","kyc_profile_d","ubo_kyc_profile_d"],"example":"kyc_profile_a","type":"string","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"status":{"description":"The status of the verification profile.","enum":["incomplete","pending","approved","rejected","rejected_final","manual_review","resubmission_required"],"example":"incomplete","type":"string","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"criteria":{"description":"The criteria for the verification profile.","example":{"complete":["email_address","phone_number","residential_address","tax_identification_number"],"errors":[],"pending":[],"required":["identity_document","liveness_report_document"]},"properties":{"complete":{"description":"Completed fields.","example":["email_address","phone_number","residential_address","tax_identification_number"],"items":{"type":"string","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.complete.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.complete","typeLabel":"string[]"},"errors":{"description":"The errors that occurred while verifying the fields.","example":[],"items":{"properties":{"name":{"enum":["email_verification","phone_verification","residential_address","identity_document","tax_identification_number","liveness_check","terms_of_service","email_address","phone_number","master_service_agreement","legal_name","trade_name","entity_type","entity_type_description","description","registered_address","operating_address","business_representatives","naics_code","website","incorporated_on","identification_number","registration_number","estimated_annual_revenue","expected_monthly_payments","account_purpose","account_purpose_description","source_of_funds","source_of_funds_description","is_dao","regulated_activities","regulated_activities_description","participates_in_regulated_financial_activity","regulated_financial_activity_description","money_services_description","compliance_screening_explanation","operates_in_prohibited_countries","incorporation_cert_document","incorporation_articles_document","shareholder_registry_document","proof_of_nature_of_business_document","proof_of_address_document","liveness_report_document","ownership_percentage","is_control_person","control_person_added","is_signer","relationship_established_at","title","employment_status","acting_as_intermediary","sex","country_of_birth","nationality","middle_name","occupation_soc_code","w8_ben_document","w9_document","state_of_birth","ip_address","ip_address_approved","expected_monthly_transaction_count","transaction_frequency","expected_counterparty_types","expected_geographies","w8_ben_e_document","corporate_resolution_document","source_of_funds_document","financial_statements_document","bank_statement_document","regulated_activity_document","flow_of_funds_document","kyc_b_approval","kyb_b_approval"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX].detail","typeLabel":"string"}},"required":["name"],"type":"object","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.errors.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.errors","typeLabel":"object[]"},"pending":{"description":"Pending fields. These fields are currently being verified.","example":[],"items":{"type":"string","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.pending.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.pending","typeLabel":"string[]"},"required":{"description":"Required fields. These fields are required to be completed before the verification profile can be approved.","example":["identity_document","liveness_report_document"],"items":{"type":"string","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.required.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria.required","typeLabel":"string[]"}},"required":["complete","pending","required","errors"],"type":"object","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX].criteria","typeLabel":"object"}},"required":["name","status"],"type":"object","uniqueKey":"oneOf.1.verificationProfiles.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.verificationProfiles","typeLabel":"object[]"},"businessLegalName":{"description":"Customer business legal name (business customers only)","example":"Acme Corporation Inc.","type":"string","uniqueKey":"oneOf.1.businessLegalName","typeLabel":"string"},"businessTradeName":{"description":"Customer business trade name (business customers only)","example":"Acme Corp","type":"string","uniqueKey":"oneOf.1.businessTradeName","typeLabel":"string"},"email":{"description":"Customer email address","example":"jane.smith@example.com","type":"string","uniqueKey":"oneOf.1.email","typeLabel":"string"},"meta":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.meta.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"oneOf.1.meta","typeLabel":"object"},"phone":{"description":"Customer phone number","example":"+14155550123","type":"string","uniqueKey":"oneOf.1.phone","typeLabel":"string"},"statusDetails":{"description":"Additional context on why the customer's verification reached its current status.","example":{"message":"Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.","reasons":[{"externalReason":"Cannot validate ID — upload a photo of the ID that is clear","reasonCode":"poor_image_quality","verificationProfiles":["kyb_profile_a"]},{"externalReason":"The tax identification number is not in a valid format for the selected country and ID type.","reasonCode":"invalid_tax_identification_number","verificationProfiles":["kyb_profile_a"]}],"updatedAt":"2026-07-16T21:04:00Z"},"properties":{"reasons":{"items":{"properties":{"reasonCode":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.statusDetails.reasons.items.[INDEX].reasonCode","typeLabel":"string"},"verificationProfiles":{"items":{"type":"string","uniqueKey":"oneOf.1.statusDetails.reasons.items.[INDEX].verificationProfiles.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.statusDetails.reasons.items.[INDEX].verificationProfiles","typeLabel":"string[]"},"externalReason":{"type":"string","uniqueKey":"oneOf.1.statusDetails.reasons.items.[INDEX].externalReason","typeLabel":"string"}},"required":["reasonCode","verificationProfiles"],"type":"object","uniqueKey":"oneOf.1.statusDetails.reasons.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.statusDetails.reasons","typeLabel":"object[]"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.statusDetails.updatedAt","typeLabel":"string"},"message":{"type":"string","uniqueKey":"oneOf.1.statusDetails.message","typeLabel":"string"}},"required":["reasons","updatedAt"],"type":"object","uniqueKey":"oneOf.1.statusDetails","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Business · object"}],"uniqueKey":"","typeLabel":"Individual · object | Business · object"},"examples":{"Example":{"title":"Example","value":{"createdAt":"2026-03-09T20:46:31.305Z","enabledVerificationProfiles":["a","c"],"id":"customer_f31121c389624d3697cbf3ea8830b7a4","tosStatus":"incomplete","type":"individual","updatedAt":"2026-03-09T20:46:31.305Z","verificationProfiles":[{"criteria":{"complete":["email_address","phone_number","residential_address","tax_identification_number"],"errors":[],"pending":[],"required":["identity_document","liveness_report_document"]},"name":"kyc_profile_a","status":"incomplete"}],"dateOfBirth":"1990-01-15","email":"jane.smith@example.com","firstName":"Jane","lastName":"Smith","meta":{},"personalInformation":{"accountPurpose":"\u003cstring>","accountPurposeDescription":"\u003cstring>","actingAsIntermediary":false,"countryOfBirth":"USA","employmentStatus":"\u003cstring>","expectedMonthlyPayments":"\u003cstring>","gender":"\u003cstring>","middleName":"James","nationality":"USA","occupationSocCode":"151252","residencyCountry":"USA","sourceOfFunds":"\u003cstring>","stateOfBirth":"JAL","taxIdentificationNumberCountry":"USA","taxIdentificationNumberDescription":"\u003cstring>","taxIdentificationNumberType":"ssn"},"phone":"+14155550123","statusDetails":{"message":"Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.","reasons":[{"externalReason":"Cannot validate ID — upload a photo of the ID that is clear","reasonCode":"poor_image_quality","verificationProfiles":["kyb_profile_a"]},{"externalReason":"The tax identification number is not in a valid format for the selected country and ID type.","reasonCode":"invalid_tax_identification_number","verificationProfiles":["kyb_profile_a"]}],"updatedAt":"2026-07-16T21:04:00Z"}}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"acef89f9-471b-4b5d-8c17-5c51a2d2c2a4":{"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"},"27ffd2d6-375b-428d-941b-d46948f220d6":{"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"},"11673d1a-056c-4702-ba1b-be8fcf7c5a8a":{"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"},"7c80b601-253f-4506-aa71-58d9ffea0ea5":{"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":{"d8f4bc21-1820-4e73-bc5e-ea3b587aeee8":{"bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{"b5036787-7020-43a8-8dee-cb8b0d270e6a":{"description":"Production","url":"https://api.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":"Recuperar um Cliente com Status de Verificação - SpherePay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/customer/get-id","matchLevel":1},"es":{"href":"/es/api-reference/customer/get-id","matchLevel":1},"pt-BR":{"href":"/pt-BR/api-reference/customer/get-id","matchLevel":0}}},"lastModified":"2026-06-18T02:06:48.636Z","gitLastModified":"2026-06-22T23:09:36.000Z","originalFileLocation":"pt-BR/api-reference/customer/get-id.mdx","locale":"pt-BR"},"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=\"Get information about a customer by their ID\">\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=\"Recuperar um Cliente com Status de Verificação - SpherePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get information about a customer by their ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SpherePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id\">\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=Clientes\u0026amp;title=Recuperar+um+Cliente+com+Status+de+Verifica%C3%A7%C3%A3o\u0026amp;description=Get+information+about+a+customer+by+their+ID\u0026amp;theme=eda2cafc957c45d3c16031d8\u0026amp;signature=77d3b720dc71a001bce349fc9269a3f8d724175701fea95bc0edec15e885f58a\">\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=\"Recuperar um Cliente com Status de Verificação - SpherePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get information about a customer by their ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spherepayco.mintlify.site/_mintlify/api/og/v2?division=Clientes\u0026amp;title=Recuperar+um+Cliente+com+Status+de+Verifica%C3%A7%C3%A3o\u0026amp;description=Get+information+about+a+customer+by+their+ID\u0026amp;theme=eda2cafc957c45d3c16031d8\u0026amp;signature=77d3b720dc71a001bce349fc9269a3f8d724175701fea95bc0edec15e885f58a\">\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/pt-BR/api-reference/customer/get-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt-BR/api-reference/customer/get-id.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.spherepay.co/api-reference/customer/get-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.spherepay.co/es/api-reference/customer/get-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.spherepay.co/api-reference/customer/get-id\">\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/pt-BR/api-reference/customer/get-id#webpage\",\"url\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id\",\"name\":\"Recuperar um Cliente com Status de Verificação\",\"description\":\"Get information about a customer by their ID\",\"dateModified\":\"2026-06-22T23:09:36.000Z\",\"isPartOf\":{\"@id\":\"https://docs.spherepay.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding\",\"item\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clientes\",\"item\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/post\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Recuperar um Cliente com Status de Verificação\",\"item\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id#apireference\",\"headline\":\"Recuperar um Cliente com Status de Verificação\",\"name\":\"Recuperar um Cliente com Status de Verificação\",\"description\":\"Get information about a customer by their ID\",\"url\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/get-id#webpage\"},\"dateModified\":\"2026-06-22T23:09:36.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":"/pt-BR/api-reference/customer/get-id.md","siteName":"SpherePay","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/customer/get-id"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/customer/get-id"}]},{"language":"pt-BR","tabs":[{"tab":"Começar","pages":[{"title":"Começar","href":"/pt-BR/introduction"}]},{"tab":"Conceitos","pages":[{"title":"Conceitos","href":"/pt-BR/concepts/overview"}]},{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR/implementation-guides/overview"}]},{"tab":"Soluções","pages":[{"title":"Soluções","href":"/pt-BR/solutions/overview"}]},{"tab":"Referência da API","groups":[{"group":"Onboarding","pages":[{"group":"Clientes","icon":"user","pages":[{"title":"Criar um Cliente Individual ou Empresarial","sidebarTitle":"Criar Cliente","openapi":"openapi/spherepay.yaml POST /v2/customer","href":"/pt-BR/api-reference/customer/post"},{"title":"Listar Clientes com Filtros e Paginação","sidebarTitle":"Listar Clientes","openapi":"openapi/spherepay.yaml GET /v2/customer","description":"List customers with optional server-side search, filters, and sort.","href":"/pt-BR/api-reference/customer/get"},{"title":"Recuperar um Cliente com Status de Verificação","sidebarTitle":"Obter Cliente","openapi":"openapi/spherepay.yaml GET /v2/customer/{id}","href":"/pt-BR/api-reference/customer/get-id"},{"title":"Atualizar Endereço, Telefone ou E-mail do Cliente","sidebarTitle":"Atualizar Cliente","openapi":"openapi/spherepay.yaml PATCH /v2/customer/{id}","description":"Update a customer by ID. Individual and business customers can be updated during onboarding. A field is locked once a verification profile that is pending, approved or terminally rejected has completed the criterion the field supplies; locked fields return 400 with a pointer per field. Business customers may add verification profiles and supply the fields those profiles add.","href":"/pt-BR/api-reference/customer/patch-id"}]},{"group":"Links de Onboarding","icon":"link","pages":[{"title":"Criar Cliente via Link","sidebarTitle":"Criar Cliente via Link","openapi":"openapi/spherepay.yaml POST /v2/customer/kyc-link","href":"/pt-BR/api-reference/customer/kyc-link"},{"title":"Regenerar o Link KYC de um Cliente","sidebarTitle":"Regenerar Link KYC","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/kyc-link","href":"/pt-BR/api-reference/customer/kyc"}]},{"group":"Documentos e Verificação","icon":"file-check","pages":[{"title":"Enviar Documentos de Identidade KYC e KYB","sidebarTitle":"Enviar Documento","openapi":"openapi/spherepay.yaml POST /v2/document","href":"/pt-BR/api-reference/document/post"},{"title":"Gerar Link de Verificação Facial para Cliente","sidebarTitle":"Link de Verificação Facial","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/face-verification-link","href":"/pt-BR/api-reference/enhanced-due-diligence/face-verification-link"},{"title":"Gerar Link de Verificação Facial para UBO no KYB","sidebarTitle":"Link de Verificação Facial UBO","openapi":"openapi/spherepay.yaml POST /v2/business-representative/{id}/face-verification-link","href":"/pt-BR/api-reference/enhanced-due-diligence/ubo-face-verification-link"},{"title":"Enviar Código OTP para Verificação do Cliente","sidebarTitle":"Enviar Código de Verificação","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/otp-send","href":"/pt-BR/api-reference/enhanced-due-diligence/send-verification-code"},{"title":"Verificar Código OTP do Cliente para E-mail ou Telefone","sidebarTitle":"Verificar Código OTP","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/otp-verify","href":"/pt-BR/api-reference/enhanced-due-diligence/verify-verification-code"},{"title":"Registrar Aceite dos Termos de Serviço do Cliente","sidebarTitle":"Aceitar Termos de Serviço","openapi":"openapi/spherepay.yaml POST /v2/customer/{id}/tos-link","href":"/pt-BR/api-reference/enhanced-due-diligence/tos"}]},{"group":"Representantes Empresariais","icon":"users","pages":[{"title":"Registrar um UBO Empresarial para Verificação KYB","sidebarTitle":"Registrar Representante","openapi":"openapi/spherepay.yaml POST /v2/business-representative","href":"/pt-BR/api-reference/business-representative/post"},{"title":"Listar Todos os Representantes Empresariais e UBOs","sidebarTitle":"Listar Representantes","openapi":"openapi/spherepay.yaml GET /v2/business-representative","href":"/pt-BR/api-reference/business-representative/get"},{"title":"Recuperar um Representante Empresarial por ID","sidebarTitle":"Obter Representante","openapi":"openapi/spherepay.yaml GET /v2/business-representative/{id}","href":"/pt-BR/api-reference/business-representative/get-id"},{"title":"Atualizar um Representante Empresarial Antes do KYB","sidebarTitle":"Atualizar Representante","openapi":"openapi/spherepay.yaml PATCH /v2/business-representative/{id}","href":"/pt-BR/api-reference/business-representative/patch-id"},{"title":"Remover um Representante Empresarial ou UBO","sidebarTitle":"Excluir Representante","openapi":"openapi/spherepay.yaml DELETE /v2/business-representative/{id}","href":"/pt-BR/api-reference/business-representative/delete-id"}]}]},{"group":"Contas","pages":[{"group":"Contas Bancárias","icon":"landmark","pages":[{"title":"Registrar uma Conta Bancária do Cliente para Transferências","sidebarTitle":"Registrar Conta Bancária","openapi":"openapi/spherepay.yaml POST /v2/bank-account","href":"/pt-BR/api-reference/bank-account/post"},{"title":"Listar Todas as Contas Bancárias Registradas do Cliente","sidebarTitle":"Listar Contas Bancárias","openapi":"openapi/spherepay.yaml GET /v2/bank-account","href":"/pt-BR/api-reference/bank-account/get"},{"title":"Recuperar uma Conta Bancária por ID","sidebarTitle":"Obter Conta Bancária","openapi":"openapi/spherepay.yaml GET /v2/bank-account/{id}","href":"/pt-BR/api-reference/bank-account/get-id"},{"title":"Atualizar Configurações de Rail da Conta Bancária","sidebarTitle":"Atualizar Conta Bancária","openapi":"openapi/spherepay.yaml PATCH /v2/bank-account/{id}","href":"/pt-BR/api-reference/bank-account/patch-id"},{"title":"Excluir uma Conta Bancária Registrada do Cliente","sidebarTitle":"Excluir Conta Bancária","openapi":"openapi/spherepay.yaml DELETE /v2/bank-account/{id}","href":"/pt-BR/api-reference/bank-account/delete-id"}]},{"group":"Carteiras","icon":"wallet","pages":[{"title":"Registrar uma Carteira Cripto do Cliente para Transferências","sidebarTitle":"Registrar Carteira","openapi":"openapi/spherepay.yaml POST /v2/wallet","href":"/pt-BR/api-reference/wallet/post"},{"title":"Listar Todas as Carteiras Cripto Registradas do Cliente","sidebarTitle":"Listar Carteiras","openapi":"openapi/spherepay.yaml GET /v2/wallet","href":"/pt-BR/api-reference/wallet/get"},{"title":"Recuperar uma Carteira Cripto do Cliente por ID","sidebarTitle":"Obter Carteira","openapi":"openapi/spherepay.yaml GET /v2/wallet/{id}","href":"/pt-BR/api-reference/wallet/get-id"},{"title":"Remover uma Carteira Cripto Registrada do Cliente","sidebarTitle":"Excluir Carteira","openapi":"openapi/spherepay.yaml DELETE /v2/wallet/{id}","href":"/pt-BR/api-reference/wallet/delete-id"}]}]},{"group":"Movimentação de dinheiro","pages":[{"group":"Transferências","icon":"arrow-right-left","pages":[{"title":"Criar uma Transferência On-Ramp ou Off-Ramp","sidebarTitle":"Criar Transferência","openapi":"openapi/spherepay.yaml POST /v2/transfer","href":"/pt-BR/api-reference/transfer/post"},{"title":"Listar Transferências On-Ramp e Off-Ramp","sidebarTitle":"Listar Transferências","openapi":"openapi/spherepay.yaml GET /v2/transfer","href":"/pt-BR/api-reference/transfer/get"},{"title":"Recuperar uma Transferência com Instruções de Depósito","sidebarTitle":"Obter Transferência","openapi":"openapi/spherepay.yaml GET /v2/transfer/{id}","href":"/pt-BR/api-reference/transfer/get-id"},{"title":"Cancelar uma Transferência Pendente Não Financiada","sidebarTitle":"Cancelar Transferência","openapi":"openapi/spherepay.yaml DELETE /v2/transfer/{id}","href":"/pt-BR/api-reference/transfer/delete-id"}]},{"group":"Cotações","icon":"calculator","pages":[{"title":"Criar uma Cotação com Taxa Bloqueada","sidebarTitle":"Criar Cotação","openapi":"openapi/spherepay.yaml POST /v2/quote","href":"/pt-BR/api-reference/quote/post"},{"title":"Listar Todas as Cotações com Taxa Bloqueada da Sua Conta","sidebarTitle":"Listar Cotações","openapi":"openapi/spherepay.yaml GET /v2/quote","href":"/pt-BR/api-reference/quote/get"},{"title":"Recuperar uma Cotação por ID","sidebarTitle":"Obter Cotação","openapi":"openapi/spherepay.yaml GET /v2/quote/{id}","href":"/pt-BR/api-reference/quote/get-id"},{"title":"Atualizar Status da Cotação","sidebarTitle":"Atualizar Cotação","openapi":"openapi/spherepay.yaml PUT /v2/quote/{id}","href":"/pt-BR/api-reference/quote/put-id"}]},{"group":"Contas Virtuais","icon":"credit-card","pages":[{"title":"Criar uma Conta Bancária Virtual para On-Ramp de Fiat","sidebarTitle":"Criar Conta Virtual","openapi":"openapi/spherepay.yaml POST /v2/virtual-account","href":"/pt-BR/api-reference/virtual-account/post"},{"title":"Listar Todas as Contas Bancárias Virtuais Onramper","sidebarTitle":"Listar Contas Virtuais","openapi":"openapi/spherepay.yaml GET /v2/virtual-account","href":"/pt-BR/api-reference/virtual-account/get"},{"title":"Recuperar uma Onramper Account por ID","sidebarTitle":"Obter Conta Virtual","openapi":"openapi/spherepay.yaml GET /v2/virtual-account/{virtualAccountId}","href":"/pt-BR/api-reference/virtual-account/get-id"},{"title":"Atualizar a Carteira de Destino de uma Onramper Account","sidebarTitle":"Atualizar Conta Virtual","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}","href":"/pt-BR/api-reference/virtual-account/patch"},{"title":"Listar Transferências de uma Onramper Account","sidebarTitle":"Listar Transferências da Conta","openapi":"openapi/spherepay.yaml GET /v2/virtual-account/{virtualAccountId}/transfer","href":"/pt-BR/api-reference/virtual-account/list-transfers"},{"title":"Desativar uma Conta Bancária Virtual Onramper","sidebarTitle":"Desativar Conta","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}/deactivate","href":"/pt-BR/api-reference/virtual-account/deactivate"},{"title":"Reativar uma Onramper Account Desativada","sidebarTitle":"Reativar Conta","openapi":"openapi/spherepay.yaml PATCH /v2/virtual-account/{virtualAccountId}/reactivate","href":"/pt-BR/api-reference/virtual-account/reactivate"}]},{"group":"Offloader Wallets","icon":"arrow-up-from-line","pages":[{"title":"Criar uma Offloader Wallet para Pagamentos em Cripto","sidebarTitle":"Criar Offloader Wallet","openapi":"openapi/spherepay.yaml POST /v2/offloader-wallet","href":"/pt-BR/api-reference/offloader-wallet/post"},{"title":"Listar Todas as Offloader Wallets da Sua Conta","sidebarTitle":"Listar Offloader Wallets","openapi":"openapi/spherepay.yaml GET /v2/offloader-wallet","href":"/pt-BR/api-reference/offloader-wallet/get"},{"title":"Recuperar uma Offloader Wallet por ID","sidebarTitle":"Obter Offloader Wallet","openapi":"openapi/spherepay.yaml GET /v2/offloader-wallet/{id}","href":"/pt-BR/api-reference/offloader-wallet/get-id"},{"title":"Atualizar o Destino Bancário de uma Offloader Wallet","sidebarTitle":"Atualizar Offloader Wallet","openapi":"openapi/spherepay.yaml PATCH /v2/offloader-wallet/{id}","href":"/pt-BR/api-reference/offloader-wallet/patch-id"}]}]},{"group":"Webhooks","pages":[{"group":"Endpoints de Webhook","icon":"plug","pages":[{"title":"Registrar um Endpoint de Webhook para Entrega de Eventos","sidebarTitle":"Criar Endpoint de Webhook","openapi":"openapi/spherepay.yaml POST /v2/webhook-endpoints","href":"/pt-BR/api-reference/webhook-endpoints/post"},{"title":"Listar Todos os Endpoints de Webhook Registrados","sidebarTitle":"Listar Endpoints de Webhook","openapi":"openapi/spherepay.yaml GET /v2/webhook-endpoints","href":"/pt-BR/api-reference/webhook-endpoints/get"},{"title":"Recuperar um Endpoint de Webhook por ID","sidebarTitle":"Obter Endpoint de Webhook","openapi":"openapi/spherepay.yaml GET /v2/webhook-endpoints/{id}","href":"/pt-BR/api-reference/webhook-endpoints/get-id"},{"title":"Excluir um Endpoint de Webhook","sidebarTitle":"Excluir Endpoint de Webhook","openapi":"openapi/spherepay.yaml DELETE /v2/webhook-endpoints/{id}","href":"/pt-BR/api-reference/webhook-endpoints/delete-id"}]},{"group":"Eventos","icon":"bell","pages":[{"title":"Listar Eventos e seu Status de Entrega","sidebarTitle":"Listar Eventos","openapi":"openapi/spherepay.yaml GET /v2/events","href":"/pt-BR/api-reference/events/get"},{"title":"Recuperar um Evento com o Histórico Completo de Entregas","sidebarTitle":"Obter Evento","openapi":"openapi/spherepay.yaml GET /v2/events/{id}","href":"/pt-BR/api-reference/events/get-id"},{"title":"Reenviar uma Entrega de Evento com Falha","sidebarTitle":"Reenviar Entrega","openapi":"openapi/spherepay.yaml POST /v2/events/replay/{eventDeliveryId}","href":"/pt-BR/api-reference/events/replay"}]}]}]},{"tab":"Notas","pages":[{"title":"Notas","href":"/pt-BR/changelog"}]},{"tab":"FAQ","href":"https://spherepay-knowledge-base.help.usepylon.com/"}]}]},"basePath":"","title":"Recuperar um Cliente com Status de Verificação - SpherePay","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}