International Identity Document Validation

Verifies that the candidate’s passport, national ID or driver’s license is authentic and validly in circulation. This check provides a multi-level validation process by inspecting document data and positioning for authenticity, scanning the Machine Readable Zone (if available), and cross-checking the information provided against government databases to discover if the document is stolen, lost, expired or invalid. Refer to International Screenings for more details.

Operations

Retrieve an existing International Identity Document Validation

Request

Returns an existing International Identity Document Validation with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the International Identity Document Validation to retrieve.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/international_identity_document_validation/{id}'

Responses

International Identity Document Validation details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"41007cffefb435cf7d701f75d8b87b"

objectstring

Value:"international_identity_document_validation"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/international_identity_document_validations/41007cffefb435cf7d701f75d8b87b"

statusstring

Status of the screening.

Enum:"pending""complete""canceled""suspended"

Example:"complete"

resultstring or null

Result of the screening.

Enum:"clear""consider"

Example:"clear"

created_atstring, (date-time)

Time at which the screening was created.

Example:"2014-01-18T12:34:00Z"

completed_atstring, (date-time)

Time at which the screening was completed.

Example:"2014-01-18T12:35:30Z"

turnaround_timeinteger

Number of seconds the screening took to complete, calculated from created_at to completed_at.

Example:90

cancellation_reasonstring

See cancellation reasons section for possible values.

Example:"complete_now_customer_requested"

cancellation_reason_descriptionstring

See cancellation reasons section for possible values.

Example:"Customer requested Complete Now prior to screening completion"

pdf_urlstring

URL to PDF document containing screening result details

Example:"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"

Response

{
  "id": "41007cffefb435cf7d701f75d8b87b",
  "object": "international_identity_document_validation",
  "uri": "/v1/international_identity_document_validations/41007cffefb435cf7d701f75d8b87b",
  "status": "complete",
  "result": "clear",
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 90,
  "cancellation_reason": "complete_now_customer_requested",
  "cancellation_reason_description": "Customer requested Complete Now prior to screening completion",
  "pdf_url": "https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"
}