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:
| Key | Value |
| 0 | Not invited |
| 1 | Invited |
| 2 | Active |
| 3 | Inactive |
| 5 | Deleted |
| 6 | Expired |
| 7 | Bounced invite |
accountType values:
| Key | Value |
| 1 | Guest |
| 2 | Registered |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article
Join our live training sessions
Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including: - AML / ID verification - Right to Work - Our brand-new Credas Lettings solution - Admin / advanced training In each session we will walk you through how platform works and answer any questions you may have.
See our full training schedule