Verification Checks

Overview

Every check Verifisha can run, grouped by what it verifies.

Every check runs through the same call: post a subject and the checks you want to /api/v1/reports, and the result arrives by webhook. Pick a check for the payload that runs it.

How a verification runs

Send the request

Name the checks in checksRequested, inside { "reports": [ ... ] }. One request can carry up to 500 reports.

Get the acknowledgement

Creation is asynchronous, so the response is an acknowledgement, not a result. Reports come back as DRAFT with their payment and consent state.

Receive the result

Wait for the terminal report.ready or report.failed webhook before treating a report as final, and read statuses and outcomes before deciding what it means.

Naming the checks

These pages name checks in checksRequested. A dynamic integration can send checkDefinitionIds instead, using the id of each definition from GET /api/v1/checks/definitions — which is also where prices, subject applicability and required inputs come from for your workspace.

Some names are aliases, and the result comes back under the canonical name. Match on what you receive rather than what you sent: LIVENESS_CHECK returns as FACE_MATCH, HAKIKISHA as PHONE_NUMBER_HAKIKISHA, CREDITINFO_CRB_STATUS as CREDITINFO_STATUS, and METROPOL_CRB_SCORE as CRB_SCORE.

Checks that take a document

Upload the file first, then reference what you get back in attachments.

POST /api/v1/documents/upload?checkType=CV_ANALYSIS
{
  "documentId": "7f000001-a1b0-1000-81a1-b00000000090"
}
Then, in the report request
{
  "attachments": [
    { "checkType": "CV_ANALYSIS", "documentId": "7f000001-a1b0-1000-81a1-b00000000090" }
  ]
}

Several people at once

Add entries to reports — up to 500. Send an Idempotency-Key header so a retry cannot create the batch twice.

POST /api/v1/reports
{
  "reports": [
    { "subject": { "subjectType": "INDIVIDUAL", "fullName": "Jane Doe", "idNumber": "36901234" },
      "checksRequested": ["IDENTITY"], "purpose": "Staff screening",
      "consent": { "mode": "VERIFISHA_HOSTED" } },
    { "subject": { "subjectType": "INDIVIDUAL", "fullName": "John Doe", "idNumber": "29887761" },
      "checksRequested": ["IDENTITY"], "purpose": "Staff screening",
      "consent": { "mode": "VERIFISHA_HOSTED" } }
  ]
}

On this page