Result status update webhooks are used to call back to external systems with updates on the status of individual results - e.g. identity verification, international screening and so forth.
Configuring your webhook URL
The result status webhook URL is set per Credas portal and must be set by your technical contact.
However, resellers can set this value within a child portal. Please contact your technical contact for more information on this.
JSON POST
A HTTP post will be sent to the configured webhook URL on completion of the process. This post body will change per service however it will always include an updateType value.
The updateType value can be used to determine the service that has been updated, please refer to the table below for a complete list of values:
Value | Description |
1 | Name check |
2 | Share code |
3 | Liveness |
4 | ID document |
5 | Non biometric document (supporting document) |
6 | Datacheck |
7 | Right to rent |
8 | Right to work |
9 | Safe harbour |
Once you have identified the type of update you can then interpret the response body to obtain the updated result status.
A breakdown & example response body per updateType can be found within the relevant sections below.
Example use case
Our result status update webhook can be used to determine when an agent has completed their remediation of a result within the portal.
Alternatively, if you are utilising the Credas+ or back-office functionality you can use this webhook to obtain any updates performed by our back-office team.
Name check
Our name check POST body will return the following values:
- EntityIdvEntryIdDocumentId
- NameCheckVerificationResult
- EntityId
- ClientId
{
"UpdateType": 1,
"Payload": "{\"EntityIdvEntryIdDocumentId\":\"96d50a9e-6696-4ca6-b9db-ee37b1a5de28\",\"NameCheckVerificationResult\":3,\"EntityId\":\"9811e0dc-7bbb-4fdf-be96-b8c7c105080f\",\"ClientId\":\"a6beec64-5007-45b4-b49d-f4d17c99efee\"}"
}
Liveness
Our Liveness POST body will return the following values:
- EntityIdvEntryId
- VerificationResult
- EntityId
- ClientId
ID document
Our ID document POST body will return the following values:
- EntityIdvEntryIdDocumentId
- FacialMatchVerificationResult
- NameCheckVerificationResult
- NfcCheckVerificationResult
- VisualAnalysisVerificationResult
- BackScanVerificationResult
- VerificationResult
- EntityId
- ClientId
{
"UpdateType": 4,
"Payload": "{\"EntityIdvEntryIdDocumentId\":\"4cb2e52f-da1a-4fb7-b9f9-03b5275422a9\",\"FacialMatchVerificationResult\":5,\"NameCheckVerificationResult\":5,\"NfcCheckVerificationResult\":0,\"VisualAnalysisVerificationResult\":5,\"BackScanVerificationResult\":0,\"VerificationResult\":5,\"EntityId\":\"d10a6372-85a9-4f20-9bdf-ab589a1b280c\",\"ClientId\":\"75e7fa46-7c93-4d2e-86ee-727737c6f482\"}"
}
Non biometric document (supporting docs)
Our non biometric document POST body will return the following values:
- NonBiometricDocumentId
- Status
- EntityId
- ClientId
{
"UpdateType": 5,
"Payload": "{\"Items\":[{\"NonBiometricDocumentId\":\"15b7ec8c-7c3f-413f-9b38-36d1a868767d\",\"Status\":4}],\"EntityId\":\"9811e0dc-7bbb-4fdf-be96-b8c7c105080f\",\"ClientId\":\"a6beec64-5007-45b4-b49d-f4d17c99efee\"}"
}
Datacheck
Our datacheck POST body will return the following values:
- DataCheckId
- Status
- EntityId
- ClientId
{
"UpdateType": 6,
"Payload": "{\"DataCheckId\":70040,\"Status\":3,\"EntityId\":\"ef3e2a97-02d0-4a13-91fb-0ada2c474f25\",\"ClientId\":\"d04d0b36-e663-4447-bbbf-b0a5aaa3aae3\"}"
}
Right to rent
Our right to rent POST body will return the following values:
- rtxId
- Status
- EntityId
- ClientId
{
"UpdateType": 7,
"Payload": "{\"Id\":23,\"Status\":4,\"EntityId\":\"a6beec64-5007-45b4-b49d-f4d17c99efee\",\"ClientId\":\"9811e0dc-7bbb-4fdf-be96-b8c7c105080f\"}"
}
Right to work
Our right to work POST body will return the following values:
- rtxId
- Status
- EntityId
- ClientId
{
"UpdateType": 8,
"Payload": "{\"Id\":418,\"Status\":4,\"EntityId\":\"a6beec64-5007-45b4-b49d-f4d17c99efee\",\"ClientId\":\"cefd9cd4-03c6-4ece-be3f-0406a5e5a6b2\"}"
}
Safe harbour
Our safe harbour POST body will return the following values:
- EntityIdvId
- Verification result
- EntityId
- ClientId
{
"UpdateType": 9,
"Payload": "{\"EntityIdvId\":4295,\"VerificationResult\":4,\"EntityId\":\"89f11ea6-0c5e-4c0f-8625-e55763e0acda\",\"ClientId\":\"a6beec64-5007-45b4-b49d-f4d17c99efee\"}"
}
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