For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Entity using ID

This endpoint allows you to retrieve an entity using the entity ID, this can either be a business or an individual.

GET {{baseurl}}/v2/api/entities/:entityId

Headers

Name
Type
Description

token*

String

API secret token

Parameter

Field
Type
Description

entityId*

String

Id of the entity being fetched

{
     "success": true,
    "status_code": 200,
   "message": "Entity fetched successfully!",
    "data": {
      "_id": "685c73c8519d82bd21a42fae",
          "businessId": "61d880f1e8e15aaf24558f1a",
          "firstName": "Jack",
          "lastName": "Frost",
          "entityType": "individual",
          "dateOfBirth": "1999-10-02",
          "phone": "07030000001",
          "taxId": null,
          "gender": "male",
          "status": "not_approved",
          "profileStatus": "pending",
          "createdBy": "61f162ec1fd251c3a63f31c2",
          "isOnboarded": true,
          "potentialEntityMatch": null,
          "createdAt": "2025-06-25T22:10:16.862Z",
          "lastModifiedAt": "2025-06-25T22:10:16.862Z",
          "_createdAt": "2025-06-25T23:10:1616+01:00",
          "_lastModifiedAt": "2025-06-25T23:10:1616+01:00",
          "object": "entity",
          "id": "ent_685c73c8519d82bd21a42fae"
    },
    },
  "links": []
}

Last updated

Was this helpful?