v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Identity Verification

Get Employment Profile

Gets necessary information to perform the identity verification of an employee.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employment documents (employment_documents)	View identity verification (identity_verification:read)	Manage identity verification (identity_verification:write)

get/v1/identity-verification/{employment_id}

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "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"
    }
  }
}