Skip to main content
GET
/
v1
/
query
/
get-entity-details
Get details of a single entity
curl --request GET \
  --url https://api.example.com/v1/query/get-entity-details \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>'
{
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "verificationStatus": "active",
  "entityInfo": {
    "companyName": "<string>",
    "email": "<string>",
    "website": "<string>",
    "companyNumber": "<string>",
    "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": "<string>",
    "accountType": "individual",
    "walletAddress": "<string>",
    "isSelfCustodial": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "bridgeAccountId": "<string>",
    "logoUrl": "<string>"
  },
  "teamMembers": [
    {
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "userName": "<string>",
      "userEmail": "<string>",
      "role": "root",
      "joinedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "associatedPersons": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "beneficiaryType": [
        "UBO"
      ],
      "shareSize": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "pendingInvitations": [
    {
      "invitationId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "role": "root",
      "userName": "<string>",
      "userEmail": "<string>",
      "invitedBy": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Authorizations

X-Pubkey, X-Timestamp, X-Signature
string
header
required

Headers

X-Pubkey
string
required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

X-Timestamp
string
required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

X-Signature
string
required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Query Parameters

entityId
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Entity details retrieved successfully

Response body for entity details

entityId
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

verificationStatus
enum<string>
required

The identity verification status of the user.

Available options:
not_started,
init,
under_review,
waiting_for_information,
active,
rejected,
inactive
Example:

"active"

entityInfo
object
required

Response body for entity information

account
object
required

Response body for entity account information

teamMembers
object[]
required
associatedPersons
object[]
required
createdAt
string<date-time>
required
pendingInvitations
object[] | null