Skip to main content
POST
POST /rwa_retrieve If results are still being calculated, the endpoint returns Pending. Wait briefly, then retrieve the same assessment again; do not create another assessment.

Authorization

string
required
Company Bearer token. Keep it on your server.

Body parameters

string
required
Assessment identifier returned by the create endpoint.

Error responses

Response

The documented success body contains status: "success" and a data object. Risk scores are numbers and can contain decimals; see risk ratings.
number
Risk score from 0 to 10. See risk ratings.
number
Risk score from 0 to 10. See risk ratings.
number
Risk score from 0 to 10. See risk ratings.
number
Risk score from 0 to 10. See risk ratings.
number
Risk score from 0 to 10. See risk ratings.
number
Risk score from 0 to 10. See risk ratings.
string
Assessment identifier.
string
Saved external Staff ID; may be empty when not assigned.
string
Saved external Staff ID; may be empty when not assigned.
string
Saved external Staff ID; may be empty when not assigned.
string
Company cumulative permanent-establishment risk level. Work From Anywhere only; separate from the 0–10 scores.
number
Contractor misclassification risk score. Hire From Anywhere only.
Check the JSON response as well as HTTP status. HTTP 200 can contain an API error. If a request times out, check the assessment before retrying. Retry deduplication is not verified.