v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Identity Document Verification

Retrieve an Identity Document Verification

Get the detailed results of an Identity Document Verification, including the status of the verification, the reasons in case of rejection and the data extracted from the Identity Document.

get/verifications/identity_documents/{identityDocumentVerificationId}

Path parameters

identityDocumentVerificationIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Identity Document Verification Id

Response

idstring uuid required

The unique identifier for a resource.

workspace_idstring uuid required

The Workspace ID in which the verification has been created.

created_atstring date-time required

Creation date of the Identity Document Verification.

updated_atstring date-time required

Update date of the Identity Document Verification.

status'pending' | 'awaiting_data' | 'verified' | 'failed' | 'inconclusive' required

Status of the Identity Document Verification

status_codesstring[] required

List of status codes. Indicates the cause when the status is failed or inconclusive.

data_anonymizedboolean required

Indicates if the personal data extracted from the document has been anonymized. If set to true, the personal data has been anonymized and most fields will be NULL.

workflow_session_idstring uuid nullable required

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable required

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

applicant_idstring uuid nullable required

Unique identifier of an Applicant.

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "workspace_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z",
  "status": "verified",
  "status_codes": [
    "IDDV_1706",
    "IDDV_1707"
  ],
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
  "applicant_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "data": {
    "extracted_from_document": {
      "first_name": "John",
      "birth_name": "Doe",
      "last_name": "Doe",
      "born_on": "2024-01-18",
      "birth_location": "Paris",
      "gender": "f",
      "full_address": "13 RUE SAINT MARCELIN\nMARSEILLE 10E (13)",
      "type": "id_card",
      "issuing_country_code": "US",
      "issued_on": "2024-01-18",
      "expired_on": "2024-01-18",
      "document_number": "X4RTBPFW4",
      "mrz": {
        "line1": "IDFRASIAGRA<<<<<<<<<<<<<<<<<<<133039",
        "line2": "1002133008071GREGOIRE<<REMY8110228M4",
        "line3": "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"
      },
      "national_identification_number": "MLLSNT82P65Z404U"
    }
  }
}