Get Process Detail
GET
/candidate-requests/{uuid}/processes/{processId}
Once a process has finished, you can retrieve its Process Summary or the Extended Technical Data.
Required Headers (HTTP Headers)
| Header | Type | Required | Value / Example |
|---|---|---|---|
Content-Type | string | Yes | application/json |
Authentication
Authenticate with the method Blacktrust defined for your integration: the x-api-key header or Authorization: Bearer {accessToken} (one or the other, never both). See Authentication to find out which one applies to you.
Query Parameters
| Name | Type | Required | Value / Example |
|---|---|---|---|
detail | boolean | No | If set to true, the response includes the rawDetails object with the extended technical data. Defaults to false, returning only the executive summary. |
Request Example
- cURL
- Node.js
curl -X GET "{BASE_URL}/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db/HDFGHRHTHDGHdfghRT?detail=true"
const detail = true;
const response = await fetch(
"{BASE_URL}/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db/HDFGHRHTHDGHdfghRT?detail=${detail}",
{ method: "GET" },
);
API Responses
- 200 OK
Process-specific responses
The response of this service depends on the process queried. See Processes for details.