Downloading ID document elements | API

The individual elements of an ID document can be retrieved via the API.

An Entity can have multiple 'IDv Entries' attached to it.  Each 'IDv Entry' can have multiple ID Documents within it, and also an associated facial (selfie) image.

Use the GET /api/c2/ci/entities/{entityId}/idv-entries endpoint to retrieve a collection if IDv Entries for the Entity.

Each entry will contain a detailed breakdown of the results of any ID Document submissions.

[

  {

    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "taskId": 0,

    "idvId": 0,

    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "entityName": "string",

    "dateCreated": "2024-03-14T11:00:05.130Z",

    "hasSelfie": true,

    "hasUap": true,

    "livenessVerified": true,

    "livenessCheckMethod": 1,

    "livenessRetryRequired": true,

    "livenessVerificationResult": 0,

    "verificationReason": "string",

    "facialMatchVerificationResult": 0,

    "nameCheckVerificationResult": 0,

    "verificationResult": 0,

    "uapAction": 1,

    "idDocumentRetryRequired": true,

    "idDocuments": [

      {

        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

        "dateCreated": "2024-03-14T11:00:05.130Z",

        "idDocumentType": 0,

        "facialMatch": true,

        "facialMatchVerificationResult": 0,

        "firstName": "string",

        "middleName": "string",

        "surname": "string",

        "dateOfBirth": "2024-03-14T11:00:05.130Z",

        "documentNumber": "string",

        "expiryDate": "2024-03-14T11:00:05.130Z",

        "address": "string",

        "city": "string",

        "postcode": "string",

        "countryCode": "string",

        "country": "string",

        "mrzLine1": "string",

        "mrzLine2": "string",

        "mrzLine3": "string",

        "nameCheckMatched": true,

        "nameCheckVerificationResult": 0,

        "verifiedBy": "string",

        "verificationDate": "2024-03-14T11:00:05.130Z",

        "verificationResult": 0,

        "verificationReason": "string",

        "nfcReadStatus": 0,

        "nfcReadDate": "2024-03-14T11:00:05.130Z",

        "nfcCheckRequired": true,

        "nfcReadingComplete": true,

        "visualAnalysisPassed": true,

        "visualAnalysisVerificationResult": 0,

        "nfcCheckPassed": true,

        "nfcCheckVerificationResult": 0,

        "nfcHashMatched": true,

        "nfcDocumentSigned": true,

        "nfcCountrySigned": true,

        "backScanStatus": 0,

        "uploadedBy": "string",

        "scanReference": 0,

        "policeRecordAlert": true,

        "ageValidation": true,

        "compromisedAlert": true,

        "repeatAttemptAlert": true

      }

    ],

    "nonBiometricDocuments": [

      {

        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

        "title": "string",

        "dateCreated": "2024-03-14T11:00:05.130Z",

        "verificationResult": 0,

        "verificationReason": "string",

        "verifiedBy": "string",

        "verificationDate": "2024-03-14T11:00:05.130Z",

        "isForRtx": true,

        "fileType": 0

      }

    ],

    "visualAnalysisVerificationResult": 0,

    "nfcCheckPerformed": true,

    "nfcCheckPassed": true,

    "dateRequested": "2024-03-14T11:00:05.130Z",

    "verifiedBy": "string",

    "verificationDate": "2024-03-14T11:00:05.130Z",

    "readOnly": true,

    "rtxMethod": 0,

    "entityShareCode": {

      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

      "shareCode": "string",

      "dateOfBirth": "2024-03-14T11:00:05.130Z",

      "comment": "string",

      "valid": true,

      "faceMatch": true,

      "nameMatch": true,

      "hasCertificate": true,

      "processed": true,

      "invalidReason": 1

    },

    "captureUap": true,

    "documentAlreadyUsed": true

  }

]

Downloading the Selfie image

The Idv 'entyId', along with the entityID can be used to retrieve the selfie image via the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/selfie endpoint.

Downloading the UAP image

If the Entity failed the passive liveness check they may have been propmpted to perform a UAP (unique action process) - e.g. 'touch your nose'.  If this was the case then the UAP selfie (the image of the Entity performing the action) can be retrieved via the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/uap endpoint.

The sample image (i.e. showing a model performing the requested action for the purpose of comparison) can be downloaded by the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/uap-requested endpoint.

Downloading the ID document image

Each Idv Entry can have a collection of ID Documents attached to it.  The "id" of each document (idDocumentId) can be used in conjunction with the entryId and the entityId to retrieve the ID document image via the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/id-documents/{idDocumentId} endpoint.

The image of the back of the document (if applicable) can be downloaded via the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/id-documents/{idDocumentId}/back endpoint.

Downloading Supporting document images

In some cases, the Entity may have been prompted to upload supporting documents (e.g. Council tax, Utility bill etc.)

If the Entity uploaded any supporting documents, there will be corresponded 'nonBiometricDocument' entries within the IDV entry.  The ID of these entries can be used as the 'supportingDocumentID' to retrieve the document image via the GET /api/c2/ci/entities/{entityId}/idv-entries/{entryId}/supporting-documents/{supportingDocumentId} endpoint.