Use this endpoint to find out which documents to collect before you call the attach document endpoints. It describes the onboarding rules, not the progress of a specific customer, and it reads from the same rules the attach endpoints enforce.All three query parameters are optional. Leave them out to get every customer type in one response. Send all three when you know them to get a single, exact checklist.
Each entry in requirements covers one customer type (and, for businesses, one entity type). documents lists the customer’s own document groups. associated_party_documents lists what each director or owner must provide, and appears only for businesses.
Field
Meaning
category
The group the documents belong to, such as identifying_documents or formation_documents.
requirement
ONE_OF: upload any one document from the list. ALL_OF: upload every document in the list.
document_types
The accepted document types.
front_and_back_required
Document types that need both a front and a back image.
Only CORPORATION, LIMITED_LIABILITY_COMPANY and PUBLICLY_LISTED_COMPANY have a country dependent document (EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS).
You send
Response
No country
A separate formation_documents group with required_when: "country_of_incorporation is not USA".
USA
The document is omitted.
Any other country, e.g. GBR
The document is merged into the main formation_documents group, with no required_when.
entity_type and country_of_incorporation only apply to businesses. Sending either with customer_type=INDIVIDUAL returns 422. Parameter values are case insensitive, and countries must be ISO 3166-1 alpha-3 (GBR, not UK).
Country where the business is registered, ISO 3166-1 alpha-3. Only valid when customer_type is BUSINESS (or omitted). Resolves country dependent documents into a single exact checklist.
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"EngageXPay","description":"EngageXPay Orchestration API documentation. Guides and API reference for onboarding customers (KYB/KYC), managing beneficiaries, sending payouts, virtual accounts, balances, FX rates, and webhooks.","colors":{"primary":"#151515","light":"#ffffff","dark":"#151515"},"logo":{"light":"https://mintcdn.com/enagage-x-pay/FEj0pOmeiBFLeLWn/logo/engagexpay-light.svg?fit=max\u0026auto=format\u0026n=FEj0pOmeiBFLeLWn\u0026q=85\u0026s=4150a6758362fde0c5ab216d6382c1bd","dark":"https://mintcdn.com/enagage-x-pay/FEj0pOmeiBFLeLWn/logo/engagexpay-dark.svg?fit=max\u0026auto=format\u0026n=FEj0pOmeiBFLeLWn\u0026q=85\u0026s=fedf4d29a1a18785512adcf311045eb7"},"favicon":"https://mintcdn.com/enagage-x-pay/FEj0pOmeiBFLeLWn/favicon.svg?fit=max\u0026auto=format\u0026n=FEj0pOmeiBFLeLWn\u0026q=85\u0026s=68cef930bf5c9bcdb64b27f090c6c2b6","api":{"playground":{"display":"interactive","proxy":false},"examples":{"languages":["curl","node","java","python","go"]}},"appearance":{"default":"dark","strict":false},"background":{"color":{"dark":"#151515"}},"navbar":{"links":[],"primary":{"type":"button","label":"EngageXPay App","href":"https://app.engagexpay.com"}},"footer":{"socials":{}},"fonts":{"family":"Inter","weight":400},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/enagage-x-pay/jTINrWuRVZAADmLE/images/Thumbnail.png?fit=max\u0026auto=format\u0026n=jTINrWuRVZAADmLE\u0026q=85\u0026s=2ccd3da4235818679634f6957f5f91b6"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"enagage-x-pay","hasAudioNarration":false,"actualSubdomain":"enagage-x-pay","customDomains":["doc.engagexpay.com"],"gitSource":{"type":"github","owner":"engagexpay","repo":"doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6aea0d3f0fba27ac624555d0"},"chroma":{"latestBuiltDeploymentHistoryId":"6aeb2ac6d4e7ed0286063fab","collectionId":"c7801af1-ad9e-4164-9c06-424d4b732335","liveDeploymentHistoryId":"6aeb2ac6d4e7ed0286063fab","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeb2b01119a07d709eaf68f","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Transactions","count":22},{"language":"default","tag":"Beneficiaries","count":15},{"language":"default","tag":"Customers","count":14},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Customers and compliance","count":11},{"language":"default","tag":"Catalogue","count":7},{"language":"default","tag":"All Catalogues","count":7},{"language":"default","tag":"Create now, settle later","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customers/get-required-documents","slug":"/api-reference/customers/get-required-documents","pageMetadata":{"title":"Get Required Documents","description":"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.","openapi":"GET /v2/customers/required-documents","href":"/api-reference/customers/get-required-documents"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this endpoint to find out which documents to collect before you call the attach document endpoints. It describes the onboarding rules, not the progress of a specific customer, and it reads from the same rules the attach endpoints enforce.`}),`\n`,_jsx(_components.p,{children:`All three query parameters are optional. Leave them out to get every customer type in one response. Send all three when you know them to get a single, exact checklist.`}),`\n`,_jsx(Heading,{level:`2`,id:`reading-the-response`,children:`Reading the response`}),`\n`,_jsxs(_components.p,{children:[`Each entry in `,_jsx(_components.code,{children:`requirements`}),` covers one customer type (and, for businesses, one entity type). `,_jsx(_components.code,{children:`documents`}),` lists the customer’s own document groups. `,_jsx(_components.code,{children:`associated_party_documents`}),` lists what each director or owner must provide, and appears only for businesses.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`category`})}),_jsxs(_components.td,{children:[`The group the documents belong to, such as `,_jsx(_components.code,{children:`identifying_documents`}),` or `,_jsx(_components.code,{children:`formation_documents`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`requirement`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ONE_OF`}),`: upload any one document from the list. `,_jsx(_components.code,{children:`ALL_OF`}),`: upload every document in the list.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`document_types`})}),_jsx(_components.td,{children:`The accepted document types.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`front_and_back_required`})}),_jsx(_components.td,{children:`Document types that need both a front and a back image.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`required_when`})}),_jsx(_components.td,{children:`Shown only on a conditional group. See below.`})]})]})]}),`\n`,_jsxs(Heading,{level:`2`,id:`how-country_of_incorporation-changes-the-response`,children:[`How `,_jsx(_components.code,{children:`country_of_incorporation`}),` changes the response`]}),`\n`,_jsxs(_components.p,{children:[`Only `,_jsx(_components.code,{children:`CORPORATION`}),`, `,_jsx(_components.code,{children:`LIMITED_LIABILITY_COMPANY`}),` and `,_jsx(_components.code,{children:`PUBLICLY_LISTED_COMPANY`}),` have a country dependent document (`,_jsx(_components.code,{children:`EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS`}),`).`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`You send`}),_jsx(_components.th,{children:`Response`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No country`}),_jsxs(_components.td,{children:[`A separate `,_jsx(_components.code,{children:`formation_documents`}),` group with `,_jsx(_components.code,{children:`required_when: \"country_of_incorporation is not USA\"`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`USA`})}),_jsx(_components.td,{children:`The document is omitted.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Any other country, e.g. `,_jsx(_components.code,{children:`GBR`})]}),_jsxs(_components.td,{children:[`The document is merged into the main `,_jsx(_components.code,{children:`formation_documents`}),` group, with no `,_jsx(_components.code,{children:`required_when`}),`.`]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`entity_type`}),` and `,_jsx(_components.code,{children:`country_of_incorporation`}),` only apply to businesses. Sending either with `,_jsx(_components.code,{children:`customer_type=INDIVIDUAL`}),` returns `,_jsx(_components.code,{children:`422`}),`. Parameter values are case insensitive, and countries must be ISO 3166-1 alpha-3 (`,_jsx(_components.code,{children:`GBR`}),`, not `,_jsx(_components.code,{children:`UK`}),`).`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Required Documents","description":"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.","openapi":"GET /v2/customers/required-documents","href":"/api-reference/customers/get-required-documents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Reading the response","slug":"reading-the-response","depth":2,"children":[]},{"title":"How country_of_incorporation changes the response","slug":"how-country_of_incorporation-changes-the-response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Required Documents","description":"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.","tags":["Customers"],"security":["15297179-1bfb-4a25-9939-36ca733f7f5e"],"parameters":["1b1c1fc8-800d-4cd4-a74c-1023c6b3ac09","b1e4df14-3578-4d62-b28e-48a60f56d078","cb5cfac9-9d99-4679-845c-399ed38c67e2"],"responses":{"200":"93ce6fd3-fb6a-400b-aff7-b7404754bba6","401":"3e8fcc04-aa62-400e-8f3c-cace812acb5f","422":"82ca748d-85bc-4352-8e06-eb3e3d66a54b","500":"a2054c62-2447-44c2-bf67-f3d2498b5f1b"},"method":"get","type":"path","servers":["cbeade3a-6620-4ea8-a8b3-35acd1819633","dafcce7c-d9d9-422e-9aae-ab48e7d0edc1"],"path":"/v2/customers/required-documents","baseUrlOptions":["https://sandbox.api.engagexpay.com","https://api.engagexpay.com"],"title":"Get Required Documents","codeSamples":[],"requestExampleLanguages":["bash","node","java","python","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"1b1c1fc8-800d-4cd4-a74c-1023c6b3ac09":{"name":"customer_type","in":"query","required":false,"description":"Filter by customer type. Case insensitive. Omit to return every customer type.","schema":{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"isRequired":false,"description":"Filter by customer type. Case insensitive. Omit to return every customer type.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"BUSINESS"},"b1e4df14-3578-4d62-b28e-48a60f56d078":{"name":"entity_type","in":"query","required":false,"description":"Filter by business entity type. Case insensitive. Only valid when `customer_type` is `BUSINESS` (or omitted).","schema":{"type":"string","enum":["CHARITY","CORPORATION","LIMITED_LIABILITY_COMPANY","NONPROFIT_ORGANIZATION","PARTNERSHIP","PRIVATE_FOUNDATION","PUBLICLY_LISTED_COMPANY","PUBLIC_AGENCY_OR_AUTHORITY","SOLE_PROPRIETOR","TRUST"],"isRequired":false,"description":"Filter by business entity type. Case insensitive. Only valid when `customer_type` is `BUSINESS` (or omitted).","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"CORPORATION"},"cb5cfac9-9d99-4679-845c-399ed38c67e2":{"name":"country_of_incorporation","in":"query","required":false,"description":"Country where the business is registered, ISO 3166-1 alpha-3. Only valid when `customer_type` is `BUSINESS` (or omitted). Resolves country dependent documents into a single exact checklist.","schema":{"type":"string","pattern":"^[A-Za-z]{3}$","isRequired":false,"description":"Country where the business is registered, ISO 3166-1 alpha-3. Only valid when `customer_type` is `BUSINESS` (or omitted). Resolves country dependent documents into a single exact checklist.","uniqueKey":"","typeLabel":"string"},"example":"GBR"}},"responses":{"93ce6fd3-fb6a-400b-aff7-b7404754bba6":{"description":"Required documents retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"requirements":{"type":"array","description":"One entry per customer type, and per entity type for businesses.","items":{"type":"object","properties":{"customer_type":{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"uniqueKey":"data.requirements.items.[INDEX].customer_type","typeLabel":"enum\u003cstring>"},"entity_type":{"type":"string","description":"Business entity type. Present only when `customer_type` is `BUSINESS`.","uniqueKey":"data.requirements.items.[INDEX].entity_type","typeLabel":"string"},"documents":{"type":"array","description":"Document groups for the customer itself.","items":{"type":"object","description":"A group of documents in one category, with a rule for how many are needed.","required":["category","requirement","document_types"],"properties":{"category":{"type":"string","enum":["identifying_documents","address_documents","formation_documents","ownership_documents","supporting_documents"],"example":"identifying_documents","isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"requirement":{"type":"string","enum":["ONE_OF","ALL_OF"],"description":"`ONE_OF`: any one document from `document_types`. `ALL_OF`: every document in `document_types`.","example":"ONE_OF","isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].requirement","typeLabel":"enum\u003cstring>"},"document_types":{"type":"array","description":"Accepted document types for this group.","items":{"type":"string","enum":["BANK_STATEMENT","CERT_OF_INCUMBENCY","CONSTITUTIONAL_DOCUMENT","DRIVERS_LICENSE","EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS","E_SIGNATURE_CERTIFICATE","FORMATION_DOCUMENT","GOVERNMENT_LETTER","NATIONAL_ID","PASSPORT","PROOF_OF_ADDRESS","PROOF_OF_ENTITY_NAME_CHANGE","PROOF_OF_NATURE_OF_BUSINESS","PROOF_OF_SIGNATORY_AUTHORITY","PROOF_OF_SOURCE_OF_FUNDS","PROOF_OF_SOURCE_OF_WEALTH","PROOF_OF_TAX_IDENTIFICATION","REGISTRATION_DOCUMENT","RESIDENCE_PERMIT","SHAREHOLDER_REGISTER","TAX_EXEMPT_ENTITY_CONFIRMATION","UTILITY_BILL"],"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].document_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].document_types","typeLabel":"enum\u003cstring>[]"},"front_and_back_required":{"type":"array","description":"Document types in this group that need both a front and a back image.","items":{"type":"string","uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].front_and_back_required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].front_and_back_required","typeLabel":"string[]"},"required_when":{"type":"string","description":"Present only on a conditional group. Currently the only value is `country_of_incorporation is not USA`, returned when no country filter is sent.","example":"country_of_incorporation is not USA","uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX].required_when","typeLabel":"string"}},"uniqueKey":"data.requirements.items.[INDEX].documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.requirements.items.[INDEX].documents","typeLabel":"object[]"},"associated_party_documents":{"type":"array","description":"Document groups each associated party (director, owner) must provide. Present only for businesses.","items":{"type":"object","description":"A group of documents in one category, with a rule for how many are needed.","required":["category","requirement","document_types"],"properties":{"category":{"type":"string","enum":["identifying_documents","address_documents","formation_documents","ownership_documents","supporting_documents"],"example":"identifying_documents","isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"requirement":{"type":"string","enum":["ONE_OF","ALL_OF"],"description":"`ONE_OF`: any one document from `document_types`. `ALL_OF`: every document in `document_types`.","example":"ONE_OF","isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].requirement","typeLabel":"enum\u003cstring>"},"document_types":{"type":"array","description":"Accepted document types for this group.","items":{"type":"string","enum":["BANK_STATEMENT","CERT_OF_INCUMBENCY","CONSTITUTIONAL_DOCUMENT","DRIVERS_LICENSE","EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS","E_SIGNATURE_CERTIFICATE","FORMATION_DOCUMENT","GOVERNMENT_LETTER","NATIONAL_ID","PASSPORT","PROOF_OF_ADDRESS","PROOF_OF_ENTITY_NAME_CHANGE","PROOF_OF_NATURE_OF_BUSINESS","PROOF_OF_SIGNATORY_AUTHORITY","PROOF_OF_SOURCE_OF_FUNDS","PROOF_OF_SOURCE_OF_WEALTH","PROOF_OF_TAX_IDENTIFICATION","REGISTRATION_DOCUMENT","RESIDENCE_PERMIT","SHAREHOLDER_REGISTER","TAX_EXEMPT_ENTITY_CONFIRMATION","UTILITY_BILL"],"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].document_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].document_types","typeLabel":"enum\u003cstring>[]"},"front_and_back_required":{"type":"array","description":"Document types in this group that need both a front and a back image.","items":{"type":"string","uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].front_and_back_required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].front_and_back_required","typeLabel":"string[]"},"required_when":{"type":"string","description":"Present only on a conditional group. Currently the only value is `country_of_incorporation is not USA`, returned when no country filter is sent.","example":"country_of_incorporation is not USA","uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX].required_when","typeLabel":"string"}},"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.requirements.items.[INDEX].associated_party_documents","typeLabel":"object[]"}},"uniqueKey":"data.requirements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.requirements","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Individual":{"title":"Individual","value":{"data":{"requirements":[{"customer_type":"INDIVIDUAL","documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"],"front_and_back_required":["NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]}]}}},"CorporationGBR":{"title":"CorporationGBR","value":{"data":{"requirements":[{"customer_type":"BUSINESS","entity_type":"CORPORATION","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT","EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]}]}}},"AllCustomerTypes":{"title":"AllCustomerTypes","value":{"data":{"requirements":[{"customer_type":"INDIVIDUAL","documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"],"front_and_back_required":["NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"CHARITY","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","TAX_EXEMPT_ENTITY_CONFIRMATION","PROOF_OF_SOURCE_OF_WEALTH","PROOF_OF_SOURCE_OF_FUNDS","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"CORPORATION","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"formation_documents","requirement":"ALL_OF","document_types":["EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS"],"required_when":"country_of_incorporation is not USA"},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"LIMITED_LIABILITY_COMPANY","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"formation_documents","requirement":"ALL_OF","document_types":["EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS"],"required_when":"country_of_incorporation is not USA"},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"NONPROFIT_ORGANIZATION","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","TAX_EXEMPT_ENTITY_CONFIRMATION","PROOF_OF_SOURCE_OF_WEALTH","PROOF_OF_SOURCE_OF_FUNDS","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"PARTNERSHIP","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"PRIVATE_FOUNDATION","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","TAX_EXEMPT_ENTITY_CONFIRMATION","PROOF_OF_SOURCE_OF_WEALTH","PROOF_OF_SOURCE_OF_FUNDS","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"PUBLICLY_LISTED_COMPANY","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["REGISTRATION_DOCUMENT","CONSTITUTIONAL_DOCUMENT"]},{"category":"formation_documents","requirement":"ALL_OF","document_types":["EVIDENCE_OF_DIRECTORS_AND_CONTROLLERS"],"required_when":"country_of_incorporation is not USA"},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","CERT_OF_INCUMBENCY","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"PUBLIC_AGENCY_OR_AUTHORITY","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["CONSTITUTIONAL_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","SHAREHOLDER_REGISTER","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"SOLE_PROPRIETOR","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["PROOF_OF_NATURE_OF_BUSINESS","PROOF_OF_ENTITY_NAME_CHANGE","PROOF_OF_TAX_IDENTIFICATION"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]},{"customer_type":"BUSINESS","entity_type":"TRUST","documents":[{"category":"formation_documents","requirement":"ALL_OF","document_types":["FORMATION_DOCUMENT"]},{"category":"ownership_documents","requirement":"ALL_OF","document_types":["PROOF_OF_SIGNATORY_AUTHORITY"]},{"category":"supporting_documents","requirement":"ALL_OF","document_types":["PROOF_OF_ADDRESS","PROOF_OF_SOURCE_OF_FUNDS","E_SIGNATURE_CERTIFICATE"]}],"associated_party_documents":[{"category":"identifying_documents","requirement":"ONE_OF","document_types":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE","RESIDENCE_PERMIT"]},{"category":"address_documents","requirement":"ONE_OF","document_types":["UTILITY_BILL","GOVERNMENT_LETTER","BANK_STATEMENT"]}]}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"3e8fcc04-aa62-400e-8f3c-cace812acb5f":{"description":"Authentication failed due to invalid credentials","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Authentication failed","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Authentication failed"}}},"exampleType":"generated"}},"exampleType":"generated"},"82ca748d-85bc-4352-8e06-eb3e3d66a54b":{"description":"Failed due to a formatting error.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.items.[INDEX].additionalProperties","typeLabel":"string"},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a2054c62-2447-44c2-bf67-f3d2498b5f1b":{"description":"Internal server error. Retry the request.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"15297179-1bfb-4a25-9939-36ca733f7f5e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Obtain token from [Issue a Token](https://docs.engagexpay.com/api-reference/authentication/issue-a-token) endpoint","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cbeade3a-6620-4ea8-a8b3-35acd1819633":{"url":"https://sandbox.api.engagexpay.com","description":"Sandbox server"},"dafcce7c-d9d9-422e-9aae-ab48e7d0edc1":{"url":"https://api.engagexpay.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Obtain token from [Issue a Token](https://docs.engagexpay.com/api-reference/authentication/issue-a-token) endpoint","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication. Obtain token from [Issue a Token](https://docs.engagexpay.com/api-reference/authentication/issue-a-token) endpoint","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"enagage-x-pay","siteName":"EngageXPay","title":"Get Required Documents - EngageXPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:36:16.725Z","originalFileLocation":"api-reference/customers/get-required-documents.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=\"dark\"}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=\"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"EngageXPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_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/enagage-x-pay/rcU3n-36H6C4X8E2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Required Documents - EngageXPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"EngageXPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://doc.engagexpay.com/api-reference/customers/get-required-documents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://enagage-x-pay.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+Required+Documents\u0026amp;description=List+the+documents+a+customer+must+upload+before+onboarding%2C+by+customer+type%2C+entity+type+and+country+of+incorporation.\u0026amp;theme=2356807b39eb913fdb8aabf5\u0026amp;signature=f28c78fb8180052c956b1d26de39b3763a1fac1efbb30a57496bbb3192b3eb76\">\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=\"Get Required Documents - EngageXPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://enagage-x-pay.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+Required+Documents\u0026amp;description=List+the+documents+a+customer+must+upload+before+onboarding%2C+by+customer+type%2C+entity+type+and+country+of+incorporation.\u0026amp;theme=2356807b39eb913fdb8aabf5\u0026amp;signature=f28c78fb8180052c956b1d26de39b3763a1fac1efbb30a57496bbb3192b3eb76\">\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/enagage-x-pay/rcU3n-36H6C4X8E2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"EngageXPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#151515\">\u003clink data-mint-head rel=\"canonical\" href=\"https://doc.engagexpay.com/api-reference/customers/get-required-documents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/get-required-documents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://doc.engagexpay.com/#organization\",\"name\":\"EngageXPay\",\"url\":\"https://doc.engagexpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/enagage-x-pay/FEj0pOmeiBFLeLWn/logo/engagexpay-light.svg?fit=max\u0026auto=format\u0026n=FEj0pOmeiBFLeLWn\u0026q=85\u0026s=4150a6758362fde0c5ab216d6382c1bd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://doc.engagexpay.com#website\",\"name\":\"EngageXPay\",\"url\":\"https://doc.engagexpay.com\",\"publisher\":{\"@id\":\"https://doc.engagexpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents#webpage\",\"url\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents\",\"name\":\"Get Required Documents\",\"description\":\"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\",\"dateModified\":\"2026-11-03T16:36:16.725Z\",\"isPartOf\":{\"@id\":\"https://doc.engagexpay.com#website\"},\"breadcrumb\":{\"@id\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://doc.engagexpay.com/api-reference/customers/create-individual-customer-v2\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Required Documents\",\"item\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents#apireference\",\"headline\":\"Get Required Documents\",\"name\":\"Get Required Documents\",\"description\":\"List the documents a customer must upload before onboarding, by customer type, entity type and country of incorporation.\",\"url\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents\",\"mainEntityOfPage\":{\"@id\":\"https://doc.engagexpay.com/api-reference/customers/get-required-documents#webpage\"},\"dateModified\":\"2026-11-03T16:36:16.725Z\",\"publisher\":{\"@id\":\"https://doc.engagexpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://doc.engagexpay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"EngageXPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"EngageXPay","nav":{"global":null,"tabs":[{"tab":"Main Site","href":"https://engagexpay.com"},{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"group":"Authentication","pages":[{"openapi":"POST /v1/oauth/token","title":"Issue a Token","href":"/api-reference/authentication/issue-a-token"},{"openapi":"POST /v1/oauth/refresh-token","title":"Refresh a Token","href":"/api-reference/authentication/refresh-a-token"}]},{"group":"Customers","pages":[{"group":"Create Individual Customer","expanded":false,"pages":[{"openapi":"POST /v2/customers/individual","title":"Create Individual Customer","href":"/api-reference/customers/create-individual-customer-v2"},{"openapi":"POST /v2/customers/{customer_id}/individual/attach","title":"Attach Documents to Individual Customer","href":"/api-reference/customers/attach-documents-to-individual-customer-v2"}]},{"group":"Create Business Customer","expanded":false,"pages":[{"openapi":"POST /v2/customers/business","title":"Create Business Customer","href":"/api-reference/customers/create-business-customer-v2"},{"openapi":"POST /v2/customers/{customer_id}/business/attach","title":"Attach Documents to Business Customer","href":"/api-reference/customers/attach-documents-to-business-customer-v2"},{"openapi":"POST /v2/customers/{customer_id}/associated-parties/individual/attach","title":"Attach Documents to Associated Party","href":"/api-reference/customers/attach-documents-to-associated-party-v2"}]},{"openapi":"GET /v2/customers/{customer_id}","title":"Get Customer Details","href":"/api-reference/customers/get-customer-details-v2"},{"openapi":"GET /v2/customers","title":"List Customers","href":"/api-reference/customers/list-customers-v2"},{"openapi":"GET /v2/customers/{customer_id}/capabilities","title":"Get Customer Capabilities","description":"Returns the on-ramp and off-ramp capabilities available for a customer, including the supported rails and their activation status for each currency and corridor.","href":"/api-reference/customers/get-customer-capabilities"},{"title":"Get Required Documents","openapi":"GET /v2/customers/required-documents","href":"/api-reference/customers/get-required-documents"},{"openapi":"POST /v1/customers/upload","title":"Upload Document","description":"Upload customer documents using multipart/form-data. Files can be uploaded with arbitrary field names (e.g., poa, poi, passport, file1, etc.)","href":"/api-reference/customers/upload-document"},{"openapi":"PATCH /v1/customers/{customer_id}","title":"Patch Customer RFI","href":"/api-reference/customers/patch-customer-rfi"}]},{"group":"Beneficiaries","pages":[{"group":"Create Beneficiary","expanded":false,"pages":[{"openapi":"POST /v3/beneficiaries","title":"Create Beneficiary V3","href":"/api-reference/beneficiaries/create-beneficiary-v3"},{"openapi":"POST /v2/beneficiaries","title":"Create Beneficiary V2","href":"/api-reference/beneficiaries/create-beneficiary-v2"},{"openapi":"GET /v1/beneficiaries/countries","title":"List Available Countries","href":"/api-reference/beneficiaries/list-available-countries"},{"openapi":"GET /v1/beneficiaries/methods","title":"List Bank Identifiers","href":"/api-reference/beneficiaries/list-bank-identifiers"},{"openapi":"GET /v1/beneficiaries/methods/{method_id}/branches","title":"List Bank Branch Identifiers","href":"/api-reference/beneficiaries/list-bank-branch-identifiers"}]},{"openapi":"GET /v2/beneficiaries/details","title":"Fetch Beneficiary Details","href":"/api-reference/beneficiaries/fetch-beneficiary-details-v2"},{"openapi":"GET /v1/customers/{customer_id}/beneficiaries","title":"List Beneficiaries For a Customer","href":"/api-reference/beneficiaries/list-beneficiaries-for-a-customer"},{"openapi":"PATCH /v1/beneficiaries","title":"Update Beneficiary Active Status","href":"/api-reference/beneficiaries/update-beneficiary-active-status"},{"openapi":"POST /v1/beneficiaries/{beneficiary_id}/documents","title":"Upload Beneficiary Documents","href":"/api-reference/beneficiaries/upload-beneficiary-documents"}]},{"group":"Virtual Accounts","pages":[{"group":"Create Virtual Account","expanded":false,"pages":[{"openapi":"POST /v3/customers/{customer_id}/virtual-accounts","title":"Create Virtual Account V3","href":"/api-reference/virtual-accounts/create-virtual-account-v3"},{"openapi":"POST /v2/customers/{customer_id}/virtual-accounts","title":"Create Virtual Account V2","href":"/api-reference/virtual-accounts/create-virtual-account-v2"}]},{"openapi":"GET /v3/customers/{customer_id}/virtual-accounts","title":"List Virtual Accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts-v3"},{"openapi":"GET /v3/customers/{customer_id}/virtual-accounts/{va_id}","title":"Get Virtual Account Details","href":"/api-reference/virtual-accounts/get-virtual-account-details"},{"openapi":"GET /v1/virtual-account/{virtual_account_id}/transactions","title":"Fetch Virtual Account Transactions","href":"/api-reference/virtual-accounts/fetch-virtual-account-transactions"}]},{"group":"Transactions","pages":[{"group":"Create now, settle later","expanded":false,"pages":[{"openapi":"POST /v3/transactions/transfer-payout","title":"Create a Transfer V3","href":"/api-reference/transactions/create-a-transfer-v3"},{"openapi":"POST /v1/transactions/transfer-payout","title":"Create a Transfer","href":"/api-reference/transactions/create-a-transfer"},{"openapi":"POST /v2/transactions/transfer-payout","title":"Create a Transfer V2","href":"/api-reference/transactions/create-a-transfer-v2"},{"openapi":"POST /v3/transactions/transfer-payout/settle","title":"Settle a Transfer V3","href":"/api-reference/transactions/settle-a-transfer-v3"},{"openapi":"POST /v1/transactions/transfer-payout/settle","title":"Settle a Transfer","href":"/api-reference/transactions/settle-a-transfer"},{"openapi":"POST /v2/transactions/transfer-payout/settle","title":"Settle a Transfer V2","href":"/api-reference/transactions/settle-a-transfer-v2"},{"openapi":"POST /v1/beneficiaries/{beneficiary_id}/documents","title":"Upload Beneficiary Documents","href":"/api-reference/transactions/upload-beneficiary-documents"}]},{"group":"Batch Transfer","expanded":false,"pages":[{"openapi":"POST /v3/batch/transactions/commit","title":"Execute Batch Transfer V3","href":"/api-reference/transactions/execute-batch-transfer-v3"},{"openapi":"POST /v1/batch/transactions/commit","title":"Execute Batch Transfer","href":"/api-reference/transactions/execute-batch-transfer"},{"openapi":"GET /v1/batch/transactions/commit/{batch_id}","title":"Fetch Batch Details","href":"/api-reference/transactions/fetch-batch-details"}]},{"group":"Crypto Transfer","expanded":false,"pages":[{"openapi":"POST /v3/transactions/quote","title":"Create Quote V3","href":"/api-reference/transactions/create-quote-v3"},{"openapi":"POST /v2/transactions/quote","title":"Create Quote","href":"/api-reference/transactions/create-quote"},{"openapi":"POST /v3/transactions","title":"Execute Quote V3","href":"/api-reference/transactions/execute-quote-v3"},{"openapi":"POST /v2/transactions","title":"Execute Quote","href":"/api-reference/transactions/execute-quote"}]},{"group":"Transactions List","expanded":false,"pages":[{"openapi":"GET /v3/transactions","title":"List Customer Transactions V3","href":"/api-reference/transactions/list-customer-transactions-v3"},{"openapi":"GET /v2/transactions","title":"List Customer Transactions","href":"/api-reference/transactions/list-customer-transactions"},{"openapi":"GET /v1/beneficiaries/{beneficiary_id}/transactions","title":"List Beneficiary Transactions","href":"/api-reference/transactions/list-beneficiary-transactions"}]},{"group":"Transaction Details","expanded":false,"pages":[{"openapi":"GET /v3/transactions/{transaction_id}","title":"Fetch Transaction Details V3","href":"/api-reference/transactions/fetch-transaction-details-v3"},{"openapi":"GET /v2/transactions/{transaction_id}","title":"Fetch Transaction Details","href":"/api-reference/transactions/fetch-transaction-details-v2"}]}]},{"group":"Balances","pages":[{"openapi":"GET /v1/wallet/balances","title":"Fetch Prefunded Balance","href":"/api-reference/balances/fetch-prefunded-balance"}]},{"group":"Fees \u0026 FX Rates","pages":[{"openapi":"GET /v1/fx-rate","title":"Fetch Exchange Rates","href":"/api-reference/fees-and-fx-rates/fetch-exchange-rates"},{"openapi":"POST /v1/fee-calculation","title":"Calculate Exchange Rates","href":"/api-reference/fees-and-fx-rates/calculate-exchange-rates"}]},{"group":"Catalogue","pages":[{"group":"All Catalogues","expanded":false,"pages":[{"openapi":"GET /v1/occupations","title":"List Occupations","href":"/api-reference/catalogue/list-occupations"},{"openapi":"GET /v1/source-of-funds","title":"List Source of Funds","href":"/api-reference/catalogue/list-source-of-funds"},{"openapi":"GET /v1/source-of-wealth","title":"List Source of Wealth","href":"/api-reference/catalogue/list-source-of-wealth"},{"openapi":"GET /v1/purposes","title":"List Account Purposes","href":"/api-reference/catalogue/list-account-purposes"},{"title":"List Generic Country Codes","openapi":"GET /v1/countries","href":"/api-reference/catalogue/list-countries"},{"openapi":"GET /v1/countries/{country_code}/subdivisions","title":"List Subdivision Codes: ISO 3166-1 alpha-2","href":"/api-reference/catalogue/list-subdivisions"},{"openapi":"GET /v1/transaction-purposes","title":"List Transaction Purposes","href":"/api-reference/catalogue/list-transaction-purposes"}]}]},{"group":"Webhooks","pages":[{"group":"Customers","expanded":false,"pages":[{"openapi":"WEBHOOK customer.created","title":"Customer Created","href":"/api-reference/webhooks/customer-created"},{"openapi":"WEBHOOK customer.status","title":"Customer Status","href":"/api-reference/webhooks/customer-status"},{"openapi":"WEBHOOK customer.rfi","title":"Customer RFI","href":"/api-reference/webhooks/customer-rfi"}]},{"group":"Beneficiaries","expanded":false,"pages":[{"openapi":"WEBHOOK beneficiary.created","title":"Beneficiary Created","href":"/api-reference/webhooks/beneficiary-created"},{"openapi":"WEBHOOK beneficiary.status","title":"Beneficiary Status","href":"/api-reference/webhooks/beneficiary-status"}]},{"group":"Virtual Accounts","expanded":false,"pages":[{"openapi":"WEBHOOK virtual_account.created.v2","title":"Virtual Account Created V2","href":"/api-reference/webhooks/virtual-account-created-v2"},{"openapi":"WEBHOOK virtual_account.status.v2","title":"Virtual Account Status V2","href":"/api-reference/webhooks/virtual-account-status-v2"}]},{"group":"Transactions","expanded":false,"pages":[{"openapi":"WEBHOOK transaction.status","title":"Transaction Status","href":"/api-reference/webhooks/transaction-status"},{"openapi":"WEBHOOK beneficiary.liquidation.deposit","title":"Beneficiary Liquidation Deposit","href":"/api-reference/webhooks/beneficiary-liquidation-deposit"},{"openapi":"WEBHOOK batch.transaction.item.status","title":"Batch Transaction Item Status","href":"/api-reference/webhooks/batch-transaction-item-status"}]}]}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/changelogs/2026-10-27"}]},{"tab":"FAQs","pages":[{"title":"FAQs","href":"/faqs"}]}]},"basePath":"","title":"Get Required Documents - EngageXPay","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}