> ## Documentation Index > Fetch the complete documentation index at: https://docs.byzantine.fi/llms.txt > Use this file to discover all available pages before exploring further. # Get details of a single entity > 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) ## OpenAPI ````yaml /api-reference/openapi-integrator.json get /v1/query/get-entity-details openapi: 3.0.3 info: title: Byzantine Integrator API description: Byzantine REST API for integrators. license: name: '' version: 0.2.0 servers: - url: https://sandbox.api.byzantine.fi description: Sandbox security: [] tags: - name: API health description: Check API status. - name: Customer management description: Endpoints to create, update, and retrieve customer information. - name: Account management description: Endpoints to manage accounts, bank accounts, invitations, and user roles. - name: Products description: Endpoints to get data about products and vaults. - name: Transactions description: Endpoints to create and manage transactions. - name: OTP authentication description: Endpoints to initialize and manage user authentication with OTP. - name: Webhooks description: Integrator-managed outbound webhook subscriptions and delivery history. paths: /v1/query/get-entity-details: get: tags: - Customer management summary: 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) operationId: get_entity_details parameters: - name: X-Pubkey in: header description: >- Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd required: true schema: type: string - 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 - 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 - name: entityId in: query required: true schema: $ref: '#/components/schemas/Uuid' responses: '200': description: Entity details retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetEntityResponse' '400': description: Bad request - Invalid entity_id '404': description: Entity not found '500': description: Internal server error security: - integrator_auth: [] components: schemas: Uuid: type: string format: uuid description: A UUID string example: 550e8400-e29b-41d4-a716-446655440000 GetEntityResponse: type: object description: Response body for entity details required: - entityId - verificationStatus - entityInfo - account - teamMembers - associatedPersons - createdAt properties: entityId: $ref: '#/components/schemas/Uuid' verificationStatus: $ref: '#/components/schemas/VerificationStatus' entityInfo: $ref: '#/components/schemas/GetEntityInfo' account: $ref: '#/components/schemas/EntityAccountInfo' teamMembers: type: array items: $ref: '#/components/schemas/TeamMember' associatedPersons: type: array items: $ref: '#/components/schemas/GetAssociatedPersonResponse' pendingInvitations: type: array items: $ref: '#/components/schemas/PendingInvitation' nullable: true createdAt: type: string format: date-time 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 GetEntityInfo: type: object description: Response body for entity information required: - companyName properties: companyName: type: string email: type: string nullable: true website: type: string nullable: true companyNumber: type: string nullable: true registeredAddress: allOf: - $ref: '#/components/schemas/Address' nullable: true physicalAddress: allOf: - $ref: '#/components/schemas/Address' nullable: true EntityAccountInfo: type: object description: Response body for entity account information required: - accountId - accountName - accountType - walletAddress - isSelfCustodial - createdAt properties: accountId: $ref: '#/components/schemas/Uuid' accountName: type: string accountType: $ref: '#/components/schemas/ApplicantType' walletAddress: type: string isSelfCustodial: type: boolean bridgeAccountId: type: string nullable: true logoUrl: type: string nullable: true createdAt: type: string format: date-time TeamMember: type: object description: Response body for a team member required: - userId - firstName - lastName - userEmail - role - joinedAt properties: userId: $ref: '#/components/schemas/Uuid' firstName: type: string lastName: type: string userEmail: type: string role: $ref: '#/components/schemas/AccountUserRole' joinedAt: type: string format: date-time GetAssociatedPersonResponse: type: object description: Response body for an associated person required: - firstName - lastName - email - beneficiaryType properties: firstName: type: string lastName: type: string email: type: string beneficiaryType: type: array items: $ref: '#/components/schemas/BeneficiaryType' shareSize: type: number format: double nullable: true PendingInvitation: type: object description: Response body for a pending invitation required: - invitationId - userId - role - firstName - lastName - userEmail - invitedBy properties: invitationId: $ref: '#/components/schemas/Uuid' userId: $ref: '#/components/schemas/Uuid' role: $ref: '#/components/schemas/AccountUserRole' firstName: type: string lastName: type: string userEmail: type: string invitedBy: $ref: '#/components/schemas/Uuid' Address: type: object description: Address information. Must be a valid address in the relevant country. required: - streetLine1 - city - postalCode - country properties: streetLine1: type: string example: 33 Rue La Fayette streetLine2: type: string description: Optional additional details to the street name and number. example: WeWork nullable: true city: type: string example: Paris state: type: string description: >- Required for US addresses. Should be a valid ISO 3166-2 subdivision code. example: IDF nullable: true postalCode: type: string description: Postal code. example: '75009' country: $ref: '#/components/schemas/CountryCode' ApplicantType: type: string description: Type of applicant for Sumsub verification enum: - individual - company AccountUserRole: type: string description: Role of a user in an account. enum: - root - admin - view - self_custodial - beneficiary example: root BeneficiaryType: type: string description: >- Beneficiary type. UBOs are any individuals who, directly or inderectly, own more than 25% of the business. Representatives are individuals who have direct control over daily operations. enum: - ubo - representative example: ubo CountryCode: 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 - SVK - SVN - ZAF - SWE - CHE - THA - TUN - TUR - UGA - UKR - ARE - USA - URY - UZB - VEN - VNM - YEM - ZMB - ZWE - SMR example: FRA securitySchemes: integrator_auth: type: apiKey in: header name: X-Pubkey, X-Timestamp, X-Signature ````