List of missing required verification documents. Present only if not all required documents have been submitted.
{"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"}},"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":"6ae9ca7b156f2fde8c4bdf08","collectionId":"bb9de0e8-91ee-4664-a8e2-83972801e1c3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9ca7b156f2fde8c4bdf08"},"entitlements":{},"buildId":"6ae9ca7b156f2fde8c4bdf08","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"API reference","count":88},{"language":"en","tag":"API endpoints","count":56},{"language":"en","tag":"Integrator API","count":32},{"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":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customer-management/add-an-associated-person-to-an-entity-account","slug":"/api-reference/customer-management/add-an-associated-person-to-an-entity-account","pageMetadata":{"title":"Add an associated person to an entity account","description":null,"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","autogeneratedByOpenApi":true},"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":"Add an associated person to an entity account","description":null,"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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/byzantinefinance/8361d7bc2f630c6c/integrator-auth.js"],"openApiReferenceData":{"operation":{"tags":["Customer management"],"summary":"Add an associated person to an entity account","operationId":"add_associated_person","parameters":["98e09919-d860-431a-ae14-32594cf054f2","c31eff26-1a1a-4282-9432-281bafcc950b","23cb06fa-8e43-4e64-913b-acedd9f3d684"],"requestBody":"6b301305-286b-483d-9a02-fc610d0317bc","responses":{"201":"8472f9f9-255f-47c2-ae91-9b4a335ee698","400":"ab92a77a-167e-4f41-9be5-18b22ad439f3","404":"97950584-f40d-4fca-bba2-6c73c235f289","500":"d5ee6d74-7f01-45d4-8681-fb37ec9c6bda"},"security":["020f1d6d-fc59-4c4a-afab-686c463db83b"],"method":"post","type":"path","servers":["24c7134c-2fdd-4d9f-babd-7f420d10d26f"],"path":"/v1/submit/add-associated-person","baseUrlOptions":["https://api.byzantine.fi"],"title":"Add an associated person to an entity account","description":"","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.accountId":"550e8400-e29b-41d4-a716-446655440000","body.associatedPerson.userInfo.firstName":"John","body.associatedPerson.userInfo.lastName":"Smith","body.associatedPerson.userInfo.email":"john.smith@example.com","body.associatedPerson.userInfo.middleName.oneOf.0":"William","body.associatedPerson.userInfo.phone.oneOf.0":"+33 123 456 789","body.associatedPerson.userInfo.birthDate.oneOf.0":"1990-01-01","body.associatedPerson.userInfo.nationality.oneOf.0":"FRA","body.associatedPerson.userInfo.countryOfBirth.oneOf.0":"FRA","body.associatedPerson.userInfo.residentialAddress.oneOf.0.streetLine1":"33 Rue La Fayette","body.associatedPerson.userInfo.residentialAddress.oneOf.0.city":"Paris","body.associatedPerson.userInfo.residentialAddress.oneOf.0.postalCode":"75009","body.associatedPerson.userInfo.residentialAddress.oneOf.0.country":"FRA","body.associatedPerson.userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0":"WeWork","body.associatedPerson.userInfo.residentialAddress.oneOf.0.state.oneOf.0":"IDF","body.associatedPerson.userInfo.socialSecurityNumber.oneOf.0":"123-45-6789","body.associatedPerson.userInfo.profilePictureUrl.oneOf.0":"\u003cstring>","body.associatedPerson.beneficiaryDetails.beneficiaryType.items.0":"ubo","body.associatedPerson.beneficiaryDetails.title.oneOf.0":"CEO","body.associatedPerson.beneficiaryDetails.ownershipPercentage.oneOf.0":32.5,"body.associatedPerson.verificationDocuments.oneOf.0.items.0.issuingCountry":"FRA","body.associatedPerson.verificationDocuments.oneOf.0.items.0.document":"data:image/png;base64,iVBORw0lFTkSuQmCC...","body.associatedPerson.verificationDocuments.oneOf.0.items.0.documentNumber.oneOf.0":"FR1234567890","body.associatedPerson.verificationDocuments.oneOf.0.items.0.description.oneOf.0":"Additional supporting document"}]},"dependencies":{"parameters":{"98e09919-d860-431a-ae14-32594cf054f2":{"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"}},"c31eff26-1a1a-4282-9432-281bafcc950b":{"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"}},"23cb06fa-8e43-4e64-913b-acedd9f3d684":{"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":"Add an associated person to an entity account","content":{"application/json":{"schema":{"type":"object","description":"Request body for adding an associated person to an entity account.","required":["accountId","associatedPerson"],"properties":{"accountId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"accountId","typeLabel":"string\u003cuuid>"},"associatedPerson":{"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":"associatedPerson.userInfo.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith","isRequired":true,"uniqueKey":"associatedPerson.userInfo.lastName","typeLabel":"string"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com","isRequired":true,"uniqueKey":"associatedPerson.userInfo.email","typeLabel":"string"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPerson.userInfo.middleName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Middle name of the user.","example":"William","uniqueKey":"associatedPerson.userInfo.middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.userInfo.middleName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPerson.userInfo.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"associatedPerson.userInfo.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.userInfo.phone","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPerson.userInfo.birthDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"associatedPerson.userInfo.birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.userInfo.nationality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPerson.userInfo.nationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.userInfo.countryOfBirth.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"associatedPerson.userInfo.countryOfBirth.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.userInfo.residentialAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"associatedPerson.userInfo.residentialAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"associatedPerson.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":"associatedPerson.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":"associatedPerson.userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"associatedPerson.userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.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":"associatedPerson.userInfo.residentialAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.userInfo.residentialAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"associatedPerson.userInfo.residentialAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"associatedPerson.userInfo.residentialAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.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":"associatedPerson.userInfo.socialSecurityNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.userInfo.socialSecurityNumber","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPerson.userInfo.profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"associatedPerson.userInfo.profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.userInfo.profilePictureUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"associatedPerson.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":"associatedPerson.beneficiaryDetails.beneficiaryType.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"associatedPerson.beneficiaryDetails.beneficiaryType","typeLabel":"enum\u003cstring>[]"},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPerson.beneficiaryDetails.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"associatedPerson.beneficiaryDetails.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.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":"associatedPerson.beneficiaryDetails.ownershipPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.beneficiaryDetails.ownershipPercentage","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"associatedPerson.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":"associatedPerson.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":"associatedPerson.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":"associatedPerson.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":"associatedPerson.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":"associatedPerson.verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.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":"associatedPerson.verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required if document type is 'other'.","example":"Additional supporting document","uniqueKey":"associatedPerson.verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.verificationDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"uniqueKey":"associatedPerson.verificationDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"associatedPerson.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":"associatedPerson.verificationDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPerson.verificationDocuments","typeLabel":"object[] | null"}},"isRequired":true,"uniqueKey":"associatedPerson","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accountId":"550e8400-e29b-41d4-a716-446655440000","associatedPerson":{"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"}]}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8472f9f9-255f-47c2-ae91-9b4a335ee698":{"description":"Associated person added successfully","content":{"application/json":{"schema":{"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":"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":"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":"userInfo.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user.","example":"Smith","isRequired":true,"uniqueKey":"userInfo.lastName","typeLabel":"string"},"email":{"type":"string","description":"Contact email of the user.","example":"john.smith@example.com","isRequired":true,"uniqueKey":"userInfo.email","typeLabel":"string"},"middleName":{"oneOf":[{"type":"string","description":"Middle name of the user.","example":"William","uniqueKey":"userInfo.middleName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Middle name of the user.","example":"William","uniqueKey":"userInfo.middleName.oneOf.1","typeLabel":"null"}],"uniqueKey":"userInfo.middleName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"userInfo.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the user.","example":"+33 123 456 789","uniqueKey":"userInfo.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"userInfo.phone","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"userInfo.birthDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"User's date of birth.","example":"1990-01-01","uniqueKey":"userInfo.birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"userInfo.nationality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"userInfo.nationality.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"userInfo.countryOfBirth.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"userInfo.countryOfBirth.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"userInfo.residentialAddress.oneOf.0.streetLine1","typeLabel":"string"},"city":{"type":"string","example":"Paris","isRequired":true,"uniqueKey":"userInfo.residentialAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code.","example":"75009","isRequired":true,"uniqueKey":"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":"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":"userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional additional details to the street name and number.","example":"WeWork","uniqueKey":"userInfo.residentialAddress.oneOf.0.streetLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"userInfo.residentialAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"userInfo.residentialAddress.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"userInfo.residentialAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"userInfo.residentialAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"userInfo.socialSecurityNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"userInfo.socialSecurityNumber","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"userInfo.profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's profile picture (can be an avatar)","uniqueKey":"userInfo.profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"userInfo.profilePictureUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"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":"beneficiaryDetails.beneficiaryType.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"beneficiaryDetails.beneficiaryType","typeLabel":"enum\u003cstring>[]"},"title":{"oneOf":[{"type":"string","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"beneficiaryDetails.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for representatives. The title held at the business.","example":"CEO","uniqueKey":"beneficiaryDetails.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"beneficiaryDetails.ownershipPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"beneficiaryDetails.ownershipPercentage","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"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":"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":"verificationDocuments.oneOf.0.items.[INDEX].documentType.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"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":"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":"verificationDocuments.oneOf.0.items.[INDEX].documentId","typeLabel":"string"},"documentNumber":{"oneOf":[{"type":"string","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full document number sent with the document.","example":"FR1234567890","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].documentNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].documentNumber","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Additional supporting document","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Additional supporting document","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"warnings":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].warnings.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].warnings","typeLabel":"string[] | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX].errors","typeLabel":"string[] | null"}},"uniqueKey":"verificationDocuments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"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":"verificationDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"verificationDocuments","typeLabel":"object[] | null"},"missingDocuments":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"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":"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":"missingDocuments.oneOf.1","typeLabel":"null"}],"uniqueKey":"missingDocuments","typeLabel":"string[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"ab92a77a-167e-4f41-9be5-18b22ad439f3":{"description":"Invalid request payload","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"97950584-f40d-4fca-bba2-6c73c235f289":{"description":"Account not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d5ee6d74-7f01-45d4-8681-fb37ec9c6bda":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"020f1d6d-fc59-4c4a-afab-686c463db83b":{"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":"Add an associated person to an entity account - Byzantine Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/customer-management/add-an-associated-person-to-an-entity-account","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-11-03T11:50:26.256Z","originalFileLocation":"api-reference/customer-management/add-an-associated-person-to-an-entity-account.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=\"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=\"Add an associated person to an entity account - Byzantine Finance\">\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/add-an-associated-person-to-an-entity-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://byzantinefinance.mintlify.app/_mintlify/api/og/v2?division=Customer+creation\u0026amp;title=Add+an+associated+person+to+an+entity+account\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=787f1e182fd060bfdfd398a638df5791c8176d8dae9ec1325d41432328ef2bb4\">\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=\"Add an associated person to an entity account - Byzantine Finance\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://byzantinefinance.mintlify.app/_mintlify/api/og/v2?division=Customer+creation\u0026amp;title=Add+an+associated+person+to+an+entity+account\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=787f1e182fd060bfdfd398a638df5791c8176d8dae9ec1325d41432328ef2bb4\">\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/add-an-associated-person-to-an-entity-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer-management/add-an-associated-person-to-an-entity-account.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/add-an-associated-person-to-an-entity-account#webpage\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account\",\"name\":\"Add an associated person to an entity account\",\"dateModified\":\"2026-11-03T11:50:26.256Z\",\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account#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\":\"Add an associated person to an entity account\",\"item\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account#apireference\",\"headline\":\"Add an associated person to an entity account\",\"name\":\"Add an associated person to an entity account\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/add-an-associated-person-to-an-entity-account#webpage\"},\"dateModified\":\"2026-11-03T11:50:26.256Z\",\"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":"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","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","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","description":null,"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","description":null,"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":"Add an associated person to an entity account - Byzantine Finance","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}