v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified ATS (Assessment & Background Check) API

Update order result

Updates an assessment or a background check order result.

Example Request Body

{
  "status": "COMPLETED",
  "score": 90,
  "max_score": 100,
  "result_url": "https://example.com",
  "completed_at": "2023-04-04T00:00:00.000Z",
  "attributes": [
    {
      "type": "TEXT",
      "label": "Role fit",
      "value": "Excellent"
    },
    {
      "type": "SUB_RESULT",
      "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
      "label": "Personality test",
      "score": {
        "value": 97,
        "max": 100
      },
      "status": "COMPLETED"
    }
  ],
  "attachments": [
    {
      "name": "Assessment Report.pdf",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "content_type": "application/pdf"
    }
  ]
}
put/assessment/orders/{assessment_order_id}/result

Path parameters

assessment_order_idstring required

PUT /assessment/orders/:assessment_order_id/result Parameter

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

status'COMPLETED' | 'CANCELLED' | 'OPEN' required

Status of the assessment.

Please note the status can only be updated to a different value if its current value is OPEN.

result_urlstring uri required
completed_atstring date-time

YYYY-MM-DDTHH:mm:ss.sssZ

Please make sure this value is provided when the status is of the type COMPLETED or CANCELLED.

scorenumber double
max_scorenumber double

Response

PUT /assessment/orders/:assessment_order_id/result Positive response

status'success' required
dataobject required