A useful way to retrieve results is via the GET /entities/{entityId}/summary endpoint. This will return a summary of each type of check that can be run against the Entity, along with the results and key information for each.
You will need the entityId to call this endpoint - which will have been provided in the response when you created your Process/Entity.
For a full breakdown of the schema and Enums, please visit our Swagger page.
GET /entities/{entityId}/summary
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "2024-03-12T08:16:23.181Z",
"emailAddress": "string",
"phoneNumber": "string",
"dateOfBirth": "2024-03-12T08:16:23.181Z",
"address": {
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"county": "string",
"postcode": "string"
},
"entityTags": [
{
"id": 0,
"value": "string",
"memberCount": 0
}
],
"registrationCode": "string",
"status": 0,
"accountType": 1,
"identityVerifications": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"entryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentType": 0,
"livenessResult": 0,
"documentResult": 0,
"visualAnalysisResult": 0,
"nfcResult": 0,
"ageValidationResult": 0,
"policeRecordResult": 0,
"compromisedAlertResult": 0,
"repeatAttemptsResult": 0,
"nameMatchResult": 0,
"faceMatchResult": 0,
"documentNumber": "string",
"documentExpiryDate": "string",
"documentBirthDate": "string",
"documentIssuingCountryCode": "string",
"supportingDocuments": [
{
"supportingDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"isForRtx": true,
"dateCompleted": "2024-03-12T08:16:23.181Z",
"overallResult": 0
}
]
}
],
"addressMortalityChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"dataCheckId": 0,
"addressMatch": true,
"dobMatch": true,
"firstNameMatch": true,
"lastNameMatch": true,
"deceasedMatch": true
}
],
"bankAccountChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"dataCheckId": 0,
"sortCodeVerified": true,
"accountNumberVerified": true,
"accountDetailsMatched": true,
"accountAgeOver6Months": true,
"accountAgeOver12Months": true,
"accountAgeOver24Months": true,
"accountAgeOver5Years": true,
"allowsDirectDebits": true,
"allowsDirectCredits": true,
"allowsChapsSterling": true,
"allowsCCnCClearing": true,
"allowsFasterPaymentsClearing": true,
"allowsBacsClearing": true
}
],
"sanctionPepChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"dataCheckId": 0,
"allCountries": true,
"selectedCountries": [
"string"
],
"allPepTiers": true,
"selectedPepTiers": [
0
],
"selectedDatasets": [
1
],
"watchListActive": true,
"watchListEndDate": "2024-03-12T08:16:23.181Z",
"watchListActiveUntilCancelled": true,
"pepMatch": true,
"formerPepMatch": true,
"linkedPepMatch": true,
"sanctionsMatch": true,
"adverseMediaMatch": true,
"lawEnforcementMatch": true,
"disqualifiedDirectorMatch": true
}
],
"rightToRentChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"rightToRentCheckId": 0,
"entityIdvEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentType": 0,
"shareCode": true
}
],
"rightToWorkChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"rightToWorkCheckId": 0,
"entityIdvEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentType": 0,
"shareCode": true
}
],
"safeHarbourChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"safeHarbourCheckId": 0,
"entityIdvEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentType": 0
}
],
"diatfCheck": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"entityIdvEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identityProfile": 0,
"identityVerified": true
},
"cappChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"dataCheckId": 0
}
],
"proofOfOwnershipChecks": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overallResult": 0,
"dataCheckId": 0,
"electronicCheck": true,
"downloadTitleRegister": true,
"downloadTitlePlan": true,
"firstNameMatch": true,
"middleNameMatch": true,
"surnameMatch": true,
"ownershipType": 0,
"tenureType": 0,
"titleNumber": "string"
}
],
"processes": [
{
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processName": "string",
"journeyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"journeyName": "string",
"dateCreated": "2024-03-12T08:16:23.181Z",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"processStatus": 0
}
],
"esignDocuments": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"esignDocumentId": 0,
"dateCreated": "2024-03-12T08:16:23.181Z",
"dateCompleted": "2024-03-12T08:16:23.181Z",
"requiredSignatureCount": 0,
"pendingSignatureCount": 0,
"signedSignatureCount": 0,
"status": 1,
"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
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