{
"statusCode": 400,
"error": "ConnectedAccountMissingFields",
"message": "The submission is missing fields required for this role/entityType (also: TosIdMismatch when tosId does not match the recorded value)."
}
Accounts
Submit the end client for verification
Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.
{
"statusCode": 400,
"error": "ConnectedAccountMissingFields",
"message": "The submission is missing fields required for this role/entityType (also: TosIdMismatch when tosId does not match the recorded value)."
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Caratuva","description":"Cross-border B2B payments for Brazilian commodity exporters. Collect from foreign buyers, settle in BRL.","colors":{"primary":"#0F766E","light":"#5EEAD4","dark":"#134E4A"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg","navbar":{"links":[{"href":"https://dashboard.caratuva.com","label":"Dashboard"},{"href":"https://status.caratuva.com","label":"Status"}],"primary":{"type":"button","label":"Sign in","href":"https://dashboard.caratuva.com"}},"footer":{"socials":{}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"pt-BR","href":"pt-BR/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pavezisoftware","hasAudioNarration":false,"actualSubdomain":"pavezisoftware","customDomains":["docs.caratuva.com"],"gitSource":{"type":"github","owner":"pavezi-io","repo":"caratuva","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a4c592a15940cc6d05d5a49","collectionId":"1557afaa-1711-45f9-bc89-08c00102274b","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a4c592a15940cc6d05d5a49:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":46},{"language":"default","tag":"Endpoints","count":46},{"language":"default","tag":"Accounts","count":23},{"language":"en","tag":"Guides","count":12},{"language":"pt-BR","tag":"Guias","count":12},{"language":"en","tag":"API Reference","count":9},{"language":"pt-BR","tag":"Referência da API","count":9},{"language":"default","tag":"Invoices","count":7},{"language":"en","tag":"Integration","count":5},{"language":"en","tag":"Get started","count":5},{"language":"en","tag":"Get paid","count":5},{"language":"en","tag":"For sellers","count":5},{"language":"pt-BR","tag":"Integração","count":5},{"language":"pt-BR","tag":"Começar","count":5},{"language":"pt-BR","tag":"Receba","count":5},{"language":"pt-BR","tag":"Para vendedores","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"en","tag":"Overview","count":4},{"language":"en","tag":"Using the dashboard","count":4},{"language":"pt-BR","tag":"Visão geral","count":4},{"language":"pt-BR","tag":"Usando o painel","count":4},{"language":"default","tag":"API keys","count":3},{"language":"default","tag":"Payments","count":3},{"language":"default","tag":"Reports","count":3},{"language":"en","tag":"Your buyers","count":2},{"language":"pt-BR","tag":"Seus compradores","count":2},{"language":"default","tag":"Access","count":2},{"language":"en","tag":"Operations","count":1},{"language":"pt-BR","tag":"Operação","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/accounts/submit-the-end-client-for-verification","slug":"/api-reference/accounts/submit-the-end-client-for-verification","pageMetadata":{"title":"Submit the end client for verification","description":"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored `role` + `entityType`. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is `verifying` or `approved`, returns the current submission instead of creating a second receiver.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored \", _jsx(_components.code, {\n children: \"role\"\n }), \" + \", _jsx(_components.code, {\n children: \"entityType\"\n }), \". Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is \", _jsx(_components.code, {\n children: \"verifying\"\n }), \" or \", _jsx(_components.code, {\n children: \"approved\"\n }), \", returns the current submission instead of creating a second receiver.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Submit the end client for verification","description":"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored `role` + `entityType`. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is `verifying` or `approved`, returns the current submission instead of creating a second receiver.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored `role` + `entityType`. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is `verifying` or `approved`, returns the current submission instead of creating a second receiver.","operationId":"ConnectedAccountsController_submit","parameters":["ff59aa72-fe16-4ab3-a1b4-49de624f637a"],"requestBody":"fc817e87-9b1d-497a-8759-60151a12678d","responses":{"201":"3bb52c37-c7d2-42bf-af8e-2a4cbe687ef5","400":"f2a34dd6-df46-4eac-a4a9-349d2a24da4f"},"security":["a790f0bc-c7f2-4723-961d-8f6ca16748d0","8bccc9a9-01a6-4a92-946b-81b0b12f6f31"],"summary":"Submit the end client for verification","tags":["Accounts"],"method":"post","type":"path","servers":[],"path":"/v1/accounts/{id}/submit","baseUrlOptions":[],"title":"Submit the end client for verification","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ff59aa72-fe16-4ab3-a1b4-49de624f637a":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tosId":{"type":"string","minLength":1,"uniqueKey":"tosId","typeLabel":"string"},"kycTier":{"type":"string","enum":["standard","enhanced"],"uniqueKey":"kycTier","typeLabel":"enum\u003cstring>"},"email":{"type":"string","format":"email","uniqueKey":"email","typeLabel":"string\u003cemail>"},"country":{"type":"string","minLength":2,"maxLength":2,"uniqueKey":"country","typeLabel":"string"},"phone":{"type":"string","minLength":3,"maxLength":32,"uniqueKey":"phone","typeLabel":"string"},"firstName":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"lastName","typeLabel":"string"},"dateOfBirth":{"type":"string","uniqueKey":"dateOfBirth","typeLabel":"string"},"taxId":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"taxId","typeLabel":"string"},"addressLine1":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","maxLength":200,"uniqueKey":"addressLine2","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":120,"uniqueKey":"city","typeLabel":"string"},"stateProvinceRegion":{"type":"string","minLength":1,"maxLength":120,"uniqueKey":"stateProvinceRegion","typeLabel":"string"},"postalCode":{"type":"string","minLength":1,"maxLength":32,"uniqueKey":"postalCode","typeLabel":"string"},"idDocCountry":{"type":"string","minLength":2,"maxLength":2,"uniqueKey":"idDocCountry","typeLabel":"string"},"idDocType":{"type":"string","enum":["PASSPORT","ID_CARD","DRIVERS"],"uniqueKey":"idDocType","typeLabel":"enum\u003cstring>"},"idDocNumber":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"idDocNumber","typeLabel":"string"},"selfieFile":{"type":"string","format":"uri","uniqueKey":"selfieFile","typeLabel":"string\u003curi>"},"idDocFrontFile":{"type":"string","format":"uri","uniqueKey":"idDocFrontFile","typeLabel":"string\u003curi>"},"idDocBackFile":{"type":"string","format":"uri","uniqueKey":"idDocBackFile","typeLabel":"string\u003curi>"},"legalName":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"legalName","typeLabel":"string"},"cnpj":{"type":"string","pattern":"^\\d{14}$","uniqueKey":"cnpj","typeLabel":"string"},"formationDate":{"type":"string","uniqueKey":"formationDate","typeLabel":"string"},"website":{"type":"string","format":"uri","uniqueKey":"website","typeLabel":"string\u003curi>"},"incorporationDocFile":{"type":"string","format":"uri","uniqueKey":"incorporationDocFile","typeLabel":"string\u003curi>"},"proofOfOwnershipDocFile":{"type":"string","format":"uri","uniqueKey":"proofOfOwnershipDocFile","typeLabel":"string\u003curi>"},"proofOfAddressDocType":{"type":"string","enum":["UTILITY_BILL","BANK_STATEMENT","RENTAL_AGREEMENT","TAX_DOCUMENT","GOVERNMENT_CORRESPONDENCE"],"uniqueKey":"proofOfAddressDocType","typeLabel":"enum\u003cstring>"},"proofOfAddressDocFile":{"type":"string","format":"uri","uniqueKey":"proofOfAddressDocFile","typeLabel":"string\u003curi>"},"owners":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["beneficial_controlling","beneficial_owner","controlling_person"],"isRequired":true,"uniqueKey":"owners.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"firstName":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"owners.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"owners.items.[INDEX].lastName","typeLabel":"string"},"dateOfBirth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","isRequired":true,"uniqueKey":"owners.items.[INDEX].dateOfBirth","typeLabel":"string"},"taxId":{"type":"string","minLength":1,"maxLength":64,"isRequired":true,"uniqueKey":"owners.items.[INDEX].taxId","typeLabel":"string"},"addressLine1":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"owners.items.[INDEX].addressLine1","typeLabel":"string"},"city":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"owners.items.[INDEX].city","typeLabel":"string"},"stateProvinceRegion":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"owners.items.[INDEX].stateProvinceRegion","typeLabel":"string"},"postalCode":{"type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"owners.items.[INDEX].postalCode","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"owners.items.[INDEX].country","typeLabel":"string"},"idDocCountry":{"type":"string","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"owners.items.[INDEX].idDocCountry","typeLabel":"string"},"idDocType":{"type":"string","enum":["PASSPORT","ID_CARD","DRIVERS"],"isRequired":true,"uniqueKey":"owners.items.[INDEX].idDocType","typeLabel":"enum\u003cstring>"},"selfieFile":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"owners.items.[INDEX].selfieFile","typeLabel":"string\u003curi>"},"idDocFrontFile":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"owners.items.[INDEX].idDocFrontFile","typeLabel":"string\u003curi>"},"proofOfAddressDocType":{"type":"string","enum":["UTILITY_BILL","BANK_STATEMENT","RENTAL_AGREEMENT","TAX_DOCUMENT","GOVERNMENT_CORRESPONDENCE"],"isRequired":true,"uniqueKey":"owners.items.[INDEX].proofOfAddressDocType","typeLabel":"enum\u003cstring>"},"proofOfAddressDocFile":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"owners.items.[INDEX].proofOfAddressDocFile","typeLabel":"string\u003curi>"},"taxType":{"type":"string","enum":["SSN","ITIN"],"uniqueKey":"owners.items.[INDEX].taxType","typeLabel":"enum\u003cstring>"},"addressLine2":{"type":"string","maxLength":200,"uniqueKey":"owners.items.[INDEX].addressLine2","typeLabel":"string"},"phone":{"type":"string","minLength":3,"maxLength":32,"uniqueKey":"owners.items.[INDEX].phone","typeLabel":"string"},"idDocNumber":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"owners.items.[INDEX].idDocNumber","typeLabel":"string"},"idDocBackFile":{"type":"string","format":"uri","uniqueKey":"owners.items.[INDEX].idDocBackFile","typeLabel":"string\u003curi>"}},"required":["role","firstName","lastName","dateOfBirth","taxId","addressLine1","city","stateProvinceRegion","postalCode","country","idDocCountry","idDocType","selfieFile","idDocFrontFile","proofOfAddressDocType","proofOfAddressDocFile"],"additionalProperties":false,"uniqueKey":"owners.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":10,"uniqueKey":"owners","typeLabel":"object[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"tosId":"tos_8a3f2b91","legalName":"Fazenda Boa Vista Café LTDA","cnpj":"12345678000190","email":"finance@fazendaboavista.com.br","country":"BR"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"3bb52c37-c7d2-42bf-af8e-2a4cbe687ef5":{"description":"Submission created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"connectedAccountId":{"type":"string","isRequired":true,"uniqueKey":"connectedAccountId","typeLabel":"string"},"receiverId":{"type":"string","isRequired":true,"uniqueKey":"receiverId","typeLabel":"string"},"status":{"enum":["created","verifying","approved","rejected"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"hostedFlowUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"hostedFlowUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"hostedFlowUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"hostedFlowUrl","typeLabel":"string | null"},"submittedAt":{"type":"string","isRequired":true,"uniqueKey":"submittedAt","typeLabel":"string"},"approvedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"approvedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"approvedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"approvedAt","typeLabel":"string | null"},"rejectedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"rejectedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"rejectedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejectedAt","typeLabel":"string | null"}},"required":["id","connectedAccountId","receiverId","status","hostedFlowUrl","submittedAt","approvedAt","rejectedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"id":"cksub042","connectedAccountId":"ckacc042","receiverId":"rc_8a3f2b91","status":"verifying","hostedFlowUrl":null,"submittedAt":"2026-06-30T12:00:00.000Z","approvedAt":null,"rejectedAt":null}}},"exampleType":"examples"}},"exampleType":"examples"},"f2a34dd6-df46-4eac-a4a9-349d2a24da4f":{"description":"ConnectedAccountMissingFields — The submission is missing fields required for this role/entityType (also: TosIdMismatch when tosId does not match the recorded value).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"ConnectedAccountMissingFields","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The submission is missing fields required for this role/entityType (also: TosIdMismatch when tosId does not match the recorded value).","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"error":"ConnectedAccountMissingFields","message":"The submission is missing fields required for this role/entityType (also: TosIdMismatch when tosId does not match the recorded value)."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a790f0bc-c7f2-4723-961d-8f6ca16748d0":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}},"8bccc9a9-01a6-4a92-946b-81b0b12f6f31":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"},{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]},"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":"https://api.caratuva.com/docs-json"},"subdomain":"pavezisoftware","siteName":"Caratuva","title":"Submit the end client for verification - Caratuva","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/accounts/submit-the-end-client-for-verification","matchLevel":0},"pt-BR":{"href":"/api-reference/accounts/submit-the-end-client-for-verification","matchLevel":0}}},"lastModified":"2026-07-07T01:41:07.857Z","originalFileLocation":"api-reference/accounts/submit-the-end-client-for-verification.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Caratuva\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003cmeta data-mint-head property=\"og:title\" content=\"Submit the end client for verification - Caratuva\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Caratuva\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pavezisoftware.mintlify.app/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Submit+the+end+client+for+verification\u0026amp;description=Submit+the+end+client+to+the+settlement+partner+for+KYB+%28business%29+or+KYC+%28individual%29+%E2%80%94+the+path+is+chosen+from+the+stored+%60role%60+%2B+%60entityType%60.+Required+fiel\u0026amp;theme=4451605dc365fc6b8cecb93b\u0026amp;signature=18521b76eb282897e61a9b3685258ba66cde88fb4eda216b1ed99971cb9b2e56\">\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=\"Submit the end client for verification - Caratuva\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pavezisoftware.mintlify.app/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Submit+the+end+client+for+verification\u0026amp;description=Submit+the+end+client+to+the+settlement+partner+for+KYB+%28business%29+or+KYC+%28individual%29+%E2%80%94+the+path+is+chosen+from+the+stored+%60role%60+%2B+%60entityType%60.+Required+fiel\u0026amp;theme=4451605dc365fc6b8cecb93b\u0026amp;signature=18521b76eb282897e61a9b3685258ba66cde88fb4eda216b1ed99971cb9b2e56\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Caratuva\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/accounts/submit-the-end-client-for-verification.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.caratuva.com/#organization\",\"name\":\"Caratuva\",\"url\":\"https://docs.caratuva.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.caratuva.com#website\",\"name\":\"Caratuva\",\"url\":\"https://docs.caratuva.com\",\"publisher\":{\"@id\":\"https://docs.caratuva.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification#webpage\",\"url\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification\",\"name\":\"Submit the end client for verification\",\"description\":\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.\",\"dateModified\":\"2026-07-07T01:41:07.857Z\",\"isPartOf\":{\"@id\":\"https://docs.caratuva.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.caratuva.com/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Accounts\",\"item\":\"https://docs.caratuva.com/api-reference/accounts/start-buyer-kyc-via-the-settlement-partner\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Submit the end client for verification\",\"item\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification#apireference\",\"headline\":\"Submit the end client for verification\",\"name\":\"Submit the end client for verification\",\"description\":\"Submit the end client to the settlement partner for KYB (business) or KYC (individual) — the path is chosen from the stored role + entityType. Required fields are validated per combination, surfacing a 400 with the missing field paths. Idempotent: while the account is verifying or approved, returns the current submission instead of creating a second receiver.\",\"url\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification\",\"mainEntityOfPage\":{\"@id\":\"https://docs.caratuva.com/api-reference/accounts/submit-the-end-client-for-verification#webpage\"},\"dateModified\":\"2026-07-07T01:41:07.857Z\",\"publisher\":{\"@id\":\"https://docs.caratuva.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.caratuva.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Caratuva\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Caratuva","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Get paid","pages":[{"title":"Get paid","href":"/getpaid/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Environments","href":"/api-reference/environments"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Integration","pages":[{"title":"B2B quickstart","href":"/api-reference/b2b-quickstart"},{"title":"API keys","href":"/api-reference/api-keys"},{"title":"Payment intents","href":"/api-reference/payment-intents"},{"title":"Sellers \u0026 buyers","href":"/api-reference/connected-accounts"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Endpoints","pages":[{"group":"Invoices","pages":[{"title":"List invoices for the caller organization (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices","href":"/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json patch /v1/invoices/{id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/cancel","href":"/api-reference/invoices/cancel-an-invoice"},{"title":"Reassign the buyer on an invoice (useful when KYC is stuck on a consumed TOS token)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/reassign-buyer","href":"/api-reference/invoices/reassign-the-buyer-on-an-invoice-useful-when-kyc-is-stuck-on-a-consumed-tos-token"},{"title":"Invite the buyer","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/invite-buyer","href":"/api-reference/invoices/invite-the-buyer"}]},{"group":"Access","pages":[{"title":"Request production (live mode) access","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/access/request","href":"/api-reference/access/request-production-live-mode-access"},{"title":"Production-access status","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/access/status","href":"/api-reference/access/production-access-status"}]},{"group":"Payments","pages":[{"title":"Create a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments","href":"/api-reference/payments/create-a-payment"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment"},{"title":"Cancel a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments/{id}/cancel","href":"/api-reference/payments/cancel-a-payment"}]},{"group":"Accounts","pages":[{"title":"Start buyer KYC via the settlement partner","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc","href":"/api-reference/accounts/start-buyer-kyc-via-the-settlement-partner"},{"title":"Capture the buyer KYC dossier and deliver a ToS link (async)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/request-tos","href":"/api-reference/accounts/capture-the-buyer-kyc-dossier-and-deliver-a-tos-link-async"},{"title":"Mint a settlement-partner ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-session","href":"/api-reference/accounts/mint-a-settlement-partner-tos-acceptance-session-url"},{"title":"Record the ToS acceptance returned in the redirect","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-accepted","href":"/api-reference/accounts/record-the-tos-acceptance-returned-in-the-redirect"},{"title":"Mint a one-shot signed upload URL for a KYC file","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/upload-url","href":"/api-reference/accounts/mint-a-one-shot-signed-upload-url-for-a-kyc-file"},{"title":"Get latest buyer KYC submission","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/buyer-kyc/{buyerId}","href":"/api-reference/accounts/get-latest-buyer-kyc-submission"},{"title":"List connected accounts (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts","href":"/api-reference/accounts/list-connected-accounts-cursor-paginated"},{"title":"Create a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts","href":"/api-reference/accounts/create-a-connected-account"},{"title":"Get your own (the integrator's) account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self","href":"/api-reference/accounts/get-your-own-the-integrators-account"},{"title":"Get your own PIX payout configuration","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config","href":"/api-reference/accounts/get-your-own-pix-payout-configuration"},{"title":"Register your own (the integrator's) PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json put /v1/accounts/self/payout-config","href":"/api-reference/accounts/register-your-own-the-integrators-pix-payout-destination"},{"title":"Get your own full bank-account details (live)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config/details","href":"/api-reference/accounts/get-your-own-full-bank-account-details-live"},{"title":"Get a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/{id}","href":"/api-reference/accounts/get-a-connected-account"},{"title":"Mint a ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-session","href":"/api-reference/accounts/mint-a-tos-acceptance-session-url"},{"title":"Record a ToS acceptance","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-accepted","href":"/api-reference/accounts/record-a-tos-acceptance"},{"title":"Mint a signed document upload URL","description":"Mint a one-shot signed PUT URL for a single KYC/KYB document, scoped to this connected account. PUT the file to `uploadUrl` with the returned `uploadHeaders`, then reference `publicUrl` in the `/submit` body. Optional — you may instead pass your own pre-hosted HTTPS URLs in the submit body. Returns 503 if file storage is not configured.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/upload-url","href":"/api-reference/accounts/mint-a-signed-document-upload-url"},{"title":"Submit the end client for verification","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification"},{"title":"Register a seller's PIX payout destination","description":"Register a seller end client's PIX payout destination at the settlement partner. The settlement partner infers the PIX key type from its format and returns an opaque bank-account id; Caratuva persists only that id — the raw PIX key is never stored. Sellers only, and the account must be `approved` first (a receiver is required). Configuring this can flip the seller to `readyToCollect`.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/payout-config","href":"/api-reference/accounts/register-a-sellers-pix-payout-destination"},{"title":"Finish onboarding: capture submission and deliver a ToS link to the seller","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/request-tos","href":"/api-reference/accounts/finish-onboarding:-capture-submission-and-deliver-a-tos-link-to-the-seller"},{"title":"Recover a stalled onboarding: re-send the ToS acceptance link","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/resend-tos","href":"/api-reference/accounts/recover-a-stalled-onboarding:-re-send-the-tos-acceptance-link"},{"title":"Retry the provider submission for a customer whose ToS is accepted but whose receiver was never created","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/retry-submit","href":"/api-reference/accounts/retry-the-provider-submission-for-a-customer-whose-tos-is-accepted-but-whose-receiver-was-never-created"},{"title":"List customers (connected accounts + payers)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers","href":"/api-reference/accounts/list-customers-connected-accounts-+-payers"},{"title":"Get a payer (self-signup buyer) detail","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers/payer/{id}","href":"/api-reference/accounts/get-a-payer-self-signup-buyer-detail"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions for this org","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions-for-this-org"},{"title":"Create an outbound webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks","href":"/api-reference/webhooks/create-an-outbound-webhook-subscription"},{"title":"Soft-delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/soft-delete-a-webhook-subscription"},{"title":"List recent delivery attempts for a subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-recent-delivery-attempts-for-a-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"}]},{"group":"Reports","pages":[{"title":"Transfer-pricing report (JSON) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing","href":"/api-reference/reports/transfer-pricing-report-json-for-the-given-quarter"},{"title":"Transfer-pricing report (CSV) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.csv","href":"/api-reference/reports/transfer-pricing-report-csv-for-the-given-quarter"},{"title":"Transfer-pricing report (PDF) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.pdf","href":"/api-reference/reports/transfer-pricing-report-pdf-for-the-given-quarter"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR/introduction"}]},{"tab":"Receba","pages":[{"title":"Receba","href":"/pt-BR/getpaid/introduction"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API","href":"/pt-BR/api-reference/introduction"},{"title":"Autenticação","href":"/pt-BR/api-reference/authentication"},{"title":"Ambientes","href":"/pt-BR/api-reference/environments"},{"title":"Erros","href":"/pt-BR/api-reference/errors"}]},{"group":"Integração","pages":[{"title":"Início rápido B2B","href":"/pt-BR/api-reference/b2b-quickstart"},{"title":"Chaves de API","href":"/pt-BR/api-reference/api-keys"},{"title":"Payment intents","href":"/pt-BR/api-reference/payment-intents"},{"title":"Vendedores e compradores","href":"/pt-BR/api-reference/connected-accounts"},{"title":"Webhooks","href":"/pt-BR/api-reference/webhooks"}]},{"group":"Endpoints","pages":[{"group":"Invoices","pages":[{"title":"List invoices for the caller organization (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices","href":"/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json patch /v1/invoices/{id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/cancel","href":"/api-reference/invoices/cancel-an-invoice"},{"title":"Reassign the buyer on an invoice (useful when KYC is stuck on a consumed TOS token)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/reassign-buyer","href":"/api-reference/invoices/reassign-the-buyer-on-an-invoice-useful-when-kyc-is-stuck-on-a-consumed-tos-token"},{"title":"Invite the buyer","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/invite-buyer","href":"/api-reference/invoices/invite-the-buyer"}]},{"group":"Access","pages":[{"title":"Request production (live mode) access","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/access/request","href":"/api-reference/access/request-production-live-mode-access"},{"title":"Production-access status","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/access/status","href":"/api-reference/access/production-access-status"}]},{"group":"Payments","pages":[{"title":"Create a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments","href":"/api-reference/payments/create-a-payment"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment"},{"title":"Cancel a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments/{id}/cancel","href":"/api-reference/payments/cancel-a-payment"}]},{"group":"Accounts","pages":[{"title":"Start buyer KYC via the settlement partner","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc","href":"/api-reference/accounts/start-buyer-kyc-via-the-settlement-partner"},{"title":"Capture the buyer KYC dossier and deliver a ToS link (async)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/request-tos","href":"/api-reference/accounts/capture-the-buyer-kyc-dossier-and-deliver-a-tos-link-async"},{"title":"Mint a settlement-partner ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-session","href":"/api-reference/accounts/mint-a-settlement-partner-tos-acceptance-session-url"},{"title":"Record the ToS acceptance returned in the redirect","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-accepted","href":"/api-reference/accounts/record-the-tos-acceptance-returned-in-the-redirect"},{"title":"Mint a one-shot signed upload URL for a KYC file","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/upload-url","href":"/api-reference/accounts/mint-a-one-shot-signed-upload-url-for-a-kyc-file"},{"title":"Get latest buyer KYC submission","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/buyer-kyc/{buyerId}","href":"/api-reference/accounts/get-latest-buyer-kyc-submission"},{"title":"List connected accounts (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts","href":"/api-reference/accounts/list-connected-accounts-cursor-paginated"},{"title":"Create a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts","href":"/api-reference/accounts/create-a-connected-account"},{"title":"Get your own (the integrator's) account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self","href":"/api-reference/accounts/get-your-own-the-integrators-account"},{"title":"Get your own PIX payout configuration","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config","href":"/api-reference/accounts/get-your-own-pix-payout-configuration"},{"title":"Register your own (the integrator's) PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json put /v1/accounts/self/payout-config","href":"/api-reference/accounts/register-your-own-the-integrators-pix-payout-destination"},{"title":"Get your own full bank-account details (live)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config/details","href":"/api-reference/accounts/get-your-own-full-bank-account-details-live"},{"title":"Get a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/{id}","href":"/api-reference/accounts/get-a-connected-account"},{"title":"Mint a ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-session","href":"/api-reference/accounts/mint-a-tos-acceptance-session-url"},{"title":"Record a ToS acceptance","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-accepted","href":"/api-reference/accounts/record-a-tos-acceptance"},{"title":"Mint a signed document upload URL","description":"Mint a one-shot signed PUT URL for a single KYC/KYB document, scoped to this connected account. PUT the file to `uploadUrl` with the returned `uploadHeaders`, then reference `publicUrl` in the `/submit` body. Optional — you may instead pass your own pre-hosted HTTPS URLs in the submit body. Returns 503 if file storage is not configured.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/upload-url","href":"/api-reference/accounts/mint-a-signed-document-upload-url"},{"title":"Submit the end client for verification","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification"},{"title":"Register a seller's PIX payout destination","description":"Register a seller end client's PIX payout destination at the settlement partner. The settlement partner infers the PIX key type from its format and returns an opaque bank-account id; Caratuva persists only that id — the raw PIX key is never stored. Sellers only, and the account must be `approved` first (a receiver is required). Configuring this can flip the seller to `readyToCollect`.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/payout-config","href":"/api-reference/accounts/register-a-sellers-pix-payout-destination"},{"title":"Finish onboarding: capture submission and deliver a ToS link to the seller","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/request-tos","href":"/api-reference/accounts/finish-onboarding:-capture-submission-and-deliver-a-tos-link-to-the-seller"},{"title":"Recover a stalled onboarding: re-send the ToS acceptance link","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/resend-tos","href":"/api-reference/accounts/recover-a-stalled-onboarding:-re-send-the-tos-acceptance-link"},{"title":"Retry the provider submission for a customer whose ToS is accepted but whose receiver was never created","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/retry-submit","href":"/api-reference/accounts/retry-the-provider-submission-for-a-customer-whose-tos-is-accepted-but-whose-receiver-was-never-created"},{"title":"List customers (connected accounts + payers)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers","href":"/api-reference/accounts/list-customers-connected-accounts-+-payers"},{"title":"Get a payer (self-signup buyer) detail","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers/payer/{id}","href":"/api-reference/accounts/get-a-payer-self-signup-buyer-detail"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions for this org","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions-for-this-org"},{"title":"Create an outbound webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks","href":"/api-reference/webhooks/create-an-outbound-webhook-subscription"},{"title":"Soft-delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/soft-delete-a-webhook-subscription"},{"title":"List recent delivery attempts for a subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-recent-delivery-attempts-for-a-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"}]},{"group":"Reports","pages":[{"title":"Transfer-pricing report (JSON) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing","href":"/api-reference/reports/transfer-pricing-report-json-for-the-given-quarter"},{"title":"Transfer-pricing report (CSV) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.csv","href":"/api-reference/reports/transfer-pricing-report-csv-for-the-given-quarter"},{"title":"Transfer-pricing report (PDF) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.pdf","href":"/api-reference/reports/transfer-pricing-report-pdf-for-the-given-quarter"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]}]}]}]}]},"title":"Submit the end client for verification - Caratuva","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}