PeopleForce
Kadry

Early access

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

Get a compliance case

Returns a single compliance case

GET
/api/v4/compliance/compliance_cases/{id}

Returns a single compliance case

Path Parameters

id*integer
Formatint64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v4/compliance/compliance_cases/0"
{  "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"  }}