Skip to main content
GET
/
v1
/
query
/
get-entity-details
Get entity details by entity ID
curl --request GET \
  --url https://api.example.com/v1/query/get-entity-details
{
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "verificationStatus": "active",
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "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"
    }
  },
  "teamMembers": [
    {
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "userName": "<string>",
      "userEmail": "<string>",
      "role": "root",
      "joinedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "associatedPersons": [
    {
      "beneficiaryType": [
        "UBO"
      ],
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "isRootUser": true,
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "isPasskeyActivated": true,
      "isOtpActivated": true
    }
  ],
  "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"
    }
  ]
}

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"

​
accountId
string<uuid>
required

A UUID string

Example:

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

​
entityInfo
object
required

Response body for entity information

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