Get the details of an entity | API

An entity is the individual you are seeking to verify through Credas. Within the API entities are identifiable by their entityId. 

Get details of an entity

To obtain the details of an entity you can perform a GET request to the /api/v2/ci/entities/{entityId} endpoint. 

As part for request you must specify the entityId within the url. 

Response body

As part of the response body we will return id value, this is referred to as the entityId.

{

  "processActors": [],
  "id": "f8b1971e-f25b-467d-96dd-38351889d85d",
  "firstName": "Test",
  "surname": "Test",
  "dateCreated": "2023-09-12T07:10:13.323",
  "emailAddress": "user@example.com",
  "phoneNumber": "07000000000",
  "entityTags": [],
  "registrationCode": "ABC-123",
  "status": 0,
  "accountType": 1
}

Status values:

accountType values: