Updates an external bank account’s nickname and/or verification status. Updating verification status requires ‘CanSetExternalBankAccountVerification’ permission.
Token types: APP, USER | Required scopes:external_bank_account:write:org
ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.
Request to update an external bank account. Uses
Tesouro.Common.Types.Rest.Optional<T> with non-nullable inner types — FIS does
not support clearing any of these fields, so absent fields preserve the stored value.
Verification status of the external bank account. Where the bank fails verification on the
first incorrect attempt, FAILED can be recovered while attempts remain. Where it fails at the
attempt limit, or after a returned micro-deposit or a notification of change, FAILED is final.
Why verification failed, when verificationStatus is FAILED.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tesouro","description":"Guides, references, and resources to integrate with the Tesouro platform.","colors":{"primary":"#8b5cf6","light":"#8b5cf6","dark":"#8b5cf6"},"logo":{"light":"https://mintcdn.com/tesouro-dc896113/EiyyRmHDHMxOKA4r/.shared/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=EiyyRmHDHMxOKA4r\u0026q=85\u0026s=7806042ddc87fa143686df9c7b515c71","dark":"https://mintcdn.com/tesouro-dc896113/EiyyRmHDHMxOKA4r/.shared/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=EiyyRmHDHMxOKA4r\u0026q=85\u0026s=055476f7bf095ab7104d5f0dc91bd674"},"favicon":"https://mintcdn.com/tesouro-dc896113/OrJhEQvpoHU_GZRr/.shared/logo/favicon.ico?fit=max\u0026auto=format\u0026n=OrJhEQvpoHU_GZRr\u0026q=85\u0026s=3619a3722b157ddf06545cfe36402ec6","background":{"color":{"dark":"#121212"}},"navbar":{"links":[{"href":"/contact","label":"Support"}]},"fonts":{"family":"Figtree"},"integrations":{"posthog":{"apiKey":"phc_Y5Ie0oFk2jzq4TnDcK0SbVtj7HzeVRUqFoC9hJsOV8j"}},"metadata":{"timestamp":false},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tesouro-dc896113","hasAudioNarration":false,"actualSubdomain":"tesouro-dc896113","customDomains":["docs.tesouro.com"],"gitSource":{"type":"github","owner":"tesourohq","repo":"tesouro.platform.frontends.docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfce3b728ed5a3208384b0","collectionId":"4e256b65-7121-48dc-b374-8d3cbdb7a264","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfce3b728ed5a3208384b0"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfce3b728ed5a3208384b0","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API reference","count":809},{"language":"default","tag":"FinOps","count":486},{"language":"default","tag":"Acquiring","count":330},{"language":"default","tag":"Types","count":318},{"language":"default","tag":"Guides","count":194},{"language":"default","tag":"Underwriting","count":150},{"language":"default","tag":"Accounts receivable","count":113},{"language":"default","tag":"Embedded Banking","count":110},{"language":"default","tag":"Accounts payable","count":62},{"language":"default","tag":"Organization \u0026 access","count":61}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":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":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":".vertical-image img{max-height:400px;width:auto}.no-line-numbers .code-block-line-gutter>span{display:none}.no-line-numbers .code-block-line-content>.line{display:inline-block}#content-area a code{z-index:0!important}svg#mermaid-svg,svg.statediagram{display:block;margin:auto}.method-pill+[data-component-part=scroll-area] [data-component-part=scroll-area-viewport]{direction:rtl}.method-pill+[data-component-part=scroll-area] [data-component-part=scroll-area-viewport]>*{direction:ltr}"}],"page":{"pagePath":"api-reference/external-bank-accounts/update-external-account","slug":"/api-reference/external-bank-accounts/update-external-account","pageMetadata":{"title":"Update external account","description":"Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission.\n\n**Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org`","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /external-bank-accounts/{id}","href":"/api-reference/external-bank-accounts/update-external-account","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Updates an external bank account’s nickname and/or verification status. Updating verification status requires ‘CanSetExternalBankAccountVerification’ permission.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Token types:\"\n }), \" APP, USER | \", _jsx(_components.strong, {\n children: \"Required scopes:\"\n }), \" \", _jsx(_components.code, {\n children: \"external_bank_account:write:org\"\n })]\n })]\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":"Update external account","description":"Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission.\n\n**Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org`","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /external-bank-accounts/{id}","href":"/api-reference/external-bank-accounts/update-external-account","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["External Bank Accounts","Embedded Banking"],"summary":"Update external account","description":"Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission.\n\n**Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org`","operationId":"UpdateExternalBankAccount","parameters":["677d9a7f-10c6-4ae6-95ee-8f3fb6438900","08411548-cfba-4162-ad2d-de78a156aab5"],"requestBody":"f1e0ecf6-12e2-4d6a-b9e3-197acff10b04","responses":{"200":"c0529551-8081-4be3-b829-a1e25207a592","400":"098fca8f-3e81-4f7a-9dbe-380e6c8d1ae7","403":"08d8c7d5-dba8-4e10-9079-b4a0c0ed34a7","404":"f1a39e43-b3cc-408e-a9e2-2efc95f023db","422":"1b062cbb-6742-46ce-b789-3ce5b652a323","500":"a00dd227-9ab8-4e9b-8d29-af184f57d431"},"security":["8835fd00-6b8d-4da8-8ad1-477241e4b257","6ce41d29-6a19-4cd2-94e4-6be3d140f69c"],"method":"patch","type":"path","servers":["0d01cc4d-7bd1-4320-b5de-951e94483a3e"],"path":"/external-bank-accounts/{id}","baseUrlOptions":["https://api.sandbox.tesouro.com/embedded-banking/v1"],"title":"Update external account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"677d9a7f-10c6-4ae6-95ee-8f3fb6438900":{"name":"id","in":"path","description":"The external bank account ID.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The external bank account ID.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"08411548-cfba-4162-ad2d-de78a156aab5":{"name":"X-Organization-ID","in":"header","description":"ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.","schema":{"type":"string","format":"uuid","description":"ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"description":"The update request.","content":{"application/json":{"schema":{"type":"object","properties":{"accountHolderType":{"enum":["INDIVIDUAL","BUSINESS"],"type":"string","description":"Holder of the bank account (individual or business). Absent = preserve.","uniqueKey":"accountHolderType","typeLabel":"enum\u003cstring>"},"nameOnAccount":{"type":"string","description":"New name on the external bank account. Absent = preserve.","uniqueKey":"nameOnAccount","typeLabel":"string"},"nickname":{"type":"string","description":"New nickname for the external bank account. Absent = preserve.","uniqueKey":"nickname","typeLabel":"string"},"verification":{"required":["method"],"type":"object","properties":{"method":{"enum":["MICRO_DEPOSIT","MANUAL"],"type":"string","description":"The method used to verify the external bank account.","isRequired":true,"uniqueKey":"verification.method","typeLabel":"enum\u003cstring>"}},"description":"Verification status update. Requires 'CanSetExternalBankAccountVerification' permission. Absent = preserve.","uniqueKey":"verification","typeLabel":"object"}},"description":"Request to update an external bank account. Uses\n`Tesouro.Common.Types.Rest.Optional\u0026lt;T\u0026gt;` with non-nullable inner types — FIS does\nnot support clearing any of these fields, so absent fields preserve the stored value.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"nameOnAccount":"\u003cstring>","nickname":"\u003cstring>"}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"accountHolderType":{"enum":["INDIVIDUAL","BUSINESS"],"type":"string","description":"Holder of the bank account (individual or business). Absent = preserve.","uniqueKey":"accountHolderType","typeLabel":"enum\u003cstring>"},"nameOnAccount":{"type":"string","description":"New name on the external bank account. Absent = preserve.","uniqueKey":"nameOnAccount","typeLabel":"string"},"nickname":{"type":"string","description":"New nickname for the external bank account. Absent = preserve.","uniqueKey":"nickname","typeLabel":"string"},"verification":{"required":["method"],"type":"object","properties":{"method":{"enum":["MICRO_DEPOSIT","MANUAL"],"type":"string","description":"The method used to verify the external bank account.","isRequired":true,"uniqueKey":"verification.method","typeLabel":"enum\u003cstring>"}},"description":"Verification status update. Requires 'CanSetExternalBankAccountVerification' permission. Absent = preserve.","uniqueKey":"verification","typeLabel":"object"}},"description":"Request to update an external bank account. Uses\n`Tesouro.Common.Types.Rest.Optional\u0026lt;T\u0026gt;` with non-nullable inner types — FIS does\nnot support clearing any of these fields, so absent fields preserve the stored value.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"nameOnAccount":"\u003cstring>","nickname":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"c0529551-8081-4be3-b829-a1e25207a592":{"description":"External bank account updated.","content":{"application/json":{"schema":{"required":["id","accountNumber","routingNumber","nickname","type","verificationStatus","accountStatus","nameOnAccount"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the external bank account.","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"accountNumber":{"type":"string","description":"Masked account number (last 4 digits visible).","isRequired":true,"uniqueKey":"accountNumber","typeLabel":"string"},"accountStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","description":"Status of the external bank account.","isRequired":true,"uniqueKey":"accountStatus","typeLabel":"enum\u003cstring>"},"nameOnAccount":{"type":"string","description":"Name on the bank account.","isRequired":true,"uniqueKey":"nameOnAccount","typeLabel":"string"},"nickname":{"type":"string","description":"Nickname for the external bank account.","isRequired":true,"uniqueKey":"nickname","typeLabel":"string"},"routingNumber":{"type":"string","description":"Bank routing number (ABA number).","isRequired":true,"uniqueKey":"routingNumber","typeLabel":"string"},"type":{"enum":["CHECKING","SAVINGS"],"type":"string","description":"Type of bank account (checking or savings).","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"verificationStatus":{"enum":["UNVERIFIED","VERIFICATION_SENT","VERIFIED","FAILED"],"type":"string","description":"Verification status of the external bank account. Where the bank fails verification on the\nfirst incorrect attempt, FAILED can be recovered while attempts remain. Where it fails at the\nattempt limit, or after a returned micro-deposit or a notification of change, FAILED is final.","isRequired":true,"uniqueKey":"verificationStatus","typeLabel":"enum\u003cstring>"},"accountHolderType":{"oneOf":[{"type":"null","uniqueKey":"accountHolderType.oneOf.0","typeLabel":"null"},{"type":"string","description":"Holder of the bank account (individual or business).","enum":["INDIVIDUAL","BUSINESS"],"uniqueKey":"accountHolderType.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"accountHolderType","typeLabel":"null | enum\u003cstring>"},"microDepositVerification":{"oneOf":[{"type":"null","uniqueKey":"microDepositVerification.oneOf.0","typeLabel":"null"},{"type":"object","description":"Result of the micro-deposit validation attempt. Returned by the validate endpoint only.","required":["outcome","attemptsAllowed","attemptsRemaining","canAttemptAgain","isTerminal"],"properties":{"attemptsAllowed":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","description":"The maximum number of validation attempts this account's bank allows.","format":"int32","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsAllowed.oneOf.0","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","description":"The maximum number of validation attempts this account's bank allows.","format":"int32","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsAllowed.oneOf.1","typeLabel":"string\u003cint32>"}],"isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsAllowed","typeLabel":"integer\u003cint32> | string\u003cint32>"},"attemptsRemaining":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","description":"Validation attempts left after this one.","format":"int32","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsRemaining.oneOf.0","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","description":"Validation attempts left after this one.","format":"int32","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsRemaining.oneOf.1","typeLabel":"string\u003cint32>"}],"isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.attemptsRemaining","typeLabel":"integer\u003cint32> | string\u003cint32>"},"canAttemptAgain":{"type":"boolean","description":"Whether another set of amounts would be accepted for this account.","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.canAttemptAgain","typeLabel":"boolean"},"isTerminal":{"type":"boolean","description":"Whether the bank's policy makes FAILED final. Banks that fail on the first incorrect attempt\nalways report false; canAttemptAgain reports whether the allowance is spent.","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.isTerminal","typeLabel":"boolean"},"outcome":{"enum":["AMOUNTS_MATCHED","AMOUNTS_DID_NOT_MATCH"],"type":"string","description":"Whether the submitted amounts matched the ones deposited.","isRequired":true,"uniqueKey":"microDepositVerification.oneOf.1.outcome","typeLabel":"enum\u003cstring>"}},"uniqueKey":"microDepositVerification.oneOf.1","typeLabel":"object"}],"uniqueKey":"microDepositVerification","typeLabel":"null | object"},"suspension":{"oneOf":[{"type":"null","uniqueKey":"suspension.oneOf.0","typeLabel":"null"},{"type":"object","description":"Why no payment may be sent to or taken from the account, or null when it is usable.","required":["suspendedAt"],"properties":{"suspendedAt":{"type":"string","description":"When the account was suspended.","format":"date-time","isRequired":true,"uniqueKey":"suspension.oneOf.1.suspendedAt","typeLabel":"string\u003cdate-time>"},"reason":{"oneOf":[{"type":"null","uniqueKey":"suspension.oneOf.1.reason.oneOf.0","typeLabel":"null"},{"type":"string","description":"What suspended the account.","enum":["PAYMENT_RETURNED","CORRECTION_NOT_APPLIED"],"uniqueKey":"suspension.oneOf.1.reason.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"suspension.oneOf.1.reason","typeLabel":"null | enum\u003cstring>"},"returnCategory":{"oneOf":[{"type":"null","uniqueKey":"suspension.oneOf.1.returnCategory.oneOf.0","typeLabel":"null"},{"type":"string","description":"Why the payment was returned, suitable for showing to the account holder.","enum":["ACCOUNT_CLOSED","INVALID_ACCOUNT_DETAILS","ACCOUNT_CANNOT_RECEIVE","REFUSED_BY_RECEIVER","GENERIC"],"uniqueKey":"suspension.oneOf.1.returnCategory.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"suspension.oneOf.1.returnCategory","typeLabel":"null | enum\u003cstring>"}},"uniqueKey":"suspension.oneOf.1","typeLabel":"object"}],"uniqueKey":"suspension","typeLabel":"null | object"},"verificationFailure":{"oneOf":[{"type":"null","uniqueKey":"verificationFailure.oneOf.0","typeLabel":"null"},{"type":"object","description":"Why verification failed, when verificationStatus is FAILED.","required":["reason","incorrectDetails"],"properties":{"incorrectDetails":{"type":"array","items":{"enum":["ROUTING_NUMBER","ACCOUNT_NUMBER","ACCOUNT_TYPE"],"type":"string","description":"A detail held for an external bank account.","uniqueKey":"verificationFailure.oneOf.1.incorrectDetails.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The details the receiving bank reported as wrong, when reason is ACCOUNT_DETAILS_INCORRECT;\notherwise empty. Re-link the account with these corrected.","isRequired":true,"uniqueKey":"verificationFailure.oneOf.1.incorrectDetails","typeLabel":"enum\u003cstring>[]"},"reason":{"enum":["AMOUNTS_DID_NOT_MATCH","MICRO_DEPOSITS_RETURNED","ACCOUNT_DETAILS_INCORRECT"],"type":"string","description":"Which of the three kinds of failure this was.","isRequired":true,"uniqueKey":"verificationFailure.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"returnCategory":{"oneOf":[{"type":"null","uniqueKey":"verificationFailure.oneOf.1.returnCategory.oneOf.0","typeLabel":"null"},{"type":"string","description":"Why the micro-deposits came back, when reason is MICRO_DEPOSITS_RETURNED.","enum":["ACCOUNT_CLOSED","INVALID_ACCOUNT_DETAILS","ACCOUNT_CANNOT_RECEIVE","REFUSED_BY_RECEIVER","GENERIC"],"uniqueKey":"verificationFailure.oneOf.1.returnCategory.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"verificationFailure.oneOf.1.returnCategory","typeLabel":"null | enum\u003cstring>"}},"uniqueKey":"verificationFailure.oneOf.1","typeLabel":"object"}],"uniqueKey":"verificationFailure","typeLabel":"null | object"}},"description":"Response representing an external bank account.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountNumber":"\u003cstring>","accountStatus":"ACTIVE","nameOnAccount":"\u003cstring>","nickname":"\u003cstring>","routingNumber":"\u003cstring>","type":"CHECKING","verificationStatus":"UNVERIFIED","accountHolderType":"INDIVIDUAL","microDepositVerification":{"attemptsAllowed":123,"attemptsRemaining":123,"canAttemptAgain":true,"isTerminal":true,"outcome":"AMOUNTS_MATCHED"},"suspension":{"suspendedAt":"2023-11-07T05:31:56Z","reason":"PAYMENT_RETURNED","returnCategory":"ACCOUNT_CLOSED"},"verificationFailure":{"incorrectDetails":["ROUTING_NUMBER"],"reason":"AMOUNTS_DID_NOT_MATCH","returnCategory":"ACCOUNT_CLOSED"}}}},"exampleType":"generated"}},"exampleType":"generated"},"098fca8f-3e81-4f7a-9dbe-380e6c8d1ae7":{"description":"Invalid request.","content":{"application/json":{"schema":{"required":["errorCode"],"type":"object","properties":{"errorCode":{"type":"string","description":"Embed-specific error code for client error handling.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"detail":{"oneOf":[{"type":"null","uniqueKey":"detail.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"detail.oneOf.1","typeLabel":"string"}],"uniqueKey":"detail","typeLabel":"null | string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors","typeLabel":"object"},"instance":{"oneOf":[{"type":"null","uniqueKey":"instance.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"instance.oneOf.1","typeLabel":"string"}],"uniqueKey":"instance","typeLabel":"null | string"},"questionErrors":{"oneOf":[{"type":"null","items":{"required":["code","message"],"type":"object","properties":{"code":{"enum":["REQUIRED","TOO_LONG","TOO_SHORT","OUT_OF_RANGE","BAD_FORMAT","NOT_IN_ENUM","OWNERSHIP_EXCEEDS_100","KYC_NOT_APPROVED","APPLICATION_ALREADY_PROCESSED","UNKNOWN_OWNER"],"type":"string","description":"Why the question failed."},"itemPath":{"oneOf":[{"type":"null","description":"Where inside an array-valued answer the failure is, relative to the question, such as\n`[0].name`."},{"type":"string","description":"Where inside an array-valued answer the failure is, relative to the question, such as\n`[0].name`."}]},"key":{"oneOf":[{"type":"null","description":"The question's stable key. Null when no single question owns the failure."},{"type":"string","description":"The question's stable key. Null when no single question owns the failure."}]},"message":{"type":"string","description":"A readable description of the failure, for display. Its wording is not part of the contract."},"ownerId":{"oneOf":[{"type":"null","description":"The owner whose answer failed. Present for per-owner questions only.","format":"uuid"},{"type":"string","description":"The owner whose answer failed. Present for per-owner questions only.","format":"uuid"}]}},"description":"One application question that failed validation."},"description":"The application questions that failed. Null when the endpoint validates no application questions.","uniqueKey":"questionErrors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["code","message"],"type":"object","properties":{"code":{"enum":["REQUIRED","TOO_LONG","TOO_SHORT","OUT_OF_RANGE","BAD_FORMAT","NOT_IN_ENUM","OWNERSHIP_EXCEEDS_100","KYC_NOT_APPROVED","APPLICATION_ALREADY_PROCESSED","UNKNOWN_OWNER"],"type":"string","description":"Why the question failed.","isRequired":true,"uniqueKey":"questionErrors.oneOf.1.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A readable description of the failure, for display. Its wording is not part of the contract.","isRequired":true,"uniqueKey":"questionErrors.oneOf.1.items.[INDEX].message","typeLabel":"string"},"itemPath":{"oneOf":[{"type":"null","description":"Where inside an array-valued answer the failure is, relative to the question, such as\n`[0].name`.","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].itemPath.oneOf.0","typeLabel":"null"},{"type":"string","description":"Where inside an array-valued answer the failure is, relative to the question, such as\n`[0].name`.","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].itemPath.oneOf.1","typeLabel":"string"}],"uniqueKey":"questionErrors.oneOf.1.items.[INDEX].itemPath","typeLabel":"null | string"},"key":{"oneOf":[{"type":"null","description":"The question's stable key. Null when no single question owns the failure.","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].key.oneOf.0","typeLabel":"null"},{"type":"string","description":"The question's stable key. Null when no single question owns the failure.","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].key.oneOf.1","typeLabel":"string"}],"uniqueKey":"questionErrors.oneOf.1.items.[INDEX].key","typeLabel":"null | string"},"ownerId":{"oneOf":[{"type":"null","description":"The owner whose answer failed. Present for per-owner questions only.","format":"uuid","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].ownerId.oneOf.0","typeLabel":"null"},{"type":"string","description":"The owner whose answer failed. Present for per-owner questions only.","format":"uuid","uniqueKey":"questionErrors.oneOf.1.items.[INDEX].ownerId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"questionErrors.oneOf.1.items.[INDEX].ownerId","typeLabel":"null | string\u003cuuid>"}},"description":"One application question that failed validation.","uniqueKey":"questionErrors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The application questions that failed. Null when the endpoint validates no application questions.","uniqueKey":"questionErrors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"questionErrors","typeLabel":"null | object[]"},"requirementsVersion":{"oneOf":[{"type":"null","description":"The application requirements version the request was validated against. Null when none applies.","uniqueKey":"requirementsVersion.oneOf.0","typeLabel":"null"},{"type":"string","description":"The application requirements version the request was validated against. Null when none applies.","uniqueKey":"requirementsVersion.oneOf.1","typeLabel":"string"}],"uniqueKey":"requirementsVersion","typeLabel":"null | string"},"status":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"null","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","format":"int32","uniqueKey":"status.oneOf.2","typeLabel":"string\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32> | string\u003cint32>"},"title":{"oneOf":[{"type":"null","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"type":{"oneOf":[{"type":"null","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"}},"description":"Problem details for a request the service rejected as invalid.\nFollows RFC 7807, with the Embed error code and the fields and questions that failed.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","detail":"\u003cstring>","errors":{},"instance":"\u003cstring>","questionErrors":[{"code":"REQUIRED","message":"\u003cstring>","itemPath":"\u003cstring>","key":"\u003cstring>","ownerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"requirementsVersion":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"08d8c7d5-dba8-4e10-9079-b4a0c0ed34a7":{"description":"Insufficient permissions for verification update.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"null","uniqueKey":"detail.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"detail.oneOf.1","typeLabel":"string"}],"uniqueKey":"detail","typeLabel":"null | string"},"errorCode":{"oneOf":[{"type":"null","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"errorCode","typeLabel":"null | string"},"instance":{"oneOf":[{"type":"null","uniqueKey":"instance.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"instance.oneOf.1","typeLabel":"string"}],"uniqueKey":"instance","typeLabel":"null | string"},"status":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"null","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","format":"int32","uniqueKey":"status.oneOf.2","typeLabel":"string\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32> | string\u003cint32>"},"title":{"oneOf":[{"type":"null","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"type":{"oneOf":[{"type":"null","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"}},"description":"Extended ProblemDetails with Embed-specific error code.\nFollows RFC 7807 with additional error code field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","errorCode":"\u003cstring>","instance":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f1a39e43-b3cc-408e-a9e2-2efc95f023db":{"description":"External bank account not found.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"null","uniqueKey":"detail.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"detail.oneOf.1","typeLabel":"string"}],"uniqueKey":"detail","typeLabel":"null | string"},"errorCode":{"oneOf":[{"type":"null","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"errorCode","typeLabel":"null | string"},"instance":{"oneOf":[{"type":"null","uniqueKey":"instance.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"instance.oneOf.1","typeLabel":"string"}],"uniqueKey":"instance","typeLabel":"null | string"},"status":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"null","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","format":"int32","uniqueKey":"status.oneOf.2","typeLabel":"string\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32> | string\u003cint32>"},"title":{"oneOf":[{"type":"null","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"type":{"oneOf":[{"type":"null","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"}},"description":"Extended ProblemDetails with Embed-specific error code.\nFollows RFC 7807 with additional error code field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","errorCode":"\u003cstring>","instance":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1b062cbb-6742-46ce-b789-3ce5b652a323":{"description":"The bank's micro-deposit configuration could not be read, or its banking core cannot rename external bank accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"null","uniqueKey":"detail.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"detail.oneOf.1","typeLabel":"string"}],"uniqueKey":"detail","typeLabel":"null | string"},"errorCode":{"oneOf":[{"type":"null","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"errorCode","typeLabel":"null | string"},"instance":{"oneOf":[{"type":"null","uniqueKey":"instance.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"instance.oneOf.1","typeLabel":"string"}],"uniqueKey":"instance","typeLabel":"null | string"},"status":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"null","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","format":"int32","uniqueKey":"status.oneOf.2","typeLabel":"string\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32> | string\u003cint32>"},"title":{"oneOf":[{"type":"null","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"type":{"oneOf":[{"type":"null","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"}},"description":"Extended ProblemDetails with Embed-specific error code.\nFollows RFC 7807 with additional error code field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","errorCode":"\u003cstring>","instance":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a00dd227-9ab8-4e9b-8d29-af184f57d431":{"description":"The stored micro-deposit state could not be read back.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{"type":"null","uniqueKey":"detail.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"detail.oneOf.1","typeLabel":"string"}],"uniqueKey":"detail","typeLabel":"null | string"},"errorCode":{"oneOf":[{"type":"null","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Embed-specific error code for client error handling.\nStored in the Extensions dictionary to ensure proper JSON serialization.","uniqueKey":"errorCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"errorCode","typeLabel":"null | string"},"instance":{"oneOf":[{"type":"null","uniqueKey":"instance.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"instance.oneOf.1","typeLabel":"string"}],"uniqueKey":"instance","typeLabel":"null | string"},"status":{"oneOf":[{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"null","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"},{"pattern":"^-?(?:0|[1-9]\\d*)$","type":"string","format":"int32","uniqueKey":"status.oneOf.2","typeLabel":"string\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32> | string\u003cint32>"},"title":{"oneOf":[{"type":"null","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"type":{"oneOf":[{"type":"null","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"}},"description":"Extended ProblemDetails with Embed-specific error code.\nFollows RFC 7807 with additional error code field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","errorCode":"\u003cstring>","instance":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8835fd00-6b8d-4da8-8ad1-477241e4b257":{"APPToken":{"type":"oauth2","description":"Application (M2M) OAuth2 access token (client credentials).","flows":{"clientCredentials":{"tokenUrl":"/connect/token","scopes":{"acceptor:application:read":"View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information.","acceptor:application:secondaryapproval":"Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review.","acceptor:application:write":"Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents.","accounting_config:read:org":"View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization.","accounting_config:write:org":"Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization.","acquiring:report:read":"View transaction and settlement reports for your acquiring activity.","approval_policy:read:org":"View approval workflows and spending policies configured for your organization.","approval_policy:write:org":"Create and update approval workflows and spending policies for your organization.","approval_request:create:org":"Submit items for approval within your organization's approval workflows.","approval_request:delete:org":"Delete approval requests within your organization.","approval_request:read:org":"View pending and completed approval requests across your organization.","approval_request:update:org":"Edit and update existing approval requests within your organization.","authorization_control:read:org":"Read access to authorization control at the organization level.","authorization_control:write:org":"Write access to authorization control at the organization level.","bank_account_application:read:org":"View submitted applications to open bank accounts within your organization.","bank_account_application:write:org":"Submit and manage applications to open new bank accounts within your organization.","bank_account:read:org":"View bank account details and balances within your organization.","bank_account:write:org":"Create, update, and close bank accounts within your organization.","beneficial_owner:read:org":"View beneficial ownership information, including individuals' ownership stakes and identifying details.","check_deposit:write:org":"Deposit checks into bank accounts within your organization by submitting the check details for processing.","comment:read:org":"View comments and notes added to financial records across your organization.","comment:write:org":"Add and manage comments and notes on financial records across your organization.","counterpart:read:org":"View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","counterpart:write:org":"Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","credit_card:activate:org":"Activate newly issued credit cards for use within your organization.","credit_card_application:read:org":"View credit card applications submitted within your organization.","credit_card_application:write:org":"Submit and manage credit card applications within your organization.","credit_card:issue:org":"Issue new credit cards for cardholders in your organization.","credit_card:read:org":"View credit card details and status for cards in your organization.","debit_card:activate:org":"Activate newly issued debit cards for use within your organization.","debit_card:close:org":"Permanently close debit cards in your organization.","debit_card:issue:org":"Issue new debit cards for cardholders in your organization.","debit_card:lock:org":"Lock or unlock debit cards in your organization.","debit_card:read:org":"View debit card details and status for cards in your organization.","developer_portal":"Access the Tesouro Developer Portal to view API documentation and manage developer resources.","dispute:read":"View payment disputes and any supporting documents attached to them.","dispute:write":"Accept or challenge payment disputes by uploading and submitting supporting evidence.","email":"","expense:approve:org":"Review and approve or reject expense reports submitted across your organization.","expense:read:org":"View expense reports and submissions across your organization.","expense:read:self":"View your own expense submissions and reports.","expense:write:org":"Create and update expense submissions across your organization.","expense:write:self":"Submit and update your own expense reports.","export:read:org":"View and download previously generated data exports for your organization.","export:write:org":"Generate and manage data exports for your organization.","external_bank_account:micro_deposit:org":"Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization.","external_bank_account:read:org":"View external bank accounts that have been linked to your organization.","external_bank_account:set_verification:org":"Manually set the verification status of linked external bank accounts, bypassing the standard verification process.","external_bank_account:write:org":"Add, update, or remove external bank accounts linked to your organization.","instant_payment_limit:write:org":"Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it.","invoice:read:org":"View invoices issued and received across your organization.","invoice:write:org":"Create, edit, and manage invoices across your organization.","mailbox:read:org":"View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization.","mailbox:write:org":"Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization.","notification:subscription:read":"View active webhook and event notification subscriptions and their configurations.","notification:subscription:write":"Create, update, and delete webhook and event notification subscriptions.","ocr_task:read:org":"View the results and status of automated receipt and invoice scanning tasks.","ocr_task:write:org":"Submit and manage automated receipt and invoice scanning tasks for your organization.","offline_access":"","oidc:app:manage":"Add, edit, and remove access to OIDC applications and their scopes.","oidc:app:read":"Read only access to the OIDC applications and their scopes","oidc:app:write":"Add and edit - but not remove - access to OIDC applications and their scopes","openid":"","organization:read:org":"View your organization's profile and general details.","organization_settings:read:org":"View configuration settings for your organization.","organization_settings:write:org":"Update configuration settings for your organization.","organization:write:org":"Update your organization's profile and general details.","org:write:all":"Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators.","partner_portal":"Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations.","payable:approve:org":"Review and approve bills and accounts payable before they are paid.","payable:pay:org":"Authorize and submit payments for approved bills and accounts payable.","payable:read:org":"View bills and accounts payable across your organization.","payable:write:org":"Create and update bills and accounts payable across your organization.","payment:collect:org":"Collect payments for your organization by depositing them and recording them against the invoices they pay.","payment_link:write":"Generate and manage shareable payment links to collect payments from customers.","payment_processing":"","payment_rail:ach":"Process payments via the ACH (Automated Clearing House) network.","payment_rail:fednow":"Process instant payments via the FedNow network.","payment_rail:rtp":"Process real-time payments via the RTP network.","payment_record:read:org":"View payment transaction history and records for your organization.","payment_record:write:org":"Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing.","product:read:org":"View the product and service catalog used for invoicing within your organization.","product:write:org":"Add and update products and services in your organization's invoicing catalog.","profile":"","role:read:org":"View user roles and their associated permissions within your organization.","role:write:org":"Create and update user roles and permission sets within your organization.","transfer:write:org":"Create and submit money transfers within your organization.","underwriting:account:read":"View underwriting accounts and their account event history.","underwriting:account:write":"Open maintenance reviews on underwriting accounts and close underwriting accounts.","underwriting:application:approval:escalation":"Provide a senior-level escalation approval on underwriting applications that require additional review.","underwriting:application:approval:secondary":"Provide a second-level approval on underwriting applications as part of a multi-step review process.","underwriting:application:read":"View underwriting applications, including sensitive business details and personally identifiable information.","underwriting:application:write":"Edit, approve, and manage underwriting applications and decisions, and attach supporting documents.","user_profile:write:all":"Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators.","user_profile:write:self":"Update your own user profile, including your name, contact information, and preferences.","user:read:org":"View user accounts and their details within your organization.","user:read:self":"Read access to the user's own record and the name/email of their direct reports.","user:write:all":"Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators.","user:write:org":"Create, update, and manage user accounts within your organization."}}},"scopes":["external_bank_account:write:org"],"schemeName":"APPToken"}},"6ce41d29-6a19-4cd2-94e4-6be3d140f69c":{"USERToken":{"type":"oauth2","description":"User OAuth2 access token (authorization code with PKCE).","flows":{"authorizationCode":{"authorizationUrl":"/connect/authorize","tokenUrl":"/connect/token","scopes":{"acceptor:application:read":"View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information.","acceptor:application:secondaryapproval":"Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review.","acceptor:application:write":"Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents.","accounting_config:read:org":"View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization.","accounting_config:write:org":"Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization.","acquiring:report:read":"View transaction and settlement reports for your acquiring activity.","approval_policy:read:org":"View approval workflows and spending policies configured for your organization.","approval_policy:write:org":"Create and update approval workflows and spending policies for your organization.","approval_request:create:org":"Submit items for approval within your organization's approval workflows.","approval_request:delete:org":"Delete approval requests within your organization.","approval_request:read:org":"View pending and completed approval requests across your organization.","approval_request:update:org":"Edit and update existing approval requests within your organization.","authorization_control:read:org":"Read access to authorization control at the organization level.","authorization_control:write:org":"Write access to authorization control at the organization level.","bank_account_application:read:org":"View submitted applications to open bank accounts within your organization.","bank_account_application:write:org":"Submit and manage applications to open new bank accounts within your organization.","bank_account:read:org":"View bank account details and balances within your organization.","bank_account:write:org":"Create, update, and close bank accounts within your organization.","beneficial_owner:read:org":"View beneficial ownership information, including individuals' ownership stakes and identifying details.","check_deposit:write:org":"Deposit checks into bank accounts within your organization by submitting the check details for processing.","comment:read:org":"View comments and notes added to financial records across your organization.","comment:write:org":"Add and manage comments and notes on financial records across your organization.","counterpart:read:org":"View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","counterpart:write:org":"Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","credit_card:activate:org":"Activate newly issued credit cards for use within your organization.","credit_card_application:read:org":"View credit card applications submitted within your organization.","credit_card_application:write:org":"Submit and manage credit card applications within your organization.","credit_card:issue:org":"Issue new credit cards for cardholders in your organization.","credit_card:read:org":"View credit card details and status for cards in your organization.","debit_card:activate:org":"Activate newly issued debit cards for use within your organization.","debit_card:close:org":"Permanently close debit cards in your organization.","debit_card:issue:org":"Issue new debit cards for cardholders in your organization.","debit_card:lock:org":"Lock or unlock debit cards in your organization.","debit_card:read:org":"View debit card details and status for cards in your organization.","developer_portal":"Access the Tesouro Developer Portal to view API documentation and manage developer resources.","dispute:read":"View payment disputes and any supporting documents attached to them.","dispute:write":"Accept or challenge payment disputes by uploading and submitting supporting evidence.","email":"","expense:approve:org":"Review and approve or reject expense reports submitted across your organization.","expense:read:org":"View expense reports and submissions across your organization.","expense:read:self":"View your own expense submissions and reports.","expense:write:org":"Create and update expense submissions across your organization.","expense:write:self":"Submit and update your own expense reports.","export:read:org":"View and download previously generated data exports for your organization.","export:write:org":"Generate and manage data exports for your organization.","external_bank_account:micro_deposit:org":"Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization.","external_bank_account:read:org":"View external bank accounts that have been linked to your organization.","external_bank_account:set_verification:org":"Manually set the verification status of linked external bank accounts, bypassing the standard verification process.","external_bank_account:write:org":"Add, update, or remove external bank accounts linked to your organization.","instant_payment_limit:write:org":"Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it.","invoice:read:org":"View invoices issued and received across your organization.","invoice:write:org":"Create, edit, and manage invoices across your organization.","mailbox:read:org":"View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization.","mailbox:write:org":"Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization.","notification:subscription:read":"View active webhook and event notification subscriptions and their configurations.","notification:subscription:write":"Create, update, and delete webhook and event notification subscriptions.","ocr_task:read:org":"View the results and status of automated receipt and invoice scanning tasks.","ocr_task:write:org":"Submit and manage automated receipt and invoice scanning tasks for your organization.","offline_access":"","oidc:app:manage":"Add, edit, and remove access to OIDC applications and their scopes.","oidc:app:read":"Read only access to the OIDC applications and their scopes","oidc:app:write":"Add and edit - but not remove - access to OIDC applications and their scopes","openid":"","organization:read:org":"View your organization's profile and general details.","organization_settings:read:org":"View configuration settings for your organization.","organization_settings:write:org":"Update configuration settings for your organization.","organization:write:org":"Update your organization's profile and general details.","org:write:all":"Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators.","partner_portal":"Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations.","payable:approve:org":"Review and approve bills and accounts payable before they are paid.","payable:pay:org":"Authorize and submit payments for approved bills and accounts payable.","payable:read:org":"View bills and accounts payable across your organization.","payable:write:org":"Create and update bills and accounts payable across your organization.","payment:collect:org":"Collect payments for your organization by depositing them and recording them against the invoices they pay.","payment_link:write":"Generate and manage shareable payment links to collect payments from customers.","payment_processing":"","payment_rail:ach":"Process payments via the ACH (Automated Clearing House) network.","payment_rail:fednow":"Process instant payments via the FedNow network.","payment_rail:rtp":"Process real-time payments via the RTP network.","payment_record:read:org":"View payment transaction history and records for your organization.","payment_record:write:org":"Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing.","product:read:org":"View the product and service catalog used for invoicing within your organization.","product:write:org":"Add and update products and services in your organization's invoicing catalog.","profile":"","role:read:org":"View user roles and their associated permissions within your organization.","role:write:org":"Create and update user roles and permission sets within your organization.","transfer:write:org":"Create and submit money transfers within your organization.","underwriting:account:read":"View underwriting accounts and their account event history.","underwriting:account:write":"Open maintenance reviews on underwriting accounts and close underwriting accounts.","underwriting:application:approval:escalation":"Provide a senior-level escalation approval on underwriting applications that require additional review.","underwriting:application:approval:secondary":"Provide a second-level approval on underwriting applications as part of a multi-step review process.","underwriting:application:read":"View underwriting applications, including sensitive business details and personally identifiable information.","underwriting:application:write":"Edit, approve, and manage underwriting applications and decisions, and attach supporting documents.","user_profile:write:all":"Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators.","user_profile:write:self":"Update your own user profile, including your name, contact information, and preferences.","user:read:org":"View user accounts and their details within your organization.","user:read:self":"Read access to the user's own record and the name/email of their direct reports.","user:write:all":"Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators.","user:write:org":"Create, update, and manage user accounts within your organization."}}},"scopes":["external_bank_account:write:org"],"schemeName":"USERToken"}}},"servers":{"0d01cc4d-7bd1-4320-b5de-951e94483a3e":{"url":"https://api.sandbox.tesouro.com/embedded-banking/v1","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"Application (M2M) OAuth2 access token (client credentials).","flows":{"clientCredentials":{"tokenUrl":"/connect/token","scopes":{"acceptor:application:read":"View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information.","acceptor:application:secondaryapproval":"Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review.","acceptor:application:write":"Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents.","accounting_config:read:org":"View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization.","accounting_config:write:org":"Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization.","acquiring:report:read":"View transaction and settlement reports for your acquiring activity.","approval_policy:read:org":"View approval workflows and spending policies configured for your organization.","approval_policy:write:org":"Create and update approval workflows and spending policies for your organization.","approval_request:create:org":"Submit items for approval within your organization's approval workflows.","approval_request:delete:org":"Delete approval requests within your organization.","approval_request:read:org":"View pending and completed approval requests across your organization.","approval_request:update:org":"Edit and update existing approval requests within your organization.","authorization_control:read:org":"Read access to authorization control at the organization level.","authorization_control:write:org":"Write access to authorization control at the organization level.","bank_account_application:read:org":"View submitted applications to open bank accounts within your organization.","bank_account_application:write:org":"Submit and manage applications to open new bank accounts within your organization.","bank_account:read:org":"View bank account details and balances within your organization.","bank_account:write:org":"Create, update, and close bank accounts within your organization.","beneficial_owner:read:org":"View beneficial ownership information, including individuals' ownership stakes and identifying details.","check_deposit:write:org":"Deposit checks into bank accounts within your organization by submitting the check details for processing.","comment:read:org":"View comments and notes added to financial records across your organization.","comment:write:org":"Add and manage comments and notes on financial records across your organization.","counterpart:read:org":"View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","counterpart:write:org":"Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","credit_card:activate:org":"Activate newly issued credit cards for use within your organization.","credit_card_application:read:org":"View credit card applications submitted within your organization.","credit_card_application:write:org":"Submit and manage credit card applications within your organization.","credit_card:issue:org":"Issue new credit cards for cardholders in your organization.","credit_card:read:org":"View credit card details and status for cards in your organization.","debit_card:activate:org":"Activate newly issued debit cards for use within your organization.","debit_card:close:org":"Permanently close debit cards in your organization.","debit_card:issue:org":"Issue new debit cards for cardholders in your organization.","debit_card:lock:org":"Lock or unlock debit cards in your organization.","debit_card:read:org":"View debit card details and status for cards in your organization.","developer_portal":"Access the Tesouro Developer Portal to view API documentation and manage developer resources.","dispute:read":"View payment disputes and any supporting documents attached to them.","dispute:write":"Accept or challenge payment disputes by uploading and submitting supporting evidence.","email":"","expense:approve:org":"Review and approve or reject expense reports submitted across your organization.","expense:read:org":"View expense reports and submissions across your organization.","expense:read:self":"View your own expense submissions and reports.","expense:write:org":"Create and update expense submissions across your organization.","expense:write:self":"Submit and update your own expense reports.","export:read:org":"View and download previously generated data exports for your organization.","export:write:org":"Generate and manage data exports for your organization.","external_bank_account:micro_deposit:org":"Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization.","external_bank_account:read:org":"View external bank accounts that have been linked to your organization.","external_bank_account:set_verification:org":"Manually set the verification status of linked external bank accounts, bypassing the standard verification process.","external_bank_account:write:org":"Add, update, or remove external bank accounts linked to your organization.","instant_payment_limit:write:org":"Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it.","invoice:read:org":"View invoices issued and received across your organization.","invoice:write:org":"Create, edit, and manage invoices across your organization.","mailbox:read:org":"View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization.","mailbox:write:org":"Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization.","notification:subscription:read":"View active webhook and event notification subscriptions and their configurations.","notification:subscription:write":"Create, update, and delete webhook and event notification subscriptions.","ocr_task:read:org":"View the results and status of automated receipt and invoice scanning tasks.","ocr_task:write:org":"Submit and manage automated receipt and invoice scanning tasks for your organization.","offline_access":"","oidc:app:manage":"Add, edit, and remove access to OIDC applications and their scopes.","oidc:app:read":"Read only access to the OIDC applications and their scopes","oidc:app:write":"Add and edit - but not remove - access to OIDC applications and their scopes","openid":"","organization:read:org":"View your organization's profile and general details.","organization_settings:read:org":"View configuration settings for your organization.","organization_settings:write:org":"Update configuration settings for your organization.","organization:write:org":"Update your organization's profile and general details.","org:write:all":"Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators.","partner_portal":"Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations.","payable:approve:org":"Review and approve bills and accounts payable before they are paid.","payable:pay:org":"Authorize and submit payments for approved bills and accounts payable.","payable:read:org":"View bills and accounts payable across your organization.","payable:write:org":"Create and update bills and accounts payable across your organization.","payment:collect:org":"Collect payments for your organization by depositing them and recording them against the invoices they pay.","payment_link:write":"Generate and manage shareable payment links to collect payments from customers.","payment_processing":"","payment_rail:ach":"Process payments via the ACH (Automated Clearing House) network.","payment_rail:fednow":"Process instant payments via the FedNow network.","payment_rail:rtp":"Process real-time payments via the RTP network.","payment_record:read:org":"View payment transaction history and records for your organization.","payment_record:write:org":"Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing.","product:read:org":"View the product and service catalog used for invoicing within your organization.","product:write:org":"Add and update products and services in your organization's invoicing catalog.","profile":"","role:read:org":"View user roles and their associated permissions within your organization.","role:write:org":"Create and update user roles and permission sets within your organization.","transfer:write:org":"Create and submit money transfers within your organization.","underwriting:account:read":"View underwriting accounts and their account event history.","underwriting:account:write":"Open maintenance reviews on underwriting accounts and close underwriting accounts.","underwriting:application:approval:escalation":"Provide a senior-level escalation approval on underwriting applications that require additional review.","underwriting:application:approval:secondary":"Provide a second-level approval on underwriting applications as part of a multi-step review process.","underwriting:application:read":"View underwriting applications, including sensitive business details and personally identifiable information.","underwriting:application:write":"Edit, approve, and manage underwriting applications and decisions, and attach supporting documents.","user_profile:write:all":"Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators.","user_profile:write:self":"Update your own user profile, including your name, contact information, and preferences.","user:read:org":"View user accounts and their details within your organization.","user:read:self":"Read access to the user's own record and the name/email of their direct reports.","user:write:all":"Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators.","user:write:org":"Create, update, and manage user accounts within your organization."}}},"scopes":["external_bank_account:write:org"],"schemeName":"APPToken"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Application (M2M) OAuth2 access token (client credentials).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"APPToken","name":"Authorization"}],"title":"APPToken"},{"schemes":[{"scheme":{"type":"oauth2","description":"User OAuth2 access token (authorization code with PKCE).","flows":{"authorizationCode":{"authorizationUrl":"/connect/authorize","tokenUrl":"/connect/token","scopes":{"acceptor:application:read":"View merchant boarding applications, including business and ownership details. Contains sensitive personally identifiable information.","acceptor:application:secondaryapproval":"Provide a secondary approval on merchant boarding and underwriting applications as part of a multi-step review.","acceptor:application:write":"Edit, approve, and manage merchant boarding and underwriting applications, and attach supporting documents.","accounting_config:read:org":"View ledger accounts, tax rates, cost centers, tags, and projects configured for your organization.","accounting_config:write:org":"Create and update ledger accounts, tax rates, cost centers, tags, and projects for your organization.","acquiring:report:read":"View transaction and settlement reports for your acquiring activity.","approval_policy:read:org":"View approval workflows and spending policies configured for your organization.","approval_policy:write:org":"Create and update approval workflows and spending policies for your organization.","approval_request:create:org":"Submit items for approval within your organization's approval workflows.","approval_request:delete:org":"Delete approval requests within your organization.","approval_request:read:org":"View pending and completed approval requests across your organization.","approval_request:update:org":"Edit and update existing approval requests within your organization.","authorization_control:read:org":"Read access to authorization control at the organization level.","authorization_control:write:org":"Write access to authorization control at the organization level.","bank_account_application:read:org":"View submitted applications to open bank accounts within your organization.","bank_account_application:write:org":"Submit and manage applications to open new bank accounts within your organization.","bank_account:read:org":"View bank account details and balances within your organization.","bank_account:write:org":"Create, update, and close bank accounts within your organization.","beneficial_owner:read:org":"View beneficial ownership information, including individuals' ownership stakes and identifying details.","check_deposit:write:org":"Deposit checks into bank accounts within your organization by submitting the check details for processing.","comment:read:org":"View comments and notes added to financial records across your organization.","comment:write:org":"Add and manage comments and notes on financial records across your organization.","counterpart:read:org":"View the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","counterpart:write:org":"Add and update the suppliers and clients your organization transacts with. Counterparts are required before creating invoices, quotes, and other financial documents.","credit_card:activate:org":"Activate newly issued credit cards for use within your organization.","credit_card_application:read:org":"View credit card applications submitted within your organization.","credit_card_application:write:org":"Submit and manage credit card applications within your organization.","credit_card:issue:org":"Issue new credit cards for cardholders in your organization.","credit_card:read:org":"View credit card details and status for cards in your organization.","debit_card:activate:org":"Activate newly issued debit cards for use within your organization.","debit_card:close:org":"Permanently close debit cards in your organization.","debit_card:issue:org":"Issue new debit cards for cardholders in your organization.","debit_card:lock:org":"Lock or unlock debit cards in your organization.","debit_card:read:org":"View debit card details and status for cards in your organization.","developer_portal":"Access the Tesouro Developer Portal to view API documentation and manage developer resources.","dispute:read":"View payment disputes and any supporting documents attached to them.","dispute:write":"Accept or challenge payment disputes by uploading and submitting supporting evidence.","email":"","expense:approve:org":"Review and approve or reject expense reports submitted across your organization.","expense:read:org":"View expense reports and submissions across your organization.","expense:read:self":"View your own expense submissions and reports.","expense:write:org":"Create and update expense submissions across your organization.","expense:write:self":"Submit and update your own expense reports.","export:read:org":"View and download previously generated data exports for your organization.","export:write:org":"Generate and manage data exports for your organization.","external_bank_account:micro_deposit:org":"Initiate micro-deposit verification to confirm ownership of external bank accounts linked to your organization.","external_bank_account:read:org":"View external bank accounts that have been linked to your organization.","external_bank_account:set_verification:org":"Manually set the verification status of linked external bank accounts, bypassing the standard verification process.","external_bank_account:write:org":"Add, update, or remove external bank accounts linked to your organization.","instant_payment_limit:write:org":"Set instant payment limits and limit exposure alerts for your bank and the organizations and bank accounts beneath it.","invoice:read:org":"View invoices issued and received across your organization.","invoice:write:org":"Create, edit, and manage invoices across your organization.","mailbox:read:org":"View the email mailboxes configured to automatically capture incoming invoices as payables and collect expense receipts for your organization.","mailbox:write:org":"Configure email mailboxes that automatically capture incoming invoices as payables and collect expense receipts for your organization.","notification:subscription:read":"View active webhook and event notification subscriptions and their configurations.","notification:subscription:write":"Create, update, and delete webhook and event notification subscriptions.","ocr_task:read:org":"View the results and status of automated receipt and invoice scanning tasks.","ocr_task:write:org":"Submit and manage automated receipt and invoice scanning tasks for your organization.","offline_access":"","oidc:app:manage":"Add, edit, and remove access to OIDC applications and their scopes.","oidc:app:read":"Read only access to the OIDC applications and their scopes","oidc:app:write":"Add and edit - but not remove - access to OIDC applications and their scopes","openid":"","organization:read:org":"View your organization's profile and general details.","organization_settings:read:org":"View configuration settings for your organization.","organization_settings:write:org":"Update configuration settings for your organization.","organization:write:org":"Update your organization's profile and general details.","org:write:all":"Enable or disable organizations on the platform. This is a high-privilege permission typically reserved for platform administrators.","partner_portal":"Access the Tesouro Partner Portal to manage your partnership settings and sub-merchant configurations.","payable:approve:org":"Review and approve bills and accounts payable before they are paid.","payable:pay:org":"Authorize and submit payments for approved bills and accounts payable.","payable:read:org":"View bills and accounts payable across your organization.","payable:write:org":"Create and update bills and accounts payable across your organization.","payment:collect:org":"Collect payments for your organization by depositing them and recording them against the invoices they pay.","payment_link:write":"Generate and manage shareable payment links to collect payments from customers.","payment_processing":"","payment_rail:ach":"Process payments via the ACH (Automated Clearing House) network.","payment_rail:fednow":"Process instant payments via the FedNow network.","payment_rail:rtp":"Process real-time payments via the RTP network.","payment_record:read:org":"View payment transaction history and records for your organization.","payment_record:write:org":"Record payments against invoices and manage their status, including marking payments as succeeded, cancelling, or moving them into processing.","product:read:org":"View the product and service catalog used for invoicing within your organization.","product:write:org":"Add and update products and services in your organization's invoicing catalog.","profile":"","role:read:org":"View user roles and their associated permissions within your organization.","role:write:org":"Create and update user roles and permission sets within your organization.","transfer:write:org":"Create and submit money transfers within your organization.","underwriting:account:read":"View underwriting accounts and their account event history.","underwriting:account:write":"Open maintenance reviews on underwriting accounts and close underwriting accounts.","underwriting:application:approval:escalation":"Provide a senior-level escalation approval on underwriting applications that require additional review.","underwriting:application:approval:secondary":"Provide a second-level approval on underwriting applications as part of a multi-step review process.","underwriting:application:read":"View underwriting applications, including sensitive business details and personally identifiable information.","underwriting:application:write":"Edit, approve, and manage underwriting applications and decisions, and attach supporting documents.","user_profile:write:all":"Update profile information for any user across all organizations. This is a high-privilege permission typically reserved for platform administrators.","user_profile:write:self":"Update your own user profile, including your name, contact information, and preferences.","user:read:org":"View user accounts and their details within your organization.","user:read:self":"Read access to the user's own record and the name/email of their direct reports.","user:write:all":"Create and manage user accounts across multiple organizations. This is a high-privilege permission typically reserved for platform administrators.","user:write:org":"Create, update, and manage user accounts within your organization."}}},"scopes":["external_bank_account:write:org"],"schemeName":"USERToken"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"User OAuth2 access token (authorization code with PKCE).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"USERToken","name":"Authorization"}],"title":"USERToken"}]},"originalFileLocation":".tooling/schemas/rest/tags/product-embedded-banking.json"},"subdomain":"tesouro-dc896113","siteName":"Tesouro","title":"Update external account - Tesouro","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T14:23:18.208Z","originalFileLocation":"api-reference/external-bank-accounts/update-external-account.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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=\"Updates an external bank account\u0026#x27;s nickname and/or verification status. Updating verification status requires \u0026#x27;CanSetExternalBankAccountVerification\u0026#x27; permission. Token types: APP, USER | Required scopes: external_bank_account:write:org\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tesouro\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_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/tesouro-dc896113/7Bbt6o3aeKao26ng/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update external account - Tesouro\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates an external bank account\u0026#x27;s nickname and/or verification status. Updating verification status requires \u0026#x27;CanSetExternalBankAccountVerification\u0026#x27; permission. Token types: APP, USER | Required scopes: external_bank_account:write:org\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tesouro\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tesouro-dc896113.mintlify.app/_mintlify/api/og/v2?division=External+Bank+Accounts\u0026amp;title=Update+external+account\u0026amp;description=Updates+an+external+bank+account%27s+nickname+and%2For+verification+status.+Updating+verification+status+requires+%27CanSetExternalBankAccountVerification%27+permission\u0026amp;theme=aea269d490030ed12aee6415\u0026amp;signature=223d6f628500c25912e9ca9b5091e18090b5a90107294640c79efb27647208ca\">\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=\"Update external account - Tesouro\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates an external bank account\u0026#x27;s nickname and/or verification status. Updating verification status requires \u0026#x27;CanSetExternalBankAccountVerification\u0026#x27; permission. Token types: APP, USER | Required scopes: external_bank_account:write:org\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tesouro-dc896113.mintlify.app/_mintlify/api/og/v2?division=External+Bank+Accounts\u0026amp;title=Update+external+account\u0026amp;description=Updates+an+external+bank+account%27s+nickname+and%2For+verification+status.+Updating+verification+status+requires+%27CanSetExternalBankAccountVerification%27+permission\u0026amp;theme=aea269d490030ed12aee6415\u0026amp;signature=223d6f628500c25912e9ca9b5091e18090b5a90107294640c79efb27647208ca\">\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/tesouro-dc896113/7Bbt6o3aeKao26ng/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tesouro\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8b5cf6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/external-bank-accounts/update-external-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tesouro.com/#organization\",\"name\":\"Tesouro\",\"url\":\"https://docs.tesouro.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tesouro-dc896113/EiyyRmHDHMxOKA4r/.shared/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=EiyyRmHDHMxOKA4r\u0026q=85\u0026s=7806042ddc87fa143686df9c7b515c71\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tesouro.com#website\",\"name\":\"Tesouro\",\"url\":\"https://docs.tesouro.com\",\"publisher\":{\"@id\":\"https://docs.tesouro.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account#webpage\",\"url\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account\",\"name\":\"Update external account\",\"description\":\"Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission. Token types: APP, USER | Required scopes: external_bank_account:write:org\",\"dateModified\":\"2026-10-22T14:23:18.208Z\",\"isPartOf\":{\"@id\":\"https://docs.tesouro.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accounts\",\"item\":\"https://docs.tesouro.com/api-reference/bank-accounts/bulk-update-access\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"External Bank Accounts\",\"item\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/list-external-bank-accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update external account\",\"item\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account#apireference\",\"headline\":\"Update external account\",\"name\":\"Update external account\",\"description\":\"Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission. Token types: APP, USER | Required scopes: external_bank_account:write:org\",\"url\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tesouro.com/api-reference/external-bank-accounts/update-external-account#webpage\"},\"dateModified\":\"2026-10-22T14:23:18.208Z\",\"publisher\":{\"@id\":\"https://docs.tesouro.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tesouro.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tesouro\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tesouro","nav":{"global":null,"products":[{"product":"Home","icon":"house","description":"Documentation hub for all Tesouro products and platform guides","pages":[{"title":"Home","href":""}]},{"product":"Acquiring","icon":"credit-card","description":"Acceptor boarding, transaction processing, billing, funding, and dispute management","pages":[{"title":"Acquiring","href":"/acquiring"}]},{"product":"Embedded Banking","icon":"building-columns","description":"Integrate banking and finance tools directly within your software","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/embedded-banking"}]},{"tab":"Embedded components ↗","href":"https://components.tesouro.com/components?product=embedded-banking"},{"tab":"API reference","groups":[{"group":"Onboarding","pages":[{"group":"Applications","expanded":false,"pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-account-applications","href":"/api-reference/applications/list-applications"},{"title":"Create application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-account-applications","href":"/api-reference/applications/create-application"},{"title":"Resume application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-account-applications/resume","href":"/api-reference/applications/resume-application"},{"title":"Get application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-account-applications/{id}","href":"/api-reference/applications/get-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /bank-account-applications/{id}","href":"/api-reference/applications/update-application"},{"title":"Delete application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json delete /bank-account-applications/{id}","href":"/api-reference/applications/delete-application"},{"title":"Submit application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-account-applications/{id}/submission","href":"/api-reference/applications/submit-application"},{"title":"Verify applicant's email","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-account-applications/{id}/verification","href":"/api-reference/applications/verify-applicants-email"},{"title":"Send verification code","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-account-applications/{id}/verification-codes","href":"/api-reference/applications/send-verification-code"}]},{"group":"Beneficial Owners","expanded":false,"pages":[{"title":"List beneficial owners","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /beneficial-owners","href":"/api-reference/beneficial-owners/list-beneficial-owners"}]},{"group":"Disclosures","expanded":false,"pages":[{"title":"Accept disclosures","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /disclosure-acceptances","href":"/api-reference/disclosures/accept-disclosures"},{"title":"List disclosures","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /disclosures","href":"/api-reference/disclosures/list-disclosures"}]}]},{"group":"Accounts","pages":[{"group":"Bank Accounts","expanded":false,"pages":[{"title":"Bulk update access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-accounts/access","href":"/api-reference/bank-accounts/bulk-update-access"},{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts","href":"/api-reference/bank-accounts/list-bank-accounts"},{"title":"Create bank account","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-accounts","href":"/api-reference/bank-accounts/create-bank-account"},{"title":"List depositable accounts","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/depositable","href":"/api-reference/bank-accounts/list-depositable-accounts"},{"title":"List org historical balances","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/historical-balances","href":"/api-reference/bank-accounts/list-org-historical-balances"},{"title":"List organization transfers","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/transfers","href":"/api-reference/bank-accounts/list-organization-transfers"},{"title":"Get bank account","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}","href":"/api-reference/bank-accounts/get-bank-account"},{"title":"Update bank account","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /bank-accounts/{id}","href":"/api-reference/bank-accounts/update-bank-account"},{"title":"List bank account access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/access","href":"/api-reference/bank-accounts/list-bank-account-access"},{"title":"Grant bank account access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-accounts/{id}/access","href":"/api-reference/bank-accounts/grant-bank-account-access"},{"title":"Revoke account access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json delete /bank-accounts/{id}/access/{userId}","href":"/api-reference/bank-accounts/revoke-account-access"},{"title":"List historical balances","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/historical-balances","href":"/api-reference/bank-accounts/list-historical-balances"},{"title":"List statements","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/statements","href":"/api-reference/bank-accounts/list-statements"},{"title":"Get statement","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/statements/{statementId}","href":"/api-reference/bank-accounts/get-statement"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/transactions","href":"/api-reference/bank-accounts/list-transactions"},{"title":"Download CSV","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/transactions/download","href":"/api-reference/bank-accounts/download-csv"},{"title":"List transfers","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-accounts/{id}/transfers","href":"/api-reference/bank-accounts/list-transfers"}]},{"group":"External Bank Accounts","expanded":false,"pages":[{"title":"List external bank accounts","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /external-bank-accounts","href":"/api-reference/external-bank-accounts/list-external-bank-accounts"},{"title":"Connect external account","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /external-bank-accounts","href":"/api-reference/external-bank-accounts/connect-external-account"},{"title":"Get external account","description":"Retrieves a specific external bank account by ID.\n\n**Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org`","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /external-bank-accounts/{id}","href":"/api-reference/external-bank-accounts/get-external-account"},{"title":"Update external account","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /external-bank-accounts/{id}","href":"/api-reference/external-bank-accounts/update-external-account"},{"title":"Unlink external account","description":"Unlinks (deactivates) an external bank account.\n\n**Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org`","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json delete /external-bank-accounts/{id}","href":"/api-reference/external-bank-accounts/unlink-external-account"},{"title":"List external access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /external-bank-accounts/{id}/access","href":"/api-reference/external-bank-accounts/list-external-access"},{"title":"Grant external access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /external-bank-accounts/{id}/access","href":"/api-reference/external-bank-accounts/grant-external-access"},{"title":"Revoke external access","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json delete /external-bank-accounts/{id}/access/{userId}","href":"/api-reference/external-bank-accounts/revoke-external-access"},{"title":"Start verification","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /external-bank-accounts/{id}/link","href":"/api-reference/external-bank-accounts/start-verification"},{"title":"Verify micro-deposits","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /external-bank-accounts/{id}/validate","href":"/api-reference/external-bank-accounts/verify-micro-deposits"}]}]},{"group":"Payments and Transfers","pages":[{"group":"Money Movement","expanded":false,"pages":[{"title":"Create ACH transfer","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /money-movements/ach","href":"/api-reference/money-movement/create-ach-transfer"},{"title":"Create book transfer","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /money-movements/book","href":"/api-reference/money-movement/create-book-transfer"},{"title":"Create FedNow transfer","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /money-movements/fednow","href":"/api-reference/money-movement/create-fednow-transfer"},{"title":"Create RTP transfer","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /money-movements/rtp","href":"/api-reference/money-movement/create-rtp-transfer"}]},{"group":"Checks","expanded":false,"pages":[{"title":"Submit check deposit","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /bank-accounts/{id}/check-deposits","href":"/api-reference/checks/submit-check-deposit"}]}]},{"group":"Cards","pages":[{"group":"Debit Cards","expanded":false,"pages":[{"title":"Create debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards","href":"/api-reference/debit-cards/create-debit-card"},{"title":"List debit cards","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /debit-cards","href":"/api-reference/debit-cards/list-debit-cards"},{"title":"Get debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /debit-cards/{id}","href":"/api-reference/debit-cards/get-debit-card"},{"title":"Update debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json patch /debit-cards/{id}","href":"/api-reference/debit-cards/update-debit-card"},{"title":"Get debit card credentials","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /debit-cards/{id}/credentials","href":"/api-reference/debit-cards/get-debit-card-credentials"},{"title":"Verify debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards/{id}/verify","href":"/api-reference/debit-cards/verify-debit-card"},{"title":"Activate debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards/{id}/activate","href":"/api-reference/debit-cards/activate-debit-card"},{"title":"Set debit card lock status","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards/{id}/lock-status","href":"/api-reference/debit-cards/set-debit-card-lock-status"},{"title":"Close debit card","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards/{id}/close","href":"/api-reference/debit-cards/close-debit-card"},{"title":"Manage card access","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /debit-cards/access","href":"/api-reference/debit-cards/manage-card-access"}]},{"group":"Authorization Controls","expanded":false,"pages":[{"title":"List MCC groups","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /authorization-controls/merchant-category-groups","href":"/api-reference/authorization-controls/list-mcc-groups"},{"title":"Create MCC group","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /authorization-controls/merchant-category-groups","href":"/api-reference/authorization-controls/create-mcc-group"},{"title":"Get MCC group","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /authorization-controls/merchant-category-groups/{id}","href":"/api-reference/authorization-controls/get-mcc-group"},{"title":"Update MCC group","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json put /authorization-controls/merchant-category-groups/{id}","href":"/api-reference/authorization-controls/update-mcc-group"},{"title":"Create velocity control","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json post /authorization-controls/velocity-controls","href":"/api-reference/authorization-controls/create-velocity-control"},{"title":"List velocity controls","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /authorization-controls/velocity-controls","href":"/api-reference/authorization-controls/list-velocity-controls"},{"title":"Get velocity control","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /authorization-controls/velocity-controls/{id}","href":"/api-reference/authorization-controls/get-velocity-control"},{"title":"Update velocity control","deprecated":null,"version":null,"tag":"Beta","openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json put /authorization-controls/velocity-controls/{id}","href":"/api-reference/authorization-controls/update-velocity-control"}]}]},{"group":"User Management","pages":[{"group":"Users","expanded":false,"pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /users","href":"/api-reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users","href":"/api-reference/users/create-user"},{"title":"Accept invitation","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/invitation","href":"/api-reference/users/accept-invitation"},{"title":"Get current user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /users/me","href":"/api-reference/users/get-current-user"},{"title":"Reset password","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/password-reset","href":"/api-reference/users/reset-password"},{"title":"Request password reset","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/password-reset-request","href":"/api-reference/users/request-password-reset"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /users/{id}","href":"/api-reference/users/get-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /users/{id}","href":"/api-reference/users/update-user"},{"title":"Disable user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/{userId}/disable","href":"/api-reference/users/disable-user"},{"title":"Enable user","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/{userId}/enable","href":"/api-reference/users/enable-user"},{"title":"Accept with disclosures","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /users/{userId}/invitation-acceptance","href":"/api-reference/users/accept-with-disclosures"}]},{"group":"Roles","expanded":false,"pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /roles","href":"/api-reference/roles/list-roles"},{"title":"Create role","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /roles","href":"/api-reference/roles/create-role"},{"title":"Get role","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /roles/{roleId}","href":"/api-reference/roles/get-role"},{"title":"Update role","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /roles/{roleId}","href":"/api-reference/roles/update-role"},{"title":"Deactivate role","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /roles/{roleId}","href":"/api-reference/roles/deactivate-role"},{"title":"List role members","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /roles/{roleId}/members","href":"/api-reference/roles/list-role-members"},{"title":"Bulk update role members","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /roles/{roleId}/members","href":"/api-reference/roles/bulk-update-role-members"},{"title":"List role permissions","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /roles/{roleId}/permissions","href":"/api-reference/roles/list-role-permissions"},{"title":"Update role permissions","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /roles/{roleId}/permissions","href":"/api-reference/roles/update-role-permissions"}]},{"group":"Locations","expanded":false,"pages":[{"title":"List locations","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /locations","href":"/api-reference/locations/list-locations"},{"title":"Create location","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /locations","href":"/api-reference/locations/create-location"},{"title":"Get location","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /locations/{locationId}","href":"/api-reference/locations/get-location"},{"title":"Update location","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json put /locations/{locationId}","href":"/api-reference/locations/update-location"},{"title":"Deactivate location","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /locations/{locationId}","href":"/api-reference/locations/deactivate-location"},{"title":"Update members","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /locations/{locationId}/members","href":"/api-reference/locations/update-members"},{"title":"Add member","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json put /locations/{locationId}/members/{userId}","href":"/api-reference/locations/add-member"},{"title":"Remove member","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /locations/{locationId}/members/{userId}","href":"/api-reference/locations/remove-member"}]},{"group":"Departments","expanded":false,"pages":[{"title":"List departments","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /departments","href":"/api-reference/departments/list-departments"},{"title":"Create department","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /departments","href":"/api-reference/departments/create-department"},{"title":"Get department","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /departments/{departmentId}","href":"/api-reference/departments/get-department"},{"title":"Update department","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json put /departments/{departmentId}","href":"/api-reference/departments/update-department"},{"title":"Deactivate department","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /departments/{departmentId}","href":"/api-reference/departments/deactivate-department"},{"title":"Update members","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /departments/{departmentId}/members","href":"/api-reference/departments/update-members"},{"title":"Add member","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json put /departments/{departmentId}/members/{userId}","href":"/api-reference/departments/add-member"},{"title":"Remove member","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /departments/{departmentId}/members/{userId}","href":"/api-reference/departments/remove-member"}]}]},{"group":"Organization \u0026 access","pages":[{"group":"Organization Summary","expanded":false,"pages":[{"title":"Get organization summary","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-embedded-banking.json get /organization/summary","href":"/api-reference/organization-summary/get-organization-summary"}]},{"group":"Organizations","expanded":false,"pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create organization","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /organizations","href":"/api-reference/organizations/create-organization"},{"title":"List visible organization IDs","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/visible-ids","href":"/api-reference/organizations/list-visible-organization-ids"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/{organizationId}","href":"/api-reference/organizations/get-organization"},{"title":"Update organization","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /organizations/{organizationId}","href":"/api-reference/organizations/update-organization"},{"title":"Disable organization","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /organizations/{organizationId}/disable","href":"/api-reference/organizations/disable-organization"},{"title":"Disable all applications","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /organizations/{organizationId}/disable-applications","href":"/api-reference/organizations/disable-all-applications"},{"title":"List disabled payment rails","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/{organizationId}/disabled-payment-rails","href":"/api-reference/organizations/list-disabled-payment-rails"},{"title":"Update payment rail status","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /organizations/{organizationId}/disabled-payment-rails","href":"/api-reference/organizations/update-payment-rail-status"},{"title":"Enable organization","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /organizations/{organizationId}/enable","href":"/api-reference/organizations/enable-organization"},{"title":"Enable all applications","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /organizations/{organizationId}/enable-applications","href":"/api-reference/organizations/enable-all-applications"},{"title":"Get logo","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/{organizationId}/logo","href":"/api-reference/organizations/get-logo"},{"title":"Upload logo","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json put /organizations/{organizationId}/logo","href":"/api-reference/organizations/upload-logo"},{"title":"Delete logo","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json delete /organizations/{organizationId}/logo","href":"/api-reference/organizations/delete-logo"},{"title":"List applications","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/{organizationId}/oidc-applications","href":"/api-reference/organizations/list-applications"},{"title":"Get settings","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /organizations/{organizationId}/settings","href":"/api-reference/organizations/get-settings"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /organizations/{organizationId}/settings","href":"/api-reference/organizations/update-settings"}]},{"group":"OIDC applications","expanded":false,"pages":[{"title":"List OIDC applications","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /oidc-applications","href":"/api-reference/oidc-applications/list-oidc-applications"},{"title":"Get OIDC application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json get /oidc-applications/{applicationId}","href":"/api-reference/oidc-applications/get-oidc-application"},{"title":"Update rail scopes","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json patch /oidc-applications/{applicationId}","href":"/api-reference/oidc-applications/update-rail-scopes"},{"title":"Disable OIDC application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /oidc-applications/{applicationId}/disable","href":"/api-reference/oidc-applications/disable-oidc-application"},{"title":"Enable OIDC application","deprecated":null,"version":null,"openapi":"/.tooling/schemas/rest/tags/product-finops.json post /oidc-applications/{applicationId}/enable","href":"/api-reference/oidc-applications/enable-oidc-application"}]}]}]},{"tab":"Support","pages":[{"title":"Support","href":"/embedded-banking/support"}]}]},{"product":"FinOps","icon":"file-invoice-dollar","description":"Accounts payable, accounts receivable, invoicing, and expense management","pages":[{"title":"FinOps","href":"/finops"}]},{"product":"Underwriting","icon":"file-shield","description":"Submit KYB/KYC and financial information for underwriting review and decisioning","pages":[{"title":"Underwriting","href":"/underwriting"}]}]},"title":"Update external account - Tesouro","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}