Identity Verification

Employers can use this endpoint to verify a new hire's identification.

ℹ️ This is a mandatory step for all new hires in the UK.

On an employee's first day, the identity_verification.verification_required webhook is triggered notifying the company owner and admin that identity verification is required. Once the notification is received, you can use the Get Employment Profile endpoint is used to get details of the employee that needs verification.

{
  "data": {
    "identity_verification_data": {
      "contract_id": "1c130827-f95c-4495-b7cb-5876dce686b8",
      "employment_document": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8r5-document.pdf",
        "sub_type": "identity_verification",
        "type": "mobility"
      },
      "employment_image": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8r5-image.png",
        "sub_type": "identity_verification",
        "type": "mobility"
      },
      "status": "pending"
    }
  }
}

After verifying data, you can use the Verify Employment Identity to approve the request or Decline Identity Verification to decline the request for identification.