Use este endpoint para criar um cliente e gerar um link KYC hospedado em uma única solicitação. Em vez de criar o cliente primeiro e depois solicitar um link separadamente, você fornece aqui o tipo, email, telefone e endereço do cliente, e a resposta retorna o ID do novo cliente junto com uma URL de verificação hospedada com tempo limitado. Redirecione o cliente para esta URL para concluir as verificações de identidade com o provedor de verificação.
Links de verificação hospedados coletam dados de KYC e KYB da EEA+ automaticamente quando se aplicam. Integradores que usam links hospedados não precisam de alterações de API para esses requisitos. Consulte Região EEA+.
Clientes criados através deste fluxo de link de onboarding só podem ser gerenciados com os endpoints de links de onboarding — eles não são compatíveis com os fluxos diretos de onboarding da API. Da mesma forma, clientes integrados através dos outros fluxos da API não podem ser usados com os endpoints de links de onboarding.
A URL retornada expira no momento indicado por expiresAt — por padrão, 4 semanas (28 dias) após a criação. Este padrão pode mudar sem aviso prévio, então confie sempre em expiresAt em vez de assumir uma duração fixa. Se o link expirar antes de o cliente concluir a verificação, gere um novo com Regenerar Link KYC usando o customerId desta resposta.
Restricts which verification profile families this customer may onboard through. Must be a subset of the families enabled on your application; supplying one that is not enabled is rejected with a 422. Omit the field to inherit the application's setting.
ISO 8601 formatted date and time of the KYC URL expiration. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice - always rely on this field rather than assuming a fixed duration.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae4e40af8344a2328cd117d","collectionId":"1a93b227-1f28-4c2a-bb42-9163f0a8c012","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4e40af8344a2328cd117d"},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4e40af8344a2328cd117d","clientVersion":"0.0.4044","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","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:0 0;color:var(--gray-600, #4b5563);font-size:.6875rem;font-weight:600;letter-spacing:.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:.5rem;gap:.375rem}nav[class*=navbar] ul li a.link{border-radius:0!important;background:0 0!important;border-bottom:2px solid transparent;transition:border-color 120ms ease,color 120ms ease}nav[class*=navbar] ul li a.link:hover{background:0 0!important;color:#18181b!important;border-bottom-color:rgba(37,99,235,.4)}.dark nav[class*=navbar] ul li a.link:hover{color:#60a5fa!important;border-bottom-color:rgba(96,165,250,.4)}nav[class*=navbar] ul li a.link[aria-current=page]{background:0 0!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,.5);border-radius:10px;margin-bottom:1rem}.dark [data-component-part=card-icon]{background:rgba(96,165,250,.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,.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,.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,.1)!important}.dark #navbar-transition::after{background:rgba(255,255,255,.1)}"}],"page":{"pagePath":"pt-BR/api-reference/customer/kyc-link","slug":"/pt-BR/api-reference/customer/kyc-link","pageMetadata":{"title":"Criar Cliente via Link","sidebarTitle":"Criar Cliente via Link","openapi":"openapi/spherepay.yaml POST /v2/customer/kyc-link","source_file":"api-reference/customer/kyc-link.mdx","source_language":"en","translation_language":"pt-BR","source_commit":"47a82cb","description":"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.","href":"/pt-BR/api-reference/customer/kyc-link"},"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: \"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\"\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={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Info,Note,Warning}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use este endpoint para criar um cliente e gerar um link KYC hospedado em uma única solicitação. Em vez de criar o cliente primeiro e depois solicitar um link separadamente, você fornece aqui o tipo, email, telefone e endereço do cliente, e a resposta retorna o ID do novo cliente junto com uma URL de verificação hospedada com tempo limitado. Redirecione o cliente para esta URL para concluir as verificações de identidade com o provedor de verificação.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Links de verificação hospedados coletam dados de KYC e KYB da EEA+ automaticamente quando se aplicam. Integradores que usam links hospedados não precisam de alterações de API para esses requisitos. Consulte `,_jsx(_components.a,{href:`/pt-BR/concepts/onboarding/overview#eea-region`,children:`Região EEA+`}),`.`]})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Clientes criados através deste fluxo de link de onboarding só podem ser gerenciados com os endpoints de links de onboarding — eles não são compatíveis com os fluxos diretos de onboarding da API. Da mesma forma, clientes integrados através dos outros fluxos da API não podem ser usados com os endpoints de links de onboarding.`})}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`A URL retornada expira no momento indicado por `,_jsx(_components.code,{children:`expiresAt`}),` — por padrão, 4 semanas (28 dias) após a criação. Este padrão pode mudar sem aviso prévio, então confie sempre em `,_jsx(_components.code,{children:`expiresAt`}),` em vez de assumir uma duração fixa. Se o link expirar antes de o cliente concluir a verificação, gere um novo com `,_jsx(_components.a,{href:`/pt-BR/api-reference/customer/kyc`,children:`Regenerar Link KYC`}),` usando o `,_jsx(_components.code,{children:`customerId`}),` desta resposta.`]})})]})}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":"Criar Cliente via Link","sidebarTitle":"Criar Cliente via Link","openapi":"openapi/spherepay.yaml POST /v2/customer/kyc-link","source_file":"api-reference/customer/kyc-link.mdx","source_language":"en","translation_language":"pt-BR","source_commit":"47a82cb","description":"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.","href":"/pt-BR/api-reference/customer/kyc-link"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/spherepayco/27b80abc67bf6551/snippets/demoAppUrl.js"],"openApiReferenceData":{"operation":{"description":"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.","operationId":"postV2CustomerKycLink","parameters":[],"requestBody":"814ec8e0-61b0-4cab-95c8-fe0ebe90805d","responses":{"201":"db46cf80-4aa7-4e6f-8eba-2584f3a7b6f1","400":"1235269b-345d-42df-851c-49b5292ce597","404":"ead01921-ad16-4b39-b4a1-e9d2024b3a77","422":"553c197c-369d-453e-bfce-014458600852"},"summary":"Create Customer via Link","x-doc-path":["v2","customer","kyc"],"method":"post","type":"path","servers":["b5036787-7020-43a8-8dee-cb8b0d270e6a"],"security":["d8f4bc21-1820-4e73-bc5e-ea3b587aeee8"],"path":"/v2/customer/kyc-link","baseUrlOptions":["https://api.spherepay.co"],"title":"Create Customer via Link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"address":{"description":"The customer's address. For individual customers this is the residential address; for business customers this is the registered business address.","properties":{"city":{"description":"The city name","example":"Chicago","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"country":{"description":"The ISO3166-1 Alpha-3 country code (e.g., USA, GBR, CAN). See [Country Codes](/concepts/reference/supported-countries).","example":"USA","type":"string","isRequired":true,"uniqueKey":"address.country","typeLabel":"string"},"line1":{"description":"The first line of the street address","example":"233 South Wacker Drive","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"address.line1","typeLabel":"string"},"line2":{"description":"The second line of the street address (apartment, suite, etc.)","example":"Suite 4700","maxLength":100,"type":"string","uniqueKey":"address.line2","typeLabel":"string"},"postalCode":{"description":"The postal or ZIP code. Required for countries that use postal codes","example":"60606","type":"string","uniqueKey":"address.postalCode","typeLabel":"string"},"state":{"description":"The state or province code (ISO3166-2 subdivision code). Required for countries that have states/provinces. See State Codes.","example":"IL","type":"string","uniqueKey":"address.state","typeLabel":"string"}},"required":["line1","city","country"],"type":"object","isRequired":true,"uniqueKey":"address","typeLabel":"object"},"email":{"description":"The customer email address.","example":"jane.smith@example.com","format":"email","maxLength":254,"type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"phone":{"description":"The customer phone number in E.164 format.","example":"+14155550123","pattern":"^\\+(?:[0-9]){6,14}[0-9]$","type":"string","isRequired":true,"uniqueKey":"phone","typeLabel":"string"},"type":{"description":"The type of customer to onboard.","enum":["individual","business"],"example":"individual","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"enabledVerificationProfiles":{"description":"Restricts which verification profile families this customer may onboard through. Must be a subset of the families enabled on your application; supplying one that is not enabled is rejected with a 422. Omit the field to inherit the application's setting.","example":["a","c"],"items":{"enum":["a","b","c","d"],"type":"string","uniqueKey":"enabledVerificationProfiles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"type":"array","uniqueKey":"enabledVerificationProfiles","typeLabel":"enum\u003cstring>[]"}},"required":["type","email","phone","address"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"address":{"city":"Chicago","country":"USA","line1":"233 South Wacker Drive","line2":"Suite 4700","postalCode":"60606","state":"IL"},"email":"jane.smith@example.com","phone":"+14155550123","type":"individual","enabledVerificationProfiles":["a","c"]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"db46cf80-4aa7-4e6f-8eba-2584f3a7b6f1":{"content":{"application/json":{"schema":{"properties":{"customerId":{"description":"The ID of the customer the KYC link belongs to","example":"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7","type":"string","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"expiresAt":{"description":"ISO 8601 formatted date and time of the KYC URL expiration. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice - always rely on this field rather than assuming a fixed duration.","example":"2026-03-09T20:46:31.305Z","type":"string","isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string"},"url":{"description":"Hosted KYC URL","example":"https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx","type":"string","isRequired":true,"uniqueKey":"url","typeLabel":"string"}},"required":["customerId","url","expiresAt"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7","expiresAt":"2026-03-09T20:46:31.305Z","url":"https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"1235269b-345d-42df-851c-49b5292ce597":{"content":{"application/json":{"examples":{"Bad Request":{"title":"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"},"ead01921-ad16-4b39-b4a1-e9d2024b3a77":{"content":{"application/json":{"examples":{"Not Found":{"title":"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"},"553c197c-369d-453e-bfce-014458600852":{"content":{"application/json":{"examples":{"Validation Error":{"title":"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":"Criar Cliente via Link - SpherePay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/customer/kyc-link","matchLevel":1},"es":{"href":"/es/api-reference/customer/kyc-link","matchLevel":1},"pt-BR":{"href":"/pt-BR/api-reference/customer/kyc-link","matchLevel":0}}},"lastModified":"2026-08-24T14:24:26.506Z","gitLastModified":"2026-08-27T16:37:06.000Z","originalFileLocation":"pt-BR/api-reference/customer/kyc-link.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=\"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\">\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=\"Criar Cliente via Link - SpherePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\">\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/kyc-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spherepayco.mintlify.app/_mintlify/api/og/v2?division=Links+de+Onboarding\u0026amp;title=Criar+Cliente+via+Link\u0026amp;description=Create+a+customer+via+the+hosted+onboarding+link+flow.+Returns+a+KYC+link+and+its+expiry.\u0026amp;theme=b4fcde6ac9937acf506a9b2d\u0026amp;signature=3c12ebb88beb59b1b31842d4c4ff55ff65a58b534fecbac06ba3f63110d4d845\">\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=\"Criar Cliente via Link - SpherePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spherepayco.mintlify.app/_mintlify/api/og/v2?division=Links+de+Onboarding\u0026amp;title=Criar+Cliente+via+Link\u0026amp;description=Create+a+customer+via+the+hosted+onboarding+link+flow.+Returns+a+KYC+link+and+its+expiry.\u0026amp;theme=b4fcde6ac9937acf506a9b2d\u0026amp;signature=3c12ebb88beb59b1b31842d4c4ff55ff65a58b534fecbac06ba3f63110d4d845\">\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/kyc-link\">\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/kyc-link.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.spherepay.co/api-reference/customer/kyc-link\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.spherepay.co/es/api-reference/customer/kyc-link\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.spherepay.co/api-reference/customer/kyc-link\">\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/kyc-link#webpage\",\"url\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link\",\"name\":\"Criar Cliente via Link\",\"description\":\"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\",\"dateModified\":\"2026-08-27T16:37:06.000Z\",\"isPartOf\":{\"@id\":\"https://docs.spherepay.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding\",\"item\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/post\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar Cliente via Link\",\"item\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link#apireference\",\"headline\":\"Criar Cliente via Link\",\"name\":\"Criar Cliente via Link\",\"description\":\"Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.\",\"url\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spherepay.co/pt-BR/api-reference/customer/kyc-link#webpage\"},\"dateModified\":\"2026-08-27T16:37:06.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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SpherePay","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/customer/kyc-link"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/customer/kyc-link"}]},{"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","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","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":"/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":"Criar Cliente via Link - SpherePay","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}