PeopleForce
Kadry

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

List all compliance cases

Returns a list of compliance cases

GET
/api/v4/compliance/compliance_cases

Returns a list of compliance cases

Query Parameters

page?integer

Page offset to fetch.

Formatint32
Default1
per_page?integer

Number of results to return per page.

Formatint32
Default50
offset?integer

Pad a number of results.

Formatint32
Default0
employee_ids?array<>

Filter by employee IDs

statuses?array<>

Filter by compliance case status. Allowed values: verification, pending, cancelled, completed

document_statuses?array<>

Filter by compliance case document status. Allowed values: unverified, verified, signed

document_pending_upload?boolean

Filter to only cases that have at least one document pending upload

Response Body

application/json

curl -X GET "https://example.com/api/v4/compliance/compliance_cases"
{  "data": [    {      "id": 0,      "employee_id": 0,      "compliance_process_id": 0,      "status": "verification",      "resource_type": "string",      "resource_id": 0,      "compliance_case_documents": {        "id": 0,        "compliance_case_id": 0,        "employee_id": 0,        "compliance_process_document_id": 0,        "status": "unverified",        "verified_at": "2019-08-24T14:15:22Z",        "attachment": {          "url": "string",          "expires_at": "2019-08-24T14:15:22Z"        },        "pending_upload": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "metadata": {    "page": 0,    "per_page": 0,    "total_pages": 0,    "total_count": 0  }}