Verification ChecksEmployment & education

Payslip verification

Reviews uploaded payslips and records whether an employer or reviewer could confirm them.

Send PAYSLIP_VERIFICATION in checksRequested to run this check.

Upload one or more payslip documents before creating the report. This check may remain pending while an employer or reviewer completes confirmation.

The request

POST /api/v1/reports
{
  "subject": {
    "fullName": "Jane Doe",
    "idNumber": "36901234",
    "email": "jane@example.com",
    "country": "KE",
    "subjectType": "INDIVIDUAL"
  },
  "checksRequested": [
    "PAYSLIP_VERIFICATION"
  ],
  "attachments": [
    {
      "checkType": "PAYSLIP_VERIFICATION",
      "documentId": "7f000001-a1b0-1000-81a1-b00000000104"
    }
  ],
  "purpose": "Income verification",
  "consent": {
    "mode": "VERIFISHA_HOSTED"
  }
}

The acknowledgement

Creation is asynchronous. The report comes back as a draft; the check runs after.

201 Created
{
  "reports": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "DRAFT",
      "paymentState": {
        "status": "NOT_REQUIRED",
        "amount": {
          "amount": 0.1,
          "currency": "KES"
        }
      },
      "consentState": {
        "status": "NOT_REQUIRED"
      }
    }
  ],
  "count": 1
}

The result

When the check finishes, this arrives at your webhook. COMPLETED means it ran — read riskLevel and flags to decide what it found.

On this page