Retrieve Completed ID Check

Use this endpoint to retrieve a completed ID Check, once retrieved you can use the Set ID Check Received endpoint to stop it from being returned again. It is recommended to use the case event functionality over this endpoint.

/api/rest/{organisationId}/questionnaires/{questionnaireId}

Retrieve a completed ID Check, along with any provided documents and the ID Report. Once you have retrieved the ID Check you may call the setIdCheckReceived method to stop it from returning on the next call.

Request parameters

Responses

{
  "questionnaireId": 1234,
  "externalCaseRef": "ABC123-1",
  "externalClientRef": "ABC123-1/CLIENT-1",
  "result": "PASS",
  "sumSubResult": {
    "reviewStatus": "example",
    "requiredDocsStatus": {},
    "info": {
      "firstName": "example",
      "middleName": "example",
      "lastName": "example",
      "firstNameEn": "example",
      "middleNameEn": "example",
      "lastNameEn": "example",
      "gender": "example",
      "country": "example",
      "nationality": "example",
      "countryOfBirth": "example",
      "dob": "1970-01-14",
      "idDocs": [
        {
          "country": "example",
          "firstName": "example",
          "lastName": "example",
          "firstNameEn": "example",
          "lastNameEn": "example",
          "idDocType": "Selfie",
          "number": "example",
          "issuedDate": "1970-01-14",
          "validUntil": "1970-01-14",
          "dob": "1970-01-14"
        }
      ],
      "addresses": [
        {
          "subStreet": "example",
          "street": "example",
          "state": "example",
          "town": "example",
          "postCode": "example",
          "country": "example",
          "subStreetEn": "example",
          "streetEn": "example",
          "stateEn": "example",
          "townEn": "example",
          "formattedAddress": "example"
        }
      ]
    },
    "rejectLabels": [
      "FORGERY"
    ],
    "reviewAnswer": "Fail",
    "clientComment": "example",
    "moderationComment": "example",
    "images": [
      {
        "file": [
          "example"
        ],
        "type": "Selfie"
      }
    ]
  },
  "smartSearchResult": {
    "clientRef": "example",
    "ssid": "example",
    "ssidChain": [
      "example"
    ],
    "cra": "example",
    "riskLevel": "example",
    "name": {
      "title": "example",
      "first": "example",
      "middle": "example",
      "last": "example"
    },
    "dateOfBirth": "1970-01-14",
    "contacts": {
      "email": "example",
      "mobile": "example",
      "telephone": "example"
    },
    "documents": {
      "nino": "example",
      "passport": {
        "country": "example",
        "expiry": "1970-01-14",
        "mrz_line_2": "example"
      },
      "driving_licence": "example"
    },
    "bank": {
      "number": "example",
      "sortcode": "example",
      "card": {
        "number": "example",
        "security": "example",
        "start": "example",
        "expiry": "example",
        "type": "example",
        "issue": "example"
      },
      "roll_number": "example"
    },
    "result": "Pass",
    "granularData": [
      {
        "type": "example",
        "title": "example",
        "source": 96,
        "item": 96,
        "oldest_date": "example"
      }
    ],
    "numberOfPrimaryChecks": 96,
    "numberOfPrimarySources": 96,
    "numberOfCollaborativeChecks": 96,
    "numberOfCollaborativeSources": 96,
    "authenticationIndex": {
      "value": 96,
      "message": "example"
    },
    "nameAndAddressMatch": "Pass",
    "identityConfirmationLevel": "Pass",
    "pafConfirmation": "Pass",
    "oldestPrimaryDate": "example",
    "oldestCollaborativeDate": "example",
    "dobMatchPrimary": 96,
    "dobMatchCollaborative": 96,
    "mobileNumberValidation": true,
    "emailAddressValidation": true,
    "bankAccountMatch": true,
    "bankCardValidation": true,
    "drivingLicenceNumberValidation": true,
    "nationalInsuranceNumberValidation": true,
    "deceasedCheck": "Pass",
    "potentialFraudAlert": "Pass",
    "dueDiligence": {
      "monitoringActive": true,
      "monitoringFrequency": "example",
      "lastMonitored": "1971-04-26T12:26:06Z",
      "sanctionRegion": "example",
      "dueDiligence": true,
      "outstandingDueDiligence": true,
      "highriskDueDiligence": true,
      "worldwideSanctions": "Pass",
      "hmTreasury": "Pass",
      "ofacsSanctions": "Pass",
      "politicallyExposedPerson": "Pass",
      "specialInterestPerson": "Pass",
      "specialInterestEntity": "Pass",
      "relativeCloseAssociate": "Pass",
      "hmtOfacs": "Pass"
    }
  },
  "documents": [
    {
      "name": "Driving Licence",
      "type": "DRIVING_LICENCE",
      "requiredDocumentType": "ID_CARD",
      "result": "GREEN",
      "issues": "Out of Date",
      "clientComment": "This is my driving licence",
      "contentBase64": "GDHSJGHDJG..."
    }
  ],
  "providedNameSimilarityWithMatchedName": 96,
  "reportContentBase64": "example",
  "clientName": "example"
}

02 July 2026