identity-verification

idstring

Unique identifier for the report item.

Example:"rpi_F3hQ7wEsLp2xBnVcRuMyTk"

statusstring or null

Resolved status of this report item:

clear — no findings that warrant adjudication
consider — findings present; the result should be reviewed before making a decision

Null while the report item is still being assembled and no results have been recorded yet.

Enum:"clear""consider"null

created_atstring, (date-time)

Timestamp the report item was created.

updated_atstring, (date-time)

Timestamp the report item was last updated.

document_typeidv-document-type (object) or null

One of:

Classification of the identity document submitted by the applicant.

document_dataidv-document-data (object) or null

One of:

Data extracted from the identity document. All fields are nullable — extraction is best-effort and not every document type exposes every field.

consider_reasonsArray of objects(idv-consider-reason)

Reasons the verification resulted in a consider status. Empty when status is clear or null. Each entry represents a distinct rejection category explaining why the verification did not pass.

documents_zip_urlstring or null, (uri)

Signed URL to download the document images captured during the verification session as a ZIP archive, or null if no document images are available. The URL is single-use and short-lived, and needs no authentication of its own — it can be handed straight to a browser.

To retrieve these images alongside the report's other documents in one authenticated call, use GET /reports/{id}/documents/zip instead.

Example:"https://tenant.checkr.com/api/identity_verification_documents/idvd_K9dM2pXqR4vN8tLZbWyHJa"

{
  "id": "rpi_F3hQ7wEsLp2xBnVcRuMyTk",
  "status": "clear",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "document_type": {
    "type": "Drivers License",
    "country": "USA",
    "state": "CA"
  },
  "document_data": {
    "first_name": "Jane",
    "last_name": "Public",
    "full_name": "Jane Public",
    "dob": "1990-05-14",
    "document_number": "D1234567",
    "issue_date": "2020-01-01",
    "expiration_date": "2028-01-01",
    "address": { … }
  },
  "consider_reasons": [
    { … }
  ],
  "documents_zip_url": "https://tenant.checkr.com/api/identity_verification_documents/idvd_K9dM2pXqR4vN8tLZbWyHJa"
}