Retrieving Safe Harbour details/results | API

To retrieve 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) and the entityIdvEntryId (which can be used to retrieve the ID document and linking documents - see below).

Retrieving the Safe Harbour result

Using the safeHarbourCheckId and the EntityID you can call the GET /api/v2/ci/entities/{entityId}/data-checks/safe-harbour/{safeHarbourCheckId} endpoint to retrieve the outcome ('status') of the check.  The response from this endpoint will be structured as follows:

{

  "id": 12345,

  "entityId": "e483917v-75c0-481d-81f4-66f3a626a4cf",

  "entityIdvId": 456789,

  "dateCreated": "2024-03-18T05:57:49.93",

  "status": 3,

  "history": []

}

The possible values for 'status' are:

0 = NotPerformed

1 = AutoPass

2 = AutoFail

3 = PendingManualCheck

4 = ManualPass

5 = ManualFail

6 = ManualRefer

7 = Requested

Retrieving the Safe Harbour ID Document and linking documents

Using the entityIdvEntryId and the EntityID you can call the GET /api/v2/ci/entities/{entityId}/idv-entries/{entryId} endpoint to retrieve the ID document and linking document details.

Please see the Downloading ID document elements page for more details on how to download the ID document elements.