The overall result of a Safe Harbour check must be determined by you/your client by checking that the ID document that has been provided has been verified, and that the linking documents (where applicable) are valid and relevant. More information on retrieving these details can be found on the Retrieving Safe Harbour details page.
To update the details/results of a Safe Harbour check you must first call the GET /api/v2/ci/entities/{entityId}/summary endpoint. This will contain a safeHarbourChecks section, which will be structured like this:
"safeHarbourChecks": [
{
"safeHarbourCheckId": 12345,
"entityIdvEntryId": "r0c957df-e023-46eb-a72e-f68567559638",
"documentId": "bf858203-26d9-44c5-ab94-e0g88c6f7d2",
"documentType": 10,
"entityId": "e483917v-75c0-481d-81f4-66f3a626a4cf",
"dateCompleted": "2024-03-18T05:57:49.93",
"processId": "c5c23ed5-5e1a-4es1-a54h-bf19bbc842ce",
"overallResult": 4
}
]
From here you can retrieve the 'safeHarbourCheckId' (12345 in the above example) which can be used, along with your EntityID, to call the PUT/api/v2/ci/entities/{entityId}/data-checks/safe-harbour/{safeHarbourCheckId} endpoint.
The request object should be structured as follows:
{
"status": 0,
"comments": "string"
}
'comments' is a mandatory field and must contain some text - e.g. 'We have checked the documents and they are valid'.
The possible values for 'status' are:
0 = NotPerformed
1 = AutoPass
2 = AutoFail
3 = PendingManualCheck
4 = ManualPass
5 = ManualFail
6 = ManualRefer
7 = Requested
Typically, you will set this status to either 4 (ManualPass) or 5 (ManualFail) based on the decision that has been made.
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