email and associatedPersons.email must be unique at each call of the endpoint.
For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.
Entity verification documents. The verification check is only requested once the four required
groups are covered: company details, ownership structure, source of funds and proof of address.
See accepted documents.
List of missing required entity verification documents. Present only if not all required documents have been submitted.
Values: COMPANY_DETAILS_DOCUMENT, OWNERSHIP_STRUCTURE_DOCUMENT, SOURCE_OF_FUNDS_DOCUMENT,
PROOF_OF_ADDRESS_DOCUMENT, PHYSICAL_ADDRESS_QUESTIONNAIRE, ACTIVITY_INFO_QUESTIONNAIRE,
FINANCIAL_INFO_QUESTIONNAIRE.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Byzantine Finance","colors":{"primary":"#702963","light":"#E199D3","dark":"#cd55b7"},"logo":{"light":"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/dark_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=c43aec517b1eeb07c5d662c510c348d5","dark":"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/light_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=3d73a04d2f177a5c5fcc4d74faa62ede"},"favicon":"https://mintcdn.com/byzantinefinance/36NrM9jzigjPERnG/favicon.ico?fit=max\u0026auto=format\u0026n=36NrM9jzigjPERnG\u0026q=85\u0026s=7648bef49c14f9b5b6f64f326431283f","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript"],"prefill":true}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:info@byzantine.fi","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://byzantine.fi"}},"contextual":{"options":["copy","download-spec","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"byzantinefinance","hasAudioNarration":false,"actualSubdomain":"byzantinefinance","customDomains":["docs.byzantine.fi"],"gitSource":{"type":"github","owner":"byzantine-finance","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb4e77b75ff94b1a01d539","collectionId":"c1fb229e-9c35-44a4-9148-7d8bf34e0fba","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb4e77b75ff94b1a01d539"},"entitlements":{},"buildId":"6aeb4e77b75ff94b1a01d539","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"en","tag":"API reference","count":90},{"language":"en","tag":"API endpoints","count":56},{"language":"en","tag":"Integrator API","count":34},{"language":"en","tag":"Transactions","count":18},{"language":"en","tag":"Academy","count":17},{"language":"fr","tag":"Académie","count":17},{"language":"en","tag":"Welcome!","count":15},{"language":"fr","tag":"Bienvenue !","count":15},{"language":"en","tag":"Account management","count":14},{"language":"en","tag":"Account creation","count":11},{"language":"en","tag":"Webhooks","count":10},{"language":"en","tag":"Customer management","count":10},{"language":"fr","tag":"FAQ","count":6},{"language":"fr","tag":"Comment utiliser Byzantine","count":6},{"language":"fr","tag":"À propos de Byzantine","count":5},{"language":"fr","tag":"Protection des actifs","count":5},{"language":"fr","tag":"Actifs numériques 101","count":4},{"language":"fr","tag":"Configuration du compte et sécurité","count":3},{"language":"fr","tag":"Commencer","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customer-management/create-entity","slug":"/api-reference/customer-management/create-entity","pageMetadata":{"title":"Create entity","description":"`email` and `associatedPersons.email` must be unique at each call of the endpoint.\nFor emails, you can use the `+` sign to make them unique, e.g. byzcorp+1@example.com.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-entity-account","href":"/api-reference/customer-management/create-entity","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"email\"\n }), \" and \", _jsx(_components.code, {\n children: \"associatedPersons.email\"\n }), \" must be unique at each call of the endpoint.\\nFor emails, you can use the \", _jsx(_components.code, {\n children: \"+\"\n }), \" sign to make them unique, e.g. \", _jsx(_components.a, {\n href: \"mailto:byzcorp+1@example.com\",\n children: \"byzcorp+1@example.com\"\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":"Create entity","description":"`email` and `associatedPersons.email` must be unique at each call of the endpoint.\nFor emails, you can use the `+` sign to make them unique, e.g. byzcorp+1@example.com.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-entity-account","href":"/api-reference/customer-management/create-entity","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/byzantinefinance/8361d7bc2f630c6c/integrator-auth.js"],"openApiReferenceData":{"operation":{"tags":["Customer management"],"summary":"Create entity","description":"`email` and `associatedPersons.email` must be unique at each call of the endpoint.\nFor emails, you can use the `+` sign to make them unique, e.g. byzcorp+1@example.com.","operationId":"create_entity_account","parameters":["67c25889-7573-4821-af94-6e1165d0e756","8a141772-f86f-4c2a-96b2-a41e5edf96c1","1225d35a-1413-425f-906d-bc76ca0ffd32"],"requestBody":"81f110f3-576b-4918-b74b-bf0cfd5e28a0","responses":{"200":"4faf475b-c773-433a-b90a-df6a61a954e1","400":"c5dfec5d-57d2-48de-ab94-fbbbc2ab2a65","500":"bc2b675d-9442-403d-a45b-81dddd7a2e8c"},"security":["6776578a-5ddb-4e15-865b-2e26cf6b98bc"],"method":"post","type":"path","servers":["24c7134c-2fdd-4d9f-babd-7f420d10d26f"],"path":"/v1/submit/create-entity-account","baseUrlOptions":["https://api.byzantine.fi"],"title":"Create entity","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.entityInfo.businessLegalName":"ByzCorp Incorporated","body.entityInfo.businessTradeName.oneOf.0":"ByzCorp","body.entityInfo.businessType.oneOf.0":"llc","body.entityInfo.companyNumber.oneOf.0":"123456789","body.entityInfo.email.oneOf.0":"byzcorp@example.com","body.entityInfo.website.oneOf.0":"byzcorp.com","body.entityInfo.logoUrl.oneOf.0":"https://byzcorp.com/logo.png","body.entityInfo.registeredAddress.oneOf.0.streetLine1":"33 Rue La Fayette","body.entityInfo.registeredAddress.oneOf.0.city":"Paris","body.entityInfo.registeredAddress.oneOf.0.postalCode":"75009","body.entityInfo.registeredAddress.oneOf.0.country":"FRA","body.entityInfo.registeredAddress.oneOf.0.streetLine2.oneOf.0":"WeWork","body.entityInfo.registeredAddress.oneOf.0.state.oneOf.0":"IDF","body.entityInfo.physicalAddress.oneOf.0.streetLine1":"33 Rue La Fayette","body.entityInfo.physicalAddress.oneOf.0.city":"Paris","body.entityInfo.physicalAddress.oneOf.0.postalCode":"75009","body.entityInfo.physicalAddress.oneOf.0.country":"FRA","body.entityInfo.physicalAddress.oneOf.0.streetLine2.oneOf.0":"WeWork","body.entityInfo.physicalAddress.oneOf.0.state.oneOf.0":"IDF","body.entityInfo.activityInfo.oneOf.0.businessDescription":"ByzCorp does business.","body.entityInfo.activityInfo.oneOf.0.businessIndustry":523110,"body.entityInfo.financialInfo.oneOf.0.sourceOfFunds":"treasury_reserves","body.entityInfo.financialInfo.oneOf.0.estimatedAnnualRevenueUsd":"1000000_9999999","body.entityInfo.financialInfo.oneOf.0.expectedMonthlyPaymentsUsd":5000000,"body.entityInfo.financialInfo.oneOf.0.hasMaterialIntermediaryEntityOwner":false,"body.entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries.oneOf.0":false,"body.entityInfo.highRiskInfo.oneOf.0.highRiskActivities.oneOf.0":"none_of_the_above","body.entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation.oneOf.0":"\u003cstring>","body.entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices.oneOf.0":false,"body.entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription.oneOf.0":"\u003cstring>","body.rootUsers.items.0.firstName":"John","body.rootUsers.items.0.lastName":"Smith","body.rootUsers.items.0.email":"john.smith@example.com","body.rootUsers.items.0.authenticators.oneOf.0.items.0.authenticatorName":"\u003cstring>","body.rootUsers.items.0.authenticators.oneOf.0.items.0.challenge":"\u003cstring>","body.rootUsers.items.0.authenticators.oneOf.0.items.0.attestation.credentialId":"\u003cstring>","body.rootUsers.items.0.authenticators.oneOf.0.items.0.attestation.clientDataJson":"\u003cstring>","body.rootUsers.items.0.authenticators.oneOf.0.items.0.attestation.attestationObject":"\u003cstring>","body.byzantineTermsSignedAt":"2025-11-19T21:14:58.328Z","body.entityDocuments.oneOf.0.items.0.documentType":"incorporation_cert","body.entityDocuments.oneOf.0.items.0.issuingCountry":"FRA","body.entityDocuments.oneOf.0.items.0.document":"data:image/png;base64,iVBORw0lFTkSuQmCC...","body.entityDocuments.oneOf.0.items.0.description.oneOf.0":"An overview of our business activities.","body.associatedPersons.oneOf.0.items.0.userInfo.firstName":"John","body.associatedPersons.oneOf.0.items.0.userInfo.lastName":"Smith","body.associatedPersons.oneOf.0.items.0.userInfo.email":"john.smith@example.com","body.associatedPersons.oneOf.0.items.0.userInfo.middleName.oneOf.0":"William","body.associatedPersons.oneOf.0.items.0.userInfo.phone.oneOf.0":"+33 123 456 789","body.associatedPersons.oneOf.0.items.0.userInfo.birthDate.oneOf.0":"1990-01-01","body.associatedPersons.oneOf.0.items.0.userInfo.nationality.oneOf.0":"FRA","body.associatedPersons.oneOf.0.items.0.userInfo.countryOfBirth.oneOf.0":"FRA","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.streetLine1":"33 Rue La Fayette","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.city":"Paris","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.postalCode":"75009","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.country":"FRA","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0":"WeWork","body.associatedPersons.oneOf.0.items.0.userInfo.residentialAddress.oneOf.0.state.oneOf.0":"IDF","body.associatedPersons.oneOf.0.items.0.userInfo.socialSecurityNumber.oneOf.0":"123-45-6789","body.associatedPersons.oneOf.0.items.0.userInfo.profilePictureUrl.oneOf.0":"\u003cstring>","body.associatedPersons.oneOf.0.items.0.beneficiaryDetails.beneficiaryType.items.0":"ubo","body.associatedPersons.oneOf.0.items.0.beneficiaryDetails.title.oneOf.0":"CEO","body.associatedPersons.oneOf.0.items.0.beneficiaryDetails.ownershipPercentage.oneOf.0":32.5,"body.associatedPersons.oneOf.0.items.0.verificationDocuments.oneOf.0.items.0.issuingCountry":"FRA","body.associatedPersons.oneOf.0.items.0.verificationDocuments.oneOf.0.items.0.document":"data:image/png;base64,iVBORw0lFTkSuQmCC...","body.associatedPersons.oneOf.0.items.0.verificationDocuments.oneOf.0.items.0.documentNumber.oneOf.0":"FR1234567890","body.associatedPersons.oneOf.0.items.0.verificationDocuments.oneOf.0.items.0.description.oneOf.0":"Additional supporting document","body.walletAddress.oneOf.0":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18"}]},"dependencies":{"parameters":{"67c25889-7573-4821-af94-6e1165d0e756":{"name":"X-Pubkey","in":"header","description":"Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd","required":true,"schema":{"type":"string","isRequired":true,"description":"Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd","uniqueKey":"","typeLabel":"string"}},"8a141772-f86f-4c2a-96b2-a41e5edf96c1":{"name":"X-Timestamp","in":"header","description":"Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826","required":true,"schema":{"type":"string","isRequired":true,"description":"Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826","uniqueKey":"","typeLabel":"string"}},"1225d35a-1413-425f-906d-bc76ca0ffd32":{"name":"X-Signature","in":"header","description":"ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: `{timestamp}{METHOD}{path_and_query}{json_body}`. Example: 0x3045022100...","required":true,"schema":{"type":"string","isRequired":true,"description":"ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: `{timestamp}{METHOD}{path_and_query}{json_body}`. Example: 0x3045022100...","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Byzantine entity account creation body","content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a Byzantine entity","required":["entityInfo","rootUsers","byzantineTermsSignedAt"],"properties":{"entityInfo":{"type":"object","description":"Entity information for KYB","required":["businessLegalName"],"properties":{"businessLegalName":{"type":"string","description":"The legal name of the business.","example":"ByzCorp Incorporated","isRequired":true,"uniqueKey":"entityInfo.businessLegalName","typeLabel":"string"},"businessTradeName":{"oneOf":[{"type":"string","description":"The trade name of the business. Can be the same as the entity name.","example":"ByzCorp","uniqueKey":"entityInfo.businessTradeName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The trade name of the business. Can be the same as the entity name.","example":"ByzCorp","uniqueKey":"entityInfo.businessTradeName.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.businessTradeName","typeLabel":"string | null"},"businessType":{"oneOf":[{"type":"string","description":"Business legal form. Select that most appropriate one fitting your jurisdiction.","enum":["cooperative","corporation","llc","other","partnership","sole_prop","trust"],"example":"llc","uniqueKey":"entityInfo.businessType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"entityInfo.businessType.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.businessType","typeLabel":"enum\u003cstring> | null"},"companyNumber":{"oneOf":[{"type":"string","description":"The registered business number. Depending on the country of registration, we accept these [entity number types](https://docs.byzantine.fi/api-reference/lists/company-number-types).","example":"123456789","uniqueKey":"entityInfo.companyNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The registered business number. Depending on the country of registration, we accept these [entity number types](https://docs.byzantine.fi/api-reference/lists/company-number-types).","example":"123456789","uniqueKey":"entityInfo.companyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.companyNumber","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Business contact email.","example":"byzcorp@example.com","uniqueKey":"entityInfo.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business contact email.","example":"byzcorp@example.com","uniqueKey":"entityInfo.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.email","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","description":"Business website.","example":"byzcorp.com","uniqueKey":"entityInfo.website.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business website.","example":"byzcorp.com","uniqueKey":"entityInfo.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.website","typeLabel":"string | null"},"logoUrl":{"oneOf":[{"type":"string","description":"URL of the entity's logo.","example":"https://byzcorp.com/logo.png","uniqueKey":"entityInfo.logoUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the entity's logo.","example":"https://byzcorp.com/logo.png","uniqueKey":"entityInfo.logoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.logoUrl","typeLabel":"string | null"},"registeredAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.registeredAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.registeredAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"entityInfo.registeredAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.registeredAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress","typeLabel":"object | null"},"physicalAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.physicalAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.physicalAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"entityInfo.physicalAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.physicalAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress","typeLabel":"object | null"},"activityInfo":{"oneOf":[{"type":"object","description":"Business activity details. Short business description and [industry code](https://docs.byzantine.fi/api-reference/lists/industry-codes#company-industry-codes)","required":["businessDescription","businessIndustry"],"properties":{"businessDescription":{"type":"string","example":"ByzCorp does business.","maxLength":1024,"minLength":1,"isRequired":true,"uniqueKey":"entityInfo.activityInfo.oneOf.0.businessDescription","typeLabel":"string"},"businessIndustry":{"type":"integer","format":"int64","example":523110,"minimum":0,"isRequired":true,"uniqueKey":"entityInfo.activityInfo.oneOf.0.businessIndustry","typeLabel":"integer\u003cint64>"}},"uniqueKey":"entityInfo.activityInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.activityInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.activityInfo","typeLabel":"object | null"},"financialInfo":{"oneOf":[{"type":"object","description":"Financial informations, required for compliance purposes.","required":["preferredPrimaryCurrency","sourceOfFunds","estimatedAnnualRevenueUsd","expectedMonthlyPaymentsUsd","hasMaterialIntermediaryEntityOwner"],"properties":{"preferredPrimaryCurrency":{"type":"string","enum":["usd","eur","usdc","eurc"],"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.preferredPrimaryCurrency","typeLabel":"enum\u003cstring>"},"sourceOfFunds":{"type":"string","description":"Source of funds for entities.","enum":["business_loans","grants","inter_company_funds","investment_proceeds","legal_settlement","owners_capital","pension_retirement","sale_of_assets","sales_of_goods_and_services","tax_refund","third_party_funds","treasury_reserves"],"example":"treasury_reserves","isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.sourceOfFunds","typeLabel":"enum\u003cstring>"},"estimatedAnnualRevenueUsd":{"type":"string","description":"Estimated annual business revenue in USD, defined as a range.","enum":["0_99999","100000_999999","1000000_9999999","10000000_49999999","50000000_249999999","250000000_plus"],"example":"1000000_9999999","isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.estimatedAnnualRevenueUsd","typeLabel":"enum\u003cstring>"},"expectedMonthlyPaymentsUsd":{"type":"integer","format":"int64","example":5000000,"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.expectedMonthlyPaymentsUsd","typeLabel":"integer\u003cint64>"},"hasMaterialIntermediaryEntityOwner":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.hasMaterialIntermediaryEntityOwner","typeLabel":"boolean"}},"uniqueKey":"entityInfo.financialInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.financialInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.financialInfo","typeLabel":"object | null"},"highRiskInfo":{"oneOf":[{"type":"object","description":"High risk business activities, required for compliance purposes.","properties":{"operatesInProhibitedCountries":{"oneOf":[{"type":"boolean","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries","typeLabel":"boolean | null"},"highRiskActivities":{"oneOf":[{"type":"string","description":"High risk business activities. Must be declared if the business is engaged in any.","enum":["adult_entertainment","gambling","hold_client_funds","investment_services","lending_banking","marijuana_or_related_services","money_services","nicotine_tobacco_or_related_services","operate_foreign_exchange_virtual_currencies_brokerage_otc","pharmaceuticals","precious_metals_precious_stones_jewelry","safe_deposit_box_rentals","third_party_payment_processing","weapons_firearms_and_explosives","none_of_the_above"],"example":"none_of_the_above","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities","typeLabel":"enum\u003cstring> | null"},"highRiskActivitiesExplanation":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation","typeLabel":"string | null"},"conductsMoneyServices":{"oneOf":[{"type":"boolean","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices","typeLabel":"boolean | null"},"conductsMoneyServicesDescription":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription","typeLabel":"string | null"}},"uniqueKey":"entityInfo.highRiskInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"entityInfo","typeLabel":"object"},"rootUsers":{"type":"array","items":{"type":"object","description":"Root user for acount management. At least one is required at creation.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","example":"John","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Smith","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","example":"john.smith@example.com","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].email","typeLabel":"string"},"authenticators":{"oneOf":[{"type":"array","items":{"type":"object","description":"Passkey authenticator object.","required":["authenticatorName","challenge","attestation"],"properties":{"authenticatorName":{"type":"string","description":"Human-readable name for an Authenticator.","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].authenticatorName","typeLabel":"string"},"challenge":{"type":"string","description":"Challenge presented for authentication purposes.","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].challenge","typeLabel":"string"},"attestation":{"type":"object","required":["credentialId","clientDataJson","attestationObject","transports"],"properties":{"credentialId":{"type":"string","description":"The cbor encoded then base64 url encoded id of the credential.","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation.credentialId","typeLabel":"string"},"clientDataJson":{"type":"string","description":"A base64 url encoded payload containing metadata about the signing context and the challenge.","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation.clientDataJson","typeLabel":"string"},"attestationObject":{"type":"string","description":"A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation.attestationObject","typeLabel":"string"},"transports":{"type":"array","items":{"type":"string","enum":["AUTHENTICATOR_TRANSPORT_BLE","AUTHENTICATOR_TRANSPORT_INTERNAL","AUTHENTICATOR_TRANSPORT_NFC","AUTHENTICATOR_TRANSPORT_USB","AUTHENTICATOR_TRANSPORT_HYBRID","Unknown"],"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation.transports.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation.transports","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX].attestation","typeLabel":"object"}},"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Passkey authenticator object.","required":["authenticatorName","challenge","attestation"],"properties":{"authenticatorName":{"type":"string","description":"Human-readable name for an Authenticator."},"challenge":{"type":"string","description":"Challenge presented for authentication purposes."},"attestation":{"type":"object","required":["credentialId","clientDataJson","attestationObject","transports"],"properties":{"credentialId":{"type":"string","description":"The cbor encoded then base64 url encoded id of the credential."},"clientDataJson":{"type":"string","description":"A base64 url encoded payload containing metadata about the signing context and the challenge."},"attestationObject":{"type":"string","description":"A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses."},"transports":{"type":"array","items":{"type":"string","enum":["AUTHENTICATOR_TRANSPORT_BLE","AUTHENTICATOR_TRANSPORT_INTERNAL","AUTHENTICATOR_TRANSPORT_NFC","AUTHENTICATOR_TRANSPORT_USB","AUTHENTICATOR_TRANSPORT_HYBRID","Unknown"]}}}}}},"uniqueKey":"rootUsers.items.[INDEX].authenticators.oneOf.1","typeLabel":"null"}],"uniqueKey":"rootUsers.items.[INDEX].authenticators","typeLabel":"object[] | null"}},"uniqueKey":"rootUsers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rootUsers","typeLabel":"object[]"},"byzantineTermsSignedAt":{"type":"string","description":"The timestamp when the Byzantine Finance Terms \u0026 Conditions were signed. For more information, see [individual account creation - KYC](https://docs.byzantine.fi/api-reference/kyc).","example":"2025-11-19T21:14:58.328Z","isRequired":true,"uniqueKey":"byzantineTermsSignedAt","typeLabel":"string"},"entityDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Entity verification document object. For a full list of required documents, see [accepted documents](https://docs.byzantine.fi/api-reference/documents).","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Entity document type. For a full list of accepted document types, see [accepted documents](https://docs.byzantine.fi/api-reference/documents).\n\nFour document groups are required before the verification check can be requested; a missing group\nis reported in `missingDocuments` with the code in brackets:\n- company details (`COMPANY_DETAILS_DOCUMENT`): `incorporation_cert`, `incorporation_articles` or `state_registry`\n- ownership structure (`OWNERSHIP_STRUCTURE_DOCUMENT`): `shareholder_registry`, `information_statement`, `trust_agreement` or `partnership_agreement`\n- source of funds (`SOURCE_OF_FUNDS_DOCUMENT`): `source_of_funds`\n- proof of address (`PROOF_OF_ADDRESS_DOCUMENT`): `proof_of_address`, a document in the entity's name proving its physical address (utility bill, lease, bank statement, ...)\n\n`directors_registry`, `good_standing_cert`, `incumbency_cert`, `power_of_attorney` and `other` are optional.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentType","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].issuingCountry","typeLabel":"enum\u003cstring>"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC...","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].document","typeLabel":"string\u003cdata:[MIME];base64,[base64-encoded-data]>"},"description":{"oneOf":[{"type":"string","description":"A description of the document. Must be submitted if document if os type `other`.","example":"An overview of our business activities.","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the document. Must be submitted if document if os type `other`.","example":"An overview of our business activities.","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Entity verification documents. The verification check is only requested once the four required\ngroups are covered: company details, ownership structure, source of funds and proof of address.\nSee [accepted documents](https://docs.byzantine.fi/api-reference/documents).","uniqueKey":"entityDocuments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Entity verification document object. For a full list of required documents, see [accepted documents](https://docs.byzantine.fi/api-reference/documents).","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Entity document type. For a full list of accepted document types, see [accepted documents](https://docs.byzantine.fi/api-reference/documents).\n\nFour document groups are required before the verification check can be requested; a missing group\nis reported in `missingDocuments` with the code in brackets:\n- company details (`COMPANY_DETAILS_DOCUMENT`): `incorporation_cert`, `incorporation_articles` or `state_registry`\n- ownership structure (`OWNERSHIP_STRUCTURE_DOCUMENT`): `shareholder_registry`, `information_statement`, `trust_agreement` or `partnership_agreement`\n- source of funds (`SOURCE_OF_FUNDS_DOCUMENT`): `source_of_funds`\n- proof of address (`PROOF_OF_ADDRESS_DOCUMENT`): `proof_of_address`, a document in the entity's name proving its physical address (utility bill, lease, bank statement, ...)\n\n`directors_registry`, `good_standing_cert`, `incumbency_cert`, `power_of_attorney` and `other` are optional.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert"},"description":{"oneOf":[{"type":"string","description":"A description of the document. Must be submitted if document if os type `other`.","example":"An overview of our business activities."},{"type":"null","description":"A description of the document. Must be submitted if document if os type `other`.","example":"An overview of our business activities."}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC..."}}},"description":"Entity verification documents. The verification check is only requested once the four required\ngroups are covered: company details, ownership structure, source of funds and proof of address.\nSee [accepted documents](https://docs.byzantine.fi/api-reference/documents).","uniqueKey":"entityDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments","typeLabel":"object[] | null"},"associatedPersons":{"oneOf":[{"type":"array","items":{"type":"object","description":"Associated person (beneficiary or representative).","required":["userInfo","beneficiaryDetails"],"properties":{"userInfo":{"type":"object","description":"Personal information about the user required for identity verification.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"First name of the user.","example":"John","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.lastName","typeLabel":"string"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.email","typeLabel":"string"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate","typeLabel":"string | null"},"nationality":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality","typeLabel":"enum\u003cstring> | null"},"countryOfBirth":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth","typeLabel":"enum\u003cstring> | null"},"residentialAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress","typeLabel":"object | null"},"socialSecurityNumber":{"oneOf":[{"type":"string","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo","typeLabel":"object"},"beneficiaryDetails":{"type":"object","description":"Additional details about beneficiaries.","required":["beneficiaryType"],"properties":{"beneficiaryType":{"type":"array","items":{"type":"string","description":"Beneficiary type.\n\nUBOs are any individuals who, directly or inderectly, own more than 25% of the business.\n\nRepresentatives are individuals who have direct control over daily operations.","enum":["ubo","representative"],"example":"ubo","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.beneficiaryType.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.beneficiaryType","typeLabel":"enum\u003cstring>[]"},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title","typeLabel":"string | null"},"ownershipPercentage":{"oneOf":[{"type":"number","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails","typeLabel":"object"},"verificationDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Document(s) to verify the identity of the user.","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Type of the document. See the full list of [accepted documents](https://docs.byzantine.fi/api-reference/documents).","enum":["passport","national_id_front","national_id_back","proof_of_address","other"],"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentType","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].issuingCountry","typeLabel":"enum\u003cstring>"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC...","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].document","typeLabel":"string\u003cdata:[MIME];base64,[base64-encoded-data]>"},"documentNumber":{"oneOf":[{"type":"string","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Required if document type is 'other'.","example":"Additional supporting document","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required if document type is 'other'.","example":"Additional supporting document","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Document(s) to verify the identity of the user.","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Type of the document. See the full list of [accepted documents](https://docs.byzantine.fi/api-reference/documents).","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},"documentNumber":{"oneOf":[{"type":"string","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"},{"type":"null","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","description":"Required if document type is 'other'.","example":"Additional supporting document"},{"type":"null","description":"Required if document type is 'other'.","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC..."}}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments","typeLabel":"object[] | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"associatedPersons.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Associated person (beneficiary or representative).","required":["userInfo","beneficiaryDetails"],"properties":{"userInfo":{"type":"object","description":"Personal information about the user required for identity verification.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"First name of the user.","example":"John"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William"},{"type":"null","description":"Middle name of the user.","example":"William"}]},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789"}]},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01"},{"type":"null","description":"User's date of birth.","example":"1990-01-01"}]},"nationality":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},{"type":"null"}]},"countryOfBirth":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},{"type":"null"}]},"residentialAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork"}]},"city":{"type":"string","example":"Paris"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF"}]},"postalCode":{"type":"string","description":"Postal code.","example":"75009"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"}}},{"type":"null"}]},"socialSecurityNumber":{"oneOf":[{"type":"string","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789"},{"type":"null","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789"}]},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)"}]}}},"beneficiaryDetails":{"type":"object","description":"Additional details about beneficiaries.","required":["beneficiaryType"],"properties":{"beneficiaryType":{"type":"array","items":{"type":"string","description":"Beneficiary type.\n\nUBOs are any individuals who, directly or inderectly, own more than 25% of the business.\n\nRepresentatives are individuals who have direct control over daily operations.","enum":["ubo","representative"],"example":"ubo"}},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO"}]},"ownershipPercentage":{"oneOf":[{"type":"number","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5},{"type":"null","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5}]}}},"verificationDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Document(s) to verify the identity of the user.","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Type of the document. See the full list of [accepted documents](https://docs.byzantine.fi/api-reference/documents).","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},"documentNumber":{"oneOf":[{"type":"string","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"},{"type":"null","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","description":"Required if document type is 'other'.","example":"Additional supporting document"},{"type":"null","description":"Required if document type is 'other'.","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC..."}}}},{"type":"null","items":{"type":"object","description":"Document(s) to verify the identity of the user.","required":["documentType","issuingCountry","document"],"properties":{"documentType":{"type":"string","description":"Type of the document. See the full list of [accepted documents](https://docs.byzantine.fi/api-reference/documents).","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},"documentNumber":{"oneOf":[{"type":"string","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"},{"type":"null","description":"Required for identity documents (passport, national ID). Must be the full document number.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","description":"Required if document type is 'other'.","example":"Additional supporting document"},{"type":"null","description":"Required if document type is 'other'.","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},"document":{"type":"string","format":"data:[MIME];base64,[base64-encoded-data]","description":"The document to be uploaded.\n\nSupported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf","example":"data:image/png;base64,iVBORw0lFTkSuQmCC..."}}}}]}}},"uniqueKey":"associatedPersons.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons","typeLabel":"object[] | null"},"walletAddress":{"oneOf":[{"type":"string","description":"Optional wallet address for self-custodial accounts. If provided, no Turnkey sub-organization will be created and `required_approvals` will be set to 0.","example":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","uniqueKey":"walletAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional wallet address for self-custodial accounts. If provided, no Turnkey sub-organization will be created and `required_approvals` will be set to 0.","example":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","uniqueKey":"walletAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"walletAddress","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityInfo":{"businessLegalName":"ByzCorp Incorporated","businessTradeName":"ByzCorp","businessType":"llc","companyNumber":"123456789","email":"byzcorp@example.com","website":"byzcorp.com","logoUrl":"https://byzcorp.com/logo.png","registeredAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"physicalAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"activityInfo":{"businessDescription":"ByzCorp does business.","businessIndustry":523110},"financialInfo":{"sourceOfFunds":"treasury_reserves","estimatedAnnualRevenueUsd":"1000000_9999999","expectedMonthlyPaymentsUsd":5000000,"hasMaterialIntermediaryEntityOwner":false},"highRiskInfo":{"operatesInProhibitedCountries":false,"highRiskActivities":"none_of_the_above","highRiskActivitiesExplanation":"\u003cstring>","conductsMoneyServices":false,"conductsMoneyServicesDescription":"\u003cstring>"}},"rootUsers":[{"firstName":"John","lastName":"Smith","email":"john.smith@example.com","authenticators":[{"authenticatorName":"\u003cstring>","challenge":"\u003cstring>","attestation":{"credentialId":"\u003cstring>","clientDataJson":"\u003cstring>","attestationObject":"\u003cstring>","transports":[]}}]}],"byzantineTermsSignedAt":"2025-11-19T21:14:58.328Z","entityDocuments":[{"documentType":"incorporation_cert","issuingCountry":"FRA","document":"data:image/png;base64,iVBORw0lFTkSuQmCC...","description":"An overview of our business activities."}],"associatedPersons":[{"userInfo":{"firstName":"John","lastName":"Smith","email":"john.smith@example.com","middleName":"William","phone":"+33 123 456 789","birthDate":"1990-01-01","nationality":"FRA","countryOfBirth":"FRA","residentialAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"socialSecurityNumber":"123-45-6789","profilePictureUrl":"\u003cstring>"},"beneficiaryDetails":{"beneficiaryType":["ubo"],"title":"CEO","ownershipPercentage":32.5},"verificationDocuments":[{"issuingCountry":"FRA","document":"data:image/png;base64,iVBORw0lFTkSuQmCC...","documentNumber":"FR1234567890","description":"Additional supporting document"}]}],"walletAddress":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4faf475b-c773-433a-b90a-df6a61a954e1":{"description":"Entity account created successfully","content":{"application/json":{"schema":{"type":"object","description":"Response body for creating a Byzantine entity","required":["entityId","accountId","verificationStatus","entityInfo","rootUsers","walletAddress","byzantineTermsSignedAt"],"properties":{"entityId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"entityId","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"accountId","typeLabel":"string\u003cuuid>"},"verificationStatus":{"type":"string","description":"The identity verification status of the user.","enum":["not_started","init","under_review","awaiting_associated_person_information","awaiting_information","resubmission_requested","active","rejected","inactive"],"example":"active","isRequired":true,"uniqueKey":"verificationStatus","typeLabel":"enum\u003cstring>"},"entityInfo":{"type":"object","description":"Entity information for KYB","required":["businessLegalName"],"properties":{"businessLegalName":{"type":"string","description":"The legal name of the business.","example":"ByzCorp Incorporated","isRequired":true,"uniqueKey":"entityInfo.businessLegalName","typeLabel":"string"},"businessTradeName":{"oneOf":[{"type":"string","description":"The trade name of the business. Can be the same as the entity name.","example":"ByzCorp","uniqueKey":"entityInfo.businessTradeName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The trade name of the business. Can be the same as the entity name.","example":"ByzCorp","uniqueKey":"entityInfo.businessTradeName.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.businessTradeName","typeLabel":"string | null"},"businessType":{"oneOf":[{"type":"string","description":"Business legal form. Select that most appropriate one fitting your jurisdiction.","enum":["cooperative","corporation","llc","other","partnership","sole_prop","trust"],"example":"llc","uniqueKey":"entityInfo.businessType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"entityInfo.businessType.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.businessType","typeLabel":"enum\u003cstring> | null"},"companyNumber":{"oneOf":[{"type":"string","description":"The registered business number. Depending on the country of registration, we accept these [entity number types](https://docs.byzantine.fi/api-reference/lists/company-number-types).","example":"123456789","uniqueKey":"entityInfo.companyNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The registered business number. Depending on the country of registration, we accept these [entity number types](https://docs.byzantine.fi/api-reference/lists/company-number-types).","example":"123456789","uniqueKey":"entityInfo.companyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.companyNumber","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Business contact email.","example":"byzcorp@example.com","uniqueKey":"entityInfo.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business contact email.","example":"byzcorp@example.com","uniqueKey":"entityInfo.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.email","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","description":"Business website.","example":"byzcorp.com","uniqueKey":"entityInfo.website.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business website.","example":"byzcorp.com","uniqueKey":"entityInfo.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.website","typeLabel":"string | null"},"logoUrl":{"oneOf":[{"type":"string","description":"URL of the entity's logo.","example":"https://byzcorp.com/logo.png","uniqueKey":"entityInfo.logoUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the entity's logo.","example":"https://byzcorp.com/logo.png","uniqueKey":"entityInfo.logoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.logoUrl","typeLabel":"string | null"},"registeredAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"entityInfo.registeredAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.registeredAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.registeredAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"entityInfo.registeredAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.registeredAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.registeredAddress","typeLabel":"object | null"},"physicalAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"entityInfo.physicalAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.physicalAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"entityInfo.physicalAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"entityInfo.physicalAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.physicalAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.physicalAddress","typeLabel":"object | null"},"activityInfo":{"oneOf":[{"type":"object","description":"Business activity details. Short business description and [industry code](https://docs.byzantine.fi/api-reference/lists/industry-codes#company-industry-codes)","required":["businessDescription","businessIndustry"],"properties":{"businessDescription":{"type":"string","example":"ByzCorp does business.","maxLength":1024,"minLength":1,"isRequired":true,"uniqueKey":"entityInfo.activityInfo.oneOf.0.businessDescription","typeLabel":"string"},"businessIndustry":{"type":"integer","format":"int64","example":523110,"minimum":0,"isRequired":true,"uniqueKey":"entityInfo.activityInfo.oneOf.0.businessIndustry","typeLabel":"integer\u003cint64>"}},"uniqueKey":"entityInfo.activityInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.activityInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.activityInfo","typeLabel":"object | null"},"financialInfo":{"oneOf":[{"type":"object","description":"Financial informations, required for compliance purposes.","required":["preferredPrimaryCurrency","sourceOfFunds","estimatedAnnualRevenueUsd","expectedMonthlyPaymentsUsd","hasMaterialIntermediaryEntityOwner"],"properties":{"preferredPrimaryCurrency":{"type":"string","enum":["usd","eur","usdc","eurc"],"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.preferredPrimaryCurrency","typeLabel":"enum\u003cstring>"},"sourceOfFunds":{"type":"string","description":"Source of funds for entities.","enum":["business_loans","grants","inter_company_funds","investment_proceeds","legal_settlement","owners_capital","pension_retirement","sale_of_assets","sales_of_goods_and_services","tax_refund","third_party_funds","treasury_reserves"],"example":"treasury_reserves","isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.sourceOfFunds","typeLabel":"enum\u003cstring>"},"estimatedAnnualRevenueUsd":{"type":"string","description":"Estimated annual business revenue in USD, defined as a range.","enum":["0_99999","100000_999999","1000000_9999999","10000000_49999999","50000000_249999999","250000000_plus"],"example":"1000000_9999999","isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.estimatedAnnualRevenueUsd","typeLabel":"enum\u003cstring>"},"expectedMonthlyPaymentsUsd":{"type":"integer","format":"int64","example":5000000,"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.expectedMonthlyPaymentsUsd","typeLabel":"integer\u003cint64>"},"hasMaterialIntermediaryEntityOwner":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"entityInfo.financialInfo.oneOf.0.hasMaterialIntermediaryEntityOwner","typeLabel":"boolean"}},"uniqueKey":"entityInfo.financialInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.financialInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.financialInfo","typeLabel":"object | null"},"highRiskInfo":{"oneOf":[{"type":"object","description":"High risk business activities, required for compliance purposes.","properties":{"operatesInProhibitedCountries":{"oneOf":[{"type":"boolean","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.operatesInProhibitedCountries","typeLabel":"boolean | null"},"highRiskActivities":{"oneOf":[{"type":"string","description":"High risk business activities. Must be declared if the business is engaged in any.","enum":["adult_entertainment","gambling","hold_client_funds","investment_services","lending_banking","marijuana_or_related_services","money_services","nicotine_tobacco_or_related_services","operate_foreign_exchange_virtual_currencies_brokerage_otc","pharmaceuticals","precious_metals_precious_stones_jewelry","safe_deposit_box_rentals","third_party_payment_processing","weapons_firearms_and_explosives","none_of_the_above"],"example":"none_of_the_above","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivities","typeLabel":"enum\u003cstring> | null"},"highRiskActivitiesExplanation":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.highRiskActivitiesExplanation","typeLabel":"string | null"},"conductsMoneyServices":{"oneOf":[{"type":"boolean","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServices","typeLabel":"boolean | null"},"conductsMoneyServicesDescription":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo.oneOf.0.conductsMoneyServicesDescription","typeLabel":"string | null"}},"uniqueKey":"entityInfo.highRiskInfo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entityInfo.highRiskInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.highRiskInfo","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"entityInfo","typeLabel":"object"},"rootUsers":{"type":"array","items":{"type":"object","description":"Root user with wallet access","required":["userId","firstName","lastName","email","isPasskeyActivated","isOtpActivated"],"properties":{"userId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","example":"John","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Smith","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","example":"john.smith@example.com","isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].email","typeLabel":"string"},"isPasskeyActivated":{"type":"boolean","description":"An indicator showing whether passkey authentication is active for this user. For more information, see [authentication methods](https://docs.byzantine.fi/api-reference/authentication-methods).","example":true,"isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].isPasskeyActivated","typeLabel":"boolean"},"isOtpActivated":{"type":"boolean","description":"An indicator showing whether OTP authentication is active for this user. For more information, see [authentication methods](https://docs.byzantine.fi/api-reference/authentication-methods).","example":false,"isRequired":true,"uniqueKey":"rootUsers.items.[INDEX].isOtpActivated","typeLabel":"boolean"}},"uniqueKey":"rootUsers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rootUsers","typeLabel":"object[]"},"walletAddress":{"type":"string","description":"The wallet address associated with this account.","example":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","isRequired":true,"uniqueKey":"walletAddress","typeLabel":"string"},"byzantineTermsSignedAt":{"type":"string","description":"The timestamp when the Byzantine Finance Terms \u0026 Conditions were signed. For more information, see [individual account creation - KYC](https://docs.byzantine.fi/api-reference/kyc).","example":"2025-11-19T21:14:58.328Z","isRequired":true,"uniqueKey":"byzantineTermsSignedAt","typeLabel":"string"},"entityDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"],"isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentType","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].issuingCountry","typeLabel":"string"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452","isRequired":true,"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentId","typeLabel":"string"},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].documentNumber","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Additional supporting document","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Additional supporting document","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].warnings.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].warnings","typeLabel":"string[] | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX].errors","typeLabel":"string[] | null"}},"uniqueKey":"entityDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entityDocuments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert"}]},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","example":"Additional supporting document"},{"type":"null","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]},"errors":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]}}},"uniqueKey":"entityDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityDocuments","typeLabel":"object[] | null"},"associatedPersons":{"oneOf":[{"type":"array","items":{"type":"object","description":"Response body for an associated person","required":["beneficiaryId","verificationStatus","userInfo","beneficiaryDetails"],"properties":{"beneficiaryId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryId","typeLabel":"string\u003cuuid>"},"verificationStatus":{"type":"string","description":"The identity verification status of the user.","enum":["not_started","init","under_review","awaiting_associated_person_information","awaiting_information","resubmission_requested","active","rejected","inactive"],"example":"active","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationStatus","typeLabel":"enum\u003cstring>"},"userInfo":{"type":"object","description":"Personal information about the user required for identity verification.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"First name of the user.","example":"John","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.lastName","typeLabel":"string"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.email","typeLabel":"string"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.middleName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.phone","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.birthDate","typeLabel":"string | null"},"nationality":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.nationality","typeLabel":"enum\u003cstring> | null"},"countryOfBirth":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.countryOfBirth","typeLabel":"enum\u003cstring> | null"},"residentialAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.streetLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.residentialAddress","typeLabel":"object | null"},"socialSecurityNumber":{"oneOf":[{"type":"string","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.socialSecurityNumber","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo.profilePictureUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].userInfo","typeLabel":"object"},"beneficiaryDetails":{"type":"object","description":"Additional details about beneficiaries.","required":["beneficiaryType"],"properties":{"beneficiaryType":{"type":"array","items":{"type":"string","description":"Beneficiary type.\n\nUBOs are any individuals who, directly or inderectly, own more than 25% of the business.\n\nRepresentatives are individuals who have direct control over daily operations.","enum":["ubo","representative"],"example":"ubo","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.beneficiaryType.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.beneficiaryType","typeLabel":"enum\u003cstring>[]"},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.title","typeLabel":"string | null"},"ownershipPercentage":{"oneOf":[{"type":"number","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails.ownershipPercentage","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].beneficiaryDetails","typeLabel":"object"},"verificationDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"],"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentType","typeLabel":"enum\u003cstring>"},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].issuingCountry","typeLabel":"string"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452","isRequired":true,"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentId","typeLabel":"string"},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].documentNumber","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Additional supporting document","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Additional supporting document","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].warnings","typeLabel":"string[] | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX].errors","typeLabel":"string[] | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert"}]},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","example":"Additional supporting document"},{"type":"null","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]},"errors":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]}}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].verificationDocuments","typeLabel":"object[] | null"},"missingDocuments":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].missingDocuments.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of missing required verification documents. Present only if not all required documents have been submitted.","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].missingDocuments.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of missing required verification documents. Present only if not all required documents have been submitted.","uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].missingDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX].missingDocuments","typeLabel":"string[] | null"}},"uniqueKey":"associatedPersons.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"associatedPersons.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Response body for an associated person","required":["beneficiaryId","verificationStatus","userInfo","beneficiaryDetails"],"properties":{"beneficiaryId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000"},"verificationStatus":{"type":"string","description":"The identity verification status of the user.","enum":["not_started","init","under_review","awaiting_associated_person_information","awaiting_information","resubmission_requested","active","rejected","inactive"],"example":"active"},"userInfo":{"type":"object","description":"Personal information about the user required for identity verification.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","description":"First name of the user.","example":"John"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William"},{"type":"null","description":"Middle name of the user.","example":"William"}]},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789"}]},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01"},{"type":"null","description":"User's date of birth.","example":"1990-01-01"}]},"nationality":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},{"type":"null"}]},"countryOfBirth":{"oneOf":[{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"},{"type":"null"}]},"residentialAddress":{"oneOf":[{"type":"object","description":"Address information. Must be a valid address in the relevant country.","required":["streetLine1","city","postalCode","country"],"properties":{"streetLine1":{"type":"string","example":"33 Rue La Fayette"},"streetLine2":{"oneOf":[{"type":"string","description":"Optional additional details to the street name and number.","example":"WeWork"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork"}]},"city":{"type":"string","example":"Paris"},"state":{"oneOf":[{"type":"string","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF"},{"type":"null","description":"Required for US addresses. Should be a valid ISO 3166-2 subdivision code.","example":"IDF"}]},"postalCode":{"type":"string","description":"Postal code.","example":"75009"},"country":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","enum":["ABW","AFG","AGO","ALB","AND","ARG","ARM","AUS","AUT","AZE","BEL","BGD","BGR","BHR","BHS","BIH","BLZ","BMU","BOL","BRA","BRB","BWA","CAN","CHL","CHN","CIV","CMR","COL","COM","CRI","CUW","CXR","CYM","CYP","CZE","DEU","DMA","DNK","DOM","DZA","ECU","EGY","ESP","EST","ETH","FIN","FJI","FRA","GBR","GEO","GHA","GIB","GRC","GTM","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRQ","ISL","ISR","ITA","JAM","JOR","JPN","KAZ","KEN","KGZ","KHM","KNA","KOR","KWT","LAO","LBN","LBR","LCA","LKA","LTU","LUX","LVA","MAR","MCO","MDA","MDG","MEX","MHL","MKD","MLT","MNE","MOZ","MRT","MUS","MWI","MYS","NAM","NGA","NIC","NLD","NOR","NPL","NZL","OMN","PAN","PER","PHL","PAK","POL","PRT","QAT","ROU","RUS","SAU","SEN","SGP","SMR","SVK","SVN","ZAF","SWE","CHE","THA","TUN","TUR","UGA","UKR","ARE","USA","URY","UZB","VEN","VNM","YEM","ZMB","ZWE"],"example":"FRA"}}},{"type":"null"}]},"socialSecurityNumber":{"oneOf":[{"type":"string","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789"},{"type":"null","description":"Required exclusively for USA-based users. Must be the full social security number.","example":"123-45-6789"}]},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)"}]}}},"beneficiaryDetails":{"type":"object","description":"Additional details about beneficiaries.","required":["beneficiaryType"],"properties":{"beneficiaryType":{"type":"array","items":{"type":"string","description":"Beneficiary type.\n\nUBOs are any individuals who, directly or inderectly, own more than 25% of the business.\n\nRepresentatives are individuals who have direct control over daily operations.","enum":["ubo","representative"],"example":"ubo"}},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO"}]},"ownershipPercentage":{"oneOf":[{"type":"number","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5},{"type":"null","format":"double","description":"Required for UBOs. The % of direct or indirect business ownership.","example":32.5}]}}},"verificationDocuments":{"oneOf":[{"type":"array","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert"}]},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","example":"Additional supporting document"},{"type":"null","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]},"errors":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]}}}},{"type":"null","items":{"type":"object","description":"Response body for verification documents.","required":["documentType","issuingCountry","documentId"],"properties":{"documentType":{"oneOf":[{"type":"string","description":"Type of verification document.","enum":["passport","national_id_front","national_id_back","proof_of_address","other"]},{"type":"string","description":"Type of verification document.","enum":["directors_registry","good_standing_cert","incorporation_articles","incorporation_cert","incumbency_cert","information_statement","partnership_agreement","power_of_attorney","proof_of_address","shareholder_registry","source_of_funds","state_registry","trust_agreement","other"],"example":"incorporation_cert"}]},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890"}]},"description":{"oneOf":[{"type":"string","example":"Additional supporting document"},{"type":"null","example":"Additional supporting document"}]},"issuingCountry":{"type":"string","description":"The ISO 3166-1 (three-character) country code of the relevant country. See the full list of [countries](https://docs.byzantine.fi/api-reference/lists/countries).","example":"FRA"},"documentId":{"type":"string","description":"Unique identifier assigned to the document.","example":"830c219c-d197-451d-b879-77936a80c452"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]},"errors":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]}}}}]},"missingDocuments":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"List of missing required verification documents. Present only if not all required documents have been submitted."},{"type":"null","items":{"type":"string"},"description":"List of missing required verification documents. Present only if not all required documents have been submitted."}]}}},"uniqueKey":"associatedPersons.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons","typeLabel":"object[] | null"},"missingCompanyData":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"missingCompanyData.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of missing required company data. Present only if not all required company information has been provided.","uniqueKey":"missingCompanyData.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of missing required company data. Present only if not all required company information has been provided.","uniqueKey":"missingCompanyData.oneOf.1","typeLabel":"null"}],"uniqueKey":"missingCompanyData","typeLabel":"string[] | null"},"missingDocuments":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"missingDocuments.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of missing required entity verification documents. Present only if not all required documents have been submitted.\nValues: `COMPANY_DETAILS_DOCUMENT`, `OWNERSHIP_STRUCTURE_DOCUMENT`, `SOURCE_OF_FUNDS_DOCUMENT`,\n`PROOF_OF_ADDRESS_DOCUMENT`, `PHYSICAL_ADDRESS_QUESTIONNAIRE`, `ACTIVITY_INFO_QUESTIONNAIRE`,\n`FINANCIAL_INFO_QUESTIONNAIRE`.","uniqueKey":"missingDocuments.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of missing required entity verification documents. Present only if not all required documents have been submitted.\nValues: `COMPANY_DETAILS_DOCUMENT`, `OWNERSHIP_STRUCTURE_DOCUMENT`, `SOURCE_OF_FUNDS_DOCUMENT`,\n`PROOF_OF_ADDRESS_DOCUMENT`, `PHYSICAL_ADDRESS_QUESTIONNAIRE`, `ACTIVITY_INFO_QUESTIONNAIRE`,\n`FINANCIAL_INFO_QUESTIONNAIRE`.","uniqueKey":"missingDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"missingDocuments","typeLabel":"string[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityId":"550e8400-e29b-41d4-a716-446655440000","accountId":"550e8400-e29b-41d4-a716-446655440000","verificationStatus":"active","entityInfo":{"businessLegalName":"ByzCorp Incorporated","businessTradeName":"ByzCorp","businessType":"llc","companyNumber":"123456789","email":"byzcorp@example.com","website":"byzcorp.com","logoUrl":"https://byzcorp.com/logo.png","registeredAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"physicalAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"activityInfo":{"businessDescription":"ByzCorp does business.","businessIndustry":523110},"financialInfo":{"preferredPrimaryCurrency":"usd","sourceOfFunds":"treasury_reserves","estimatedAnnualRevenueUsd":"1000000_9999999","expectedMonthlyPaymentsUsd":5000000,"hasMaterialIntermediaryEntityOwner":false},"highRiskInfo":{"operatesInProhibitedCountries":false,"highRiskActivities":"none_of_the_above","highRiskActivitiesExplanation":"\u003cstring>","conductsMoneyServices":false,"conductsMoneyServicesDescription":"\u003cstring>"}},"rootUsers":[{"userId":"550e8400-e29b-41d4-a716-446655440000","firstName":"John","lastName":"Smith","email":"john.smith@example.com","isPasskeyActivated":true,"isOtpActivated":false}],"walletAddress":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","byzantineTermsSignedAt":"2025-11-19T21:14:58.328Z","entityDocuments":[{"documentType":"passport","issuingCountry":"FRA","documentId":"830c219c-d197-451d-b879-77936a80c452","documentNumber":"FR1234567890","description":"Additional supporting document","warnings":["\u003cstring>"],"errors":["\u003cstring>"]}],"associatedPersons":[{"beneficiaryId":"550e8400-e29b-41d4-a716-446655440000","verificationStatus":"active","userInfo":{"firstName":"John","lastName":"Smith","email":"john.smith@example.com","middleName":"William","phone":"+33 123 456 789","birthDate":"1990-01-01","nationality":"FRA","countryOfBirth":"FRA","residentialAddress":{"streetLine1":"33 Rue La Fayette","city":"Paris","postalCode":"75009","country":"FRA","streetLine2":"WeWork","state":"IDF"},"socialSecurityNumber":"123-45-6789","profilePictureUrl":"\u003cstring>"},"beneficiaryDetails":{"beneficiaryType":["ubo"],"title":"CEO","ownershipPercentage":32.5},"verificationDocuments":[{"documentType":"passport","issuingCountry":"FRA","documentId":"830c219c-d197-451d-b879-77936a80c452","documentNumber":"FR1234567890","description":"Additional supporting document","warnings":["\u003cstring>"],"errors":["\u003cstring>"]}],"missingDocuments":["\u003cstring>"]}],"missingCompanyData":["\u003cstring>"],"missingDocuments":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"c5dfec5d-57d2-48de-ab94-fbbbc2ab2a65":{"description":"Invalid request payload","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"bc2b675d-9442-403d-a45b-81dddd7a2e8c":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"6776578a-5ddb-4e15-865b-2e26cf6b98bc":{"integrator_auth":{"type":"apiKey","in":"header","name":"X-Pubkey, X-Timestamp, X-Signature","scopes":[],"schemeName":"integrator_auth"}}},"servers":{"24c7134c-2fdd-4d9f-babd-7f420d10d26f":{"url":"https://api.byzantine.fi","description":"Prod deployment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Pubkey, X-Timestamp, X-Signature","scopes":[],"schemeName":"integrator_auth"},"schema":{"title":"X-Pubkey, X-Timestamp, X-Signature","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"integrator_auth","name":"X-Pubkey, X-Timestamp, X-Signature"}],"title":"integrator_auth"}]},"originalFileLocation":"api-reference/openapi-integrator.json"},"subdomain":"byzantinefinance","siteName":"Byzantine Finance","title":"Create entity - Byzantine Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/customer-management/create-entity","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-10-21T16:45:13.035Z","originalFileLocation":"api-reference/customer-management/create-entity.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"email and associatedPersons.email must be unique at each call of the endpoint. For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Byzantine Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_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/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create entity - Byzantine Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"email and associatedPersons.email must be unique at each call of the endpoint. For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Byzantine Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzantine.fi/api-reference/customer-management/create-entity\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://byzantinefinance.mintlify.site/_mintlify/api/og/v2?division=Customer+creation\u0026amp;title=Create+entity\u0026amp;description=%60email%60+and+%60associatedPersons.email%60+must+be+unique+at+each+call+of+the+endpoint.%0AFor+emails%2C+you+can+use+the+%60%2B%60+sign+to+make+them+unique%2C+e.g.+byzcorp%2B1%40exam\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=215fdb42a9062664114c09e1b03bd725a224a357ff74aabc5a98b80e5c975b10\">\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=\"Create entity - Byzantine Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"email and associatedPersons.email must be unique at each call of the endpoint. For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://byzantinefinance.mintlify.site/_mintlify/api/og/v2?division=Customer+creation\u0026amp;title=Create+entity\u0026amp;description=%60email%60+and+%60associatedPersons.email%60+must+be+unique+at+each+call+of+the+endpoint.%0AFor+emails%2C+you+can+use+the+%60%2B%60+sign+to+make+them+unique%2C+e.g.+byzcorp%2B1%40exam\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=215fdb42a9062664114c09e1b03bd725a224a357ff74aabc5a98b80e5c975b10\">\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/byzantinefinance/7mu313ao3NfCm_vj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Byzantine Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#702963\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzantine.fi/api-reference/customer-management/create-entity\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer-management/create-entity.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzantine.fi/#organization\",\"name\":\"Byzantine Finance\",\"url\":\"https://docs.byzantine.fi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/byzantinefinance/fFIrlJyu_2rx0s2h/logo/dark_logo.png?fit=max\u0026auto=format\u0026n=fFIrlJyu_2rx0s2h\u0026q=85\u0026s=c43aec517b1eeb07c5d662c510c348d5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzantine.fi#website\",\"name\":\"Byzantine Finance\",\"url\":\"https://docs.byzantine.fi\",\"publisher\":{\"@id\":\"https://docs.byzantine.fi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity#webpage\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity\",\"name\":\"Create entity\",\"description\":\"email and associatedPersons.email must be unique at each call of the endpoint. For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.\",\"dateModified\":\"2026-10-21T16:45:13.035Z\",\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API endpoints\",\"item\":\"https://docs.byzantine.fi/api-reference/endpoints-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer management\",\"item\":\"https://docs.byzantine.fi/api-reference/customer-management/list-all-customers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Customer creation\",\"item\":\"https://docs.byzantine.fi/api-reference/customer-management/create-individual-account\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create entity\",\"item\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity#apireference\",\"headline\":\"Create entity\",\"name\":\"Create entity\",\"description\":\"email and associatedPersons.email must be unique at each call of the endpoint. For emails, you can use the + sign to make them unique, e.g. byzcorp+1@example.com.\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/create-entity#webpage\"},\"dateModified\":\"2026-10-21T16:45:13.035Z\",\"publisher\":{\"@id\":\"https://docs.byzantine.fi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Byzantine Finance\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Byzantine Finance","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Welcome!","icon":"book","pages":[{"title":"Welcome!","href":""}]},{"tab":"Academy","icon":"graduation-cap","pages":[{"title":"Academy","href":"/documentation/about-byzantine/what-is-byzantine"}]},{"tab":"API reference","icon":"code","groups":[{"group":"Integrator API","pages":[{"group":"Getting started","pages":[{"title":"Getting started","icon":"play","href":"/api-reference/getting-started"},{"title":"Byzantine SDK","icon":"code","href":"/api-reference/byzantine-sdk"},{"title":"API authentication","href":"/api-reference/api-authentication"},{"title":"Sandbox","href":"/api-reference/sandbox"},{"title":"Concepts","href":"/api-reference/concepts"},{"title":"Integration guide","href":"/api-reference/integration-guide"},{"title":"Build with AI","icon":"sparkles","href":"/api-reference/build-with-ai"}]},{"title":"Authentication methods","href":"/api-reference/authentication-methods"},{"group":"Account creation","pages":[{"title":"High level overview","href":"/api-reference/kyc-kyb-overview"},{"title":"Terms and Conditions","href":"/api-reference/terms-and-conditions"},{"title":"Multi-accounts","href":"/api-reference/multi-accounts"},{"title":"Individuals - KYC","href":"/api-reference/kyc"},{"title":"Legal entities - KYB","href":"/api-reference/kyb"},{"title":"Required documents","href":"/api-reference/accepted-documents"},{"title":"Verification statuses","href":"/api-reference/verification-statuses"},{"group":"Lists","pages":[{"title":"Countries","href":"/api-reference/lists/countries"},{"title":"Occupation codes","href":"/api-reference/lists/occupation-codes"},{"title":"Company industry codes","href":"/api-reference/lists/industry-codes"},{"title":"Entity number types by country","href":"/api-reference/lists/company-number-types"}]}]},{"title":"Account activation","href":"/api-reference/account-activation"},{"group":"Account management","pages":[{"title":"Overview","href":"/api-reference/management-overview"},{"title":"Multi-users account","href":"/api-reference/multi-users-account"},{"title":"Bank account","href":"/api-reference/bank-account"}]},{"group":"Transactions","pages":[{"title":"Overview","href":"/api-reference/transactions-overview"},{"group":"Deposit","pages":[{"title":"High level overview","href":"/api-reference/deposit-overview"},{"title":"Technical implementation","href":"/api-reference/deposit-technical"}]},{"group":"Withdrawal","pages":[{"title":"High level overview","href":"/api-reference/withdrawal-overview"},{"title":"Technical implementation","href":"/api-reference/withdrawal-technical"}]},{"title":"Stablecoin transfer","href":"/api-reference/transfer"},{"title":"Tracking transactions","href":"/api-reference/tracking-transactions"},{"title":"Idle balance","href":"/api-reference/account-balances-idle"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Customer webhooks","href":"/api-reference/webhooks/customers"},{"title":"Transaction webhooks","href":"/api-reference/webhooks/transactions"}]}]},{"group":"API endpoints","pages":[{"title":"Overview","href":"/api-reference/endpoints-overview"},{"title":"Sandbox authentication","href":"/api-reference/sandbox-auth"},{"title":"Changelog","href":"/api-reference/changelog"},{"group":"API health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/health","href":"/api-reference/api-health/health-check"}]},{"group":"Customer management","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-customers","href":"/api-reference/customer-management/list-all-customers"},{"title":"Get details of a single user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-user-details","href":"/api-reference/customer-management/get-details-of-a-single-user"},{"title":"Get details of a single entity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-entity-details","href":"/api-reference/customer-management/get-details-of-a-single-entity"},{"title":"Get details of a single associated person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-associated-person-details","href":"/api-reference/customer-management/get-details-of-a-single-associated-person"},{"group":"Customer creation","pages":[{"title":"Create individual account","description":"The account beneficiary is the person described in `user_info` (the KYC subject).\n`root_users` are the signers: the owner themselves (same email), or a\nwealth manager / CGP operating on the owner's behalf.\n\n`email` must be unique at each call of the endpoint.\nYou can use the `+` sign to make them unique, e.g. alice+1@example.com.\nIt is possible to create an individual account with only the following details and then call the `update-individual-account` to complete the application:\n- `firstName`\n- `lastName`\n- `email`\n- `byzantineTermsSignedAt`","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-individual-account","href":"/api-reference/customer-management/create-individual-account"},{"title":"Create entity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-entity-account","href":"/api-reference/customer-management/create-entity"},{"title":"Update an individual account's user details","description":"It is possible to call this endpoint as many times as necessary to submit additional information/documents to complete the account.\nOnly the `accountId` is required.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-individual-account","href":"/api-reference/customer-management/update-an-individual-accounts-user-details"},{"title":"Update an entity account's company details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-entity-account","href":"/api-reference/customer-management/update-an-entity-accounts-company-details"},{"title":"Add an associated person to an entity account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/add-associated-person","href":"/api-reference/customer-management/add-an-associated-person-to-an-entity-account"},{"title":"Update an associated person's details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/submit/update-associated-person","href":"/api-reference/customer-management/update-an-associated-persons-details"}]}]},{"group":"Account management","pages":[{"title":"Get single account balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-account-balances","href":"/api-reference/account-management/get-single-account-balances"},{"title":"Get details of a single account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-account-details","href":"/api-reference/account-management/get-details-of-a-single-account"},{"group":"Bank accounts","pages":[{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-bank-accounts","href":"/api-reference/account-management/list-bank-accounts"},{"title":"Add bank account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/add-bank-account","href":"/api-reference/account-management/add-bank-account"}]},{"group":"Multi-users account","pages":[{"title":"List invitations by account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-invitations-by-account-id","href":"/api-reference/account-management/list-invitations-by-account"},{"title":"List invitations by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-invitations-by-email","href":"/api-reference/account-management/list-invitations-by-email"},{"title":"List all invitations across every account of the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-all-invitations","href":"/api-reference/account-management/list-all-invitations-across-every-account-of-the-authenticated-integrator"},{"group":"Add team member","pages":[{"title":"Step 1 Get invite users payload (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-invite-users-payload-passkey","href":"/api-reference/account-management/step-1-get-invite-users-payload-passkey"},{"title":"Step 2 Send invitations (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/invite-users","href":"/api-reference/account-management/step-2-send-invitations-passkey"}]},{"group":"User roles","pages":[{"title":"Step 1 Get update role payload (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-update-users-role-payload-passkey","href":"/api-reference/account-management/step-1-get-update-role-payload-passkey"},{"title":"Step 2 Update users role (passkey)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/update-users-role","href":"/api-reference/account-management/step-2-update-users-role-passkey"}]}]}]},{"group":"Products","pages":[{"title":"Vault APY and history","href":"/api-reference/vault-performance"},{"title":"List all products","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/top-vaults","href":"/api-reference/products/list-all-products"},{"title":"Get single product APY","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/apy","href":"/api-reference/products/get-single-product-apy"},{"title":"Get single product APY history","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/apy-history","href":"/api-reference/products/get-single-product-apy-history"},{"title":"Get all assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/assets","href":"/api-reference/products/get-all-assets"}]},{"group":"Transactions","pages":[{"title":"List all transactions across every account of the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-all-transactions","href":"/api-reference/transactions/list-all-transactions-across-every-account-of-the-authenticated-integrator"},{"title":"List all transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-transactions","href":"/api-reference/transactions/list-all-transactions"},{"title":"Get single transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/get-transaction","href":"/api-reference/transactions/get-single-transaction"},{"group":"Passkey flow","pages":[{"title":"Get activate account payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-activate-account-payload-passkey","href":"/api-reference/transactions/get-activate-account-payload"},{"title":"Get deposit payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-deposit-payload-passkey","href":"/api-reference/transactions/get-deposit-payload"},{"title":"Get withdraw payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-withdraw-payload-passkey","href":"/api-reference/transactions/get-withdraw-payload"},{"title":"Get vault upgrade payload (Base -> Ethereum)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-vault-upgrade-payload-passkey","href":"/api-reference/transactions/get-vault-upgrade-payload-base->-ethereum"},{"title":"Get transfer payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-transfer-payload-passkey","href":"/api-reference/transactions/get-transfer-payload"},{"title":"Get cancellation payload for a withdrawal request","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/query/get-cancel-withdrawal-payload-passkey","href":"/api-reference/transactions/get-cancellation-payload-for-a-withdrawal-request"},{"title":"Sign payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/sign-payload-passkey","href":"/api-reference/transactions/sign-payload"}]}]},{"group":"Webhooks","pages":[{"title":"Create a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/subscriptions","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"List webhook subscriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/webhooks/subscriptions","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Update a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Delete a webhook subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json delete /v1/webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"Send a signed test webhook.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/subscriptions/{subscription_id}/test","href":"/api-reference/webhooks/send-a-signed-test-webhook"},{"title":"List webhook delivery history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/webhooks/deliveries","href":"/api-reference/webhooks/list-webhook-delivery-history"},{"title":"Retry a webhook delivery.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/webhooks/deliveries/{delivery_id}/retry","href":"/api-reference/webhooks/retry-a-webhook-delivery"}]},{"group":"Events","pages":[{"title":"Lists persisted lifecycle events owned by the authenticated integrator, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/query/events","href":"/api-reference/events/lists-persisted-lifecycle-events-owned-by-the-authenticated-integrator-newest-first"}]},{"group":"OTP authentication","pages":[{"title":"Step 1 Initialize OTP (send email)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/init-otp","href":"/api-reference/otp-authentication/step-1-initialize-otp-send-email"},{"title":"Step 2 Authenticate with OTP code","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/otp-auth","href":"/api-reference/otp-authentication/step-2-authenticate-with-otp-code"},{"title":"Step 3 Create passkeys (OTP auth)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/submit/create-authenticators-otp","href":"/api-reference/otp-authentication/step-3-create-passkeys-otp-auth"}]},{"group":"Integrator key management","pages":[{"title":"Get current integrator credential capabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/integrator/whoami","href":"/api-reference/integrator-key-management/get-current-integrator-credential-capabilities"},{"title":"List integrator credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json get /v1/integrator/credentials","href":"/api-reference/integrator-key-management/list-integrator-credentials"},{"title":"Issue a credential for the authenticated integrator","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json post /v1/integrator/credentials","href":"/api-reference/integrator-key-management/issue-a-credential-for-the-authenticated-integrator"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json patch /v1/integrator/credentials/{pubkey}","href":"/api-reference/integrator-key-management/update-a-credential"},{"title":"Delete an integrator credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi-integrator.json delete /v1/integrator/credentials/{pubkey}","href":"/api-reference/integrator-key-management/delete-an-integrator-credential"}]}]}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]}]},"basePath":"","title":"Create entity - Byzantine Finance","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}