# Read a candidate's results

`GET https://{host}/api/v1/account/projects/{projectId}/candidates/{candidateId}/results`

The same body the push sends. A reference check completes over days, so poll no more often than every five minutes.

## Authentication

`Authorization: Bearer <token>`

The token Refapp issued for your account. It identifies the account, so nothing else is needed.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectId` | string | yes | The `candidate.job.id` you submitted. |
| `candidateId` | string | yes | The `candidate.id` you submitted. |

## Responses

### 200 (application/json)

The candidate's current results.

- `type`, string, required: Always `"partner-results"`
- `id`, string, required
- `attributes`, object, required
  - `status`, string, required: One of `"sending"`, `"sent"`, `"pending"`, `"completed"`, `"failed"`
  - `summary`, string, required
  - `url`, string
  - `candidateLink`, object
    - `url`, string, required
    - `description`, string, required
    - `type`, string: One of `"report-url"`, `"report-pdf-data"`, `"candidate-url"`
  - `candidateSubmissionPageLink`, object
    - `url`, string, required
    - `description`, string, required
    - `type`, string: One of `"report-url"`, `"report-pdf-data"`, `"candidate-url"`
  - `assessment`, object
    - `type`, string: Always `"reference-check"`
    - `score`, number
    - `total`, number
    - `remainingToSubmit`, number
    - `completed`, number
    - `declined`, number
    - `fraudWarnings`, array of string
  - `attachments`, array of object
    - `url`, string, required
    - `description`, string, required
    - `type`, string: One of `"report-url"`, `"report-pdf-data"`, `"candidate-url"`
  - `criteria`, object: Values to route the candidate on, keyed by criterion id. `moving_criteria` in `GET /webhooks/account-integration/config` is the source of truth for the criteria and values that this account receives. This reference shows only the criteria and values that exist today. A criterion is left out until it has a value. Criteria and values can be added or removed at any time. Refapp avoids breaking changes, so a new criterion or value is more likely than a removed one or a changed value type. Ignore ids and values that you do not know.
    - `background_check_outcome`, string: Where the background check stands. `anomalies_*` once it found anomalies: pending until a reviewer approves or rejects them. `declined` when the candidate declined. More values can be added.. One of `"in_progress"`, `"clear"`, `"anomalies_pending_review"`, `"anomalies_approved"`, `"anomalies_rejected"`, `"declined"`
    - `reference_check_fraud`, string: `warning` while a fraud warning is active on the candidate. More values can be added.. One of `"positive"`, `"warning"`
    - `reference_check_referees_overdue`, string: `overdue` once the deadline for adding referees has passed and the candidate has not added all requested referees. More values can be added.. One of `"overdue"`, `"not_overdue"`
    - `reference_check_behaviours`, string: `warning` when a behavioural trait fell outside the target range, `insufficient` when too few referees answered to compare against the benchmark. More values can be added.. One of `"positive"`, `"warning"`, `"insufficient"`
    - `reference_check_cwb`, string: `warning` when a referee reported a counterproductive work behaviour. More values can be added.. One of `"positive"`, `"warning"`
    - `reference_check_recommendation`, number: How strongly the referees recommend the candidate, in percent.. `minimum: 0`. `maximum: 100`
    - `(any other key)`, string | number
  - `details`, object: Text in the account's language to show to a recruiter. The keys are names and labels, which can change. Routing rules must use `criteria`, not `details`.
    - `(any other key)`, string | object
      - `Alternative 1`, string
      - `Alternative 2`, object
        - `(any other key)`, string

### 401 (application/json)

The token is missing, unknown, revoked, or the integration is not enabled for the account. All four look the same.

- `error`, object, required
  - `code`, string, required: One of `"unauthorized"`, `"not-found"`
  - `message`, string, required

### 404 (application/json)

No such project and candidate pair within your account. Another account's candidate answers the same way.

- `error`, object, required
  - `code`, string, required: One of `"unauthorized"`, `"not-found"`
  - `message`, string, required
