{"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":[{"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customer-management/get-details-of-a-single-entity","slug":"/api-reference/customer-management/get-details-of-a-single-entity","pageMetadata":{"title":"Get details of a single entity","description":"This endpoint returns comprehensive information about a business entity including:\n- Basic business information (name, email, addresses)\n- Associated account details\n- Team members (users who are part of the team)\n- Associated persons (beneficiaries and representatives)\n- Pending invitations (invitations that are pending acceptance)","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This endpoint returns comprehensive information about a business entity including:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Basic business information (name, email, addresses)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Associated account details\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Team members (users who are part of the team)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Associated persons (beneficiaries and representatives)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Pending invitations (invitations that are pending acceptance)\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get details of a single entity","description":"This endpoint returns comprehensive information about a business entity including:\n- Basic business information (name, email, addresses)\n- Associated account details\n- Team members (users who are part of the team)\n- Associated persons (beneficiaries and representatives)\n- Pending invitations (invitations that are pending acceptance)","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/byzantinefinance/8361d7bc2f630c6c/integrator-auth.js"],"openApiReferenceData":{"operation":{"tags":["Customer management"],"summary":"Get details of a single entity","description":"This endpoint returns comprehensive information about a business entity including:\n- Basic business information (name, email, addresses)\n- Associated account details\n- Team members (users who are part of the team)\n- Associated persons (beneficiaries and representatives)\n- Pending invitations (invitations that are pending acceptance)","operationId":"get_entity_details","parameters":["1a6edf95-0a5f-44b7-8087-b84ec665c441","225ed735-21c8-4465-91bf-90a59c7d9998","1eee4b84-a5e9-49d4-85fb-adc117606e7b","4a489a9c-773a-4fa7-b9dc-2d4729d70949"],"responses":{"200":"05760502-174b-4f27-b00e-50e17ee3e673","400":"b73546db-b93b-4006-bdf8-203de412ff34","404":"34956807-768e-4652-938d-e8d10a00d70c","500":"639062cd-484b-4dac-81fa-02fe06a7b54f"},"security":["9855ce6d-0362-47f7-8e3c-e54880c4b2fc"],"method":"get","type":"path","servers":["24c7134c-2fdd-4d9f-babd-7f420d10d26f"],"path":"/v1/query/get-entity-details","baseUrlOptions":["https://api.byzantine.fi"],"title":"Get details of a single entity","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"1a6edf95-0a5f-44b7-8087-b84ec665c441":{"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"}},"225ed735-21c8-4465-91bf-90a59c7d9998":{"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"}},"1eee4b84-a5e9-49d4-85fb-adc117606e7b":{"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"}},"4a489a9c-773a-4fa7-b9dc-2d4729d70949":{"name":"entityId","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"05760502-174b-4f27-b00e-50e17ee3e673":{"description":"Entity details retrieved successfully","content":{"application/json":{"schema":{"type":"object","description":"Response body for entity details","required":["entityId","verificationStatus","entityInfo","account","teamMembers","associatedPersons","createdAt"],"properties":{"entityId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"entityId","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":"Response body for entity information","required":["companyName"],"properties":{"companyName":{"type":"string","isRequired":true,"uniqueKey":"entityInfo.companyName","typeLabel":"string"},"email":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.email","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.website.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.website","typeLabel":"string | null"},"companyNumber":{"oneOf":[{"type":"string","uniqueKey":"entityInfo.companyNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityInfo.companyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInfo.companyNumber","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"}},"isRequired":true,"uniqueKey":"entityInfo","typeLabel":"object"},"account":{"type":"object","description":"Response body for entity account information","required":["accountId","accountName","accountType","walletAddress","isSelfCustodial","createdAt"],"properties":{"accountId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"account.accountId","typeLabel":"string\u003cuuid>"},"accountName":{"type":"string","isRequired":true,"uniqueKey":"account.accountName","typeLabel":"string"},"accountType":{"type":"string","description":"Type of applicant for Sumsub verification","enum":["individual","company"],"isRequired":true,"uniqueKey":"account.accountType","typeLabel":"enum\u003cstring>"},"walletAddress":{"type":"string","isRequired":true,"uniqueKey":"account.walletAddress","typeLabel":"string"},"isSelfCustodial":{"type":"boolean","isRequired":true,"uniqueKey":"account.isSelfCustodial","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"account.createdAt","typeLabel":"string\u003cdate-time>"},"bridgeAccountId":{"oneOf":[{"type":"string","uniqueKey":"account.bridgeAccountId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"account.bridgeAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.bridgeAccountId","typeLabel":"string | null"},"logoUrl":{"oneOf":[{"type":"string","uniqueKey":"account.logoUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"account.logoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.logoUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"account","typeLabel":"object"},"teamMembers":{"type":"array","items":{"type":"object","description":"Response body for a team member","required":["userId","firstName","lastName","userEmail","role","joinedAt"],"properties":{"userId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].lastName","typeLabel":"string"},"userEmail":{"type":"string","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].userEmail","typeLabel":"string"},"role":{"type":"string","description":"Role of a user in an account.","enum":["root","admin","view","self_custodial","beneficiary"],"example":"root","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"joinedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"teamMembers.items.[INDEX].joinedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"teamMembers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"teamMembers","typeLabel":"object[]"},"associatedPersons":{"type":"array","items":{"type":"object","description":"Response body for an associated person","required":["firstName","lastName","email","beneficiaryType"],"properties":{"firstName":{"type":"string","isRequired":true,"uniqueKey":"associatedPersons.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","isRequired":true,"uniqueKey":"associatedPersons.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"associatedPersons.items.[INDEX].email","typeLabel":"string"},"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.items.[INDEX].beneficiaryType.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"associatedPersons.items.[INDEX].beneficiaryType","typeLabel":"enum\u003cstring>[]"},"beneficiaryId":{"oneOf":[{"type":"string","description":"A UUID string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"associatedPersons.items.[INDEX].beneficiaryId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"associatedPersons.items.[INDEX].beneficiaryId.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.items.[INDEX].beneficiaryId","typeLabel":"string\u003cuuid> | null"},"userId":{"oneOf":[{"type":"string","description":"A UUID string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"associatedPersons.items.[INDEX].userId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"associatedPersons.items.[INDEX].userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.items.[INDEX].userId","typeLabel":"string\u003cuuid> | null"},"shareSize":{"oneOf":[{"type":"number","format":"double","uniqueKey":"associatedPersons.items.[INDEX].shareSize.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","uniqueKey":"associatedPersons.items.[INDEX].shareSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"associatedPersons.items.[INDEX].shareSize","typeLabel":"number\u003cdouble> | null"}},"uniqueKey":"associatedPersons.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"associatedPersons","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"pendingInvitations":{"oneOf":[{"type":"array","items":{"type":"object","description":"Response body for a pending invitation","required":["invitationId","userId","role","firstName","lastName","userEmail","invitedBy"],"properties":{"invitationId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].invitationId","typeLabel":"string\u003cuuid>"},"userId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"role":{"type":"string","description":"Role of a user in an account.","enum":["root","admin","view","self_custodial","beneficiary"],"example":"root","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"firstName":{"type":"string","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].lastName","typeLabel":"string"},"userEmail":{"type":"string","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].userEmail","typeLabel":"string"},"invitedBy":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX].invitedBy","typeLabel":"string\u003cuuid>"}},"uniqueKey":"pendingInvitations.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pendingInvitations.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Response body for a pending invitation","required":["invitationId","userId","role","firstName","lastName","userEmail","invitedBy"],"properties":{"invitationId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000"},"userId":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000"},"role":{"type":"string","description":"Role of a user in an account.","enum":["root","admin","view","self_custodial","beneficiary"],"example":"root"},"firstName":{"type":"string"},"lastName":{"type":"string"},"userEmail":{"type":"string"},"invitedBy":{"type":"string","format":"uuid","description":"A UUID string","example":"550e8400-e29b-41d4-a716-446655440000"}}},"uniqueKey":"pendingInvitations.oneOf.1","typeLabel":"null"}],"uniqueKey":"pendingInvitations","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityId":"550e8400-e29b-41d4-a716-446655440000","verificationStatus":"active","entityInfo":{"companyName":"\u003cstring>","email":"\u003cstring>","website":"\u003cstring>","companyNumber":"\u003cstring>","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"}},"account":{"accountId":"550e8400-e29b-41d4-a716-446655440000","accountName":"\u003cstring>","accountType":"individual","walletAddress":"\u003cstring>","isSelfCustodial":true,"createdAt":"2023-11-07T05:31:56Z","bridgeAccountId":"\u003cstring>","logoUrl":"\u003cstring>"},"teamMembers":[{"userId":"550e8400-e29b-41d4-a716-446655440000","firstName":"\u003cstring>","lastName":"\u003cstring>","userEmail":"\u003cstring>","role":"root","joinedAt":"2023-11-07T05:31:56Z"}],"associatedPersons":[{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","beneficiaryType":["ubo"],"beneficiaryId":"550e8400-e29b-41d4-a716-446655440000","userId":"550e8400-e29b-41d4-a716-446655440000","shareSize":123}],"createdAt":"2023-11-07T05:31:56Z","pendingInvitations":[{"invitationId":"550e8400-e29b-41d4-a716-446655440000","userId":"550e8400-e29b-41d4-a716-446655440000","role":"root","firstName":"\u003cstring>","lastName":"\u003cstring>","userEmail":"\u003cstring>","invitedBy":"550e8400-e29b-41d4-a716-446655440000"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"b73546db-b93b-4006-bdf8-203de412ff34":{"description":"Bad request - Invalid entity_id","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"34956807-768e-4652-938d-e8d10a00d70c":{"description":"Entity not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"639062cd-484b-4dac-81fa-02fe06a7b54f":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9855ce6d-0362-47f7-8e3c-e54880c4b2fc":{"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":"Get details of a single entity - Byzantine Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/customer-management/get-details-of-a-single-entity","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-10-21T16:45:13.008Z","originalFileLocation":"api-reference/customer-management/get-details-of-a-single-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=\"This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invitations that are pending acceptance)\">\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=\"Get details of a single entity - Byzantine Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invitations that are pending acceptance)\">\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/get-details-of-a-single-entity\">\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+management\u0026amp;title=Get+details+of+a+single+entity\u0026amp;description=This+endpoint+returns+comprehensive+information+about+a+business+entity+including%3A%0A-+Basic+business+information+%28name%2C+email%2C+addresses%29%0A-+Associated+account+de\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=fee79cd04ac12122c9f5065005f80443b1af11a8a7c710188baec55196a2f6c3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get details of a single entity - Byzantine Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invitations that are pending acceptance)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://byzantinefinance.mintlify.app/_mintlify/api/og/v2?division=Customer+management\u0026amp;title=Get+details+of+a+single+entity\u0026amp;description=This+endpoint+returns+comprehensive+information+about+a+business+entity+including%3A%0A-+Basic+business+information+%28name%2C+email%2C+addresses%29%0A-+Associated+account+de\u0026amp;theme=c50bf0b8c85ed4c87dd675c4\u0026amp;signature=fee79cd04ac12122c9f5065005f80443b1af11a8a7c710188baec55196a2f6c3\">\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/get-details-of-a-single-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/get-details-of-a-single-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/get-details-of-a-single-entity#webpage\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity\",\"name\":\"Get details of a single entity\",\"description\":\"This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invitations that are pending acceptance)\",\"dateModified\":\"2026-10-21T16:45:13.008Z\",\"isPartOf\":{\"@id\":\"https://docs.byzantine.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-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\":\"Get details of a single entity\",\"item\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity#apireference\",\"headline\":\"Get details of a single entity\",\"name\":\"Get details of a single entity\",\"description\":\"This endpoint returns comprehensive information about a business entity including: - Basic business information (name, email, addresses) - Associated account details - Team members (users who are part of the team) - Associated persons (beneficiaries and representatives) - Pending invitations (invitations that are pending acceptance)\",\"url\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzantine.fi/api-reference/customer-management/get-details-of-a-single-entity#webpage\"},\"dateModified\":\"2026-10-21T16:45:13.008Z\",\"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","description":"This endpoint returns comprehensive information about a user including:\n- Basic user information (name, email, address)\n- Verification status\n- Associated accounts details","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","description":"This endpoint returns the full record of one beneficiary or representative of an entity:\n- Personal information (name, contact, birth details, residential address)\n- Beneficiary details (type, title held at the business, ownership share)\n- Verification status and the documents still missing\n\nThe `beneficiaryId` is returned by `get-entity-details` and by the associated person submit\nendpoints. A person belonging to another integrator returns the same 404 as one that does\nnot exist, so this endpoint never reveals the existence of a foreign record.","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","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":"Get details of a single entity - 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"]}