Get a pre-adverse action

Request

Retrieves a single pre-adverse action record by ID.

Security

get-bearer-token-using-oauth2

Path

pre_adverse_action_idstring, (uuid)(uuid)required

The UUID of the pre-adverse action record.

Example:2b8313e8-4efd-45a1-b578-952b8313e890

GET

/regulated/pre_adverse_actions/{pre_adverse_action_id}

curl -i -X GET \
  https://api.checkrtrust.com/v1/regulated/pre_adverse_actions/2b8313e8-4efd-45a1-b578-952b8313e890 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

idstring, (uuid)(uuid)

A universally unique identifier (UUID) in standard format.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"

check_idstring, (uuid)(uuid)

The ID of the regulated check that produced the records for this pre-adverse action.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"

statusstring

The status associated with the pre-adverse action.

Example:"AdverseActionInitiated"

candidate_report_urlstring or null, (uri)

Subject-facing URL for viewing the background check report and responding to the notice. When a subject UI is configured this is a deep link keyed by the pre-adverse action id, gated by a one-time code sent to the subject's email so the customer cannot open it directly; you may still share it with the subject, and Checkr emails it to them unless suppress_notice is set. Where no subject UI is configured, this is a support mailto: link instead (no OTP gating).

Example:"https://subjects.checkrtrust.com/2b8313e8-4efd-45a1-b578-952b8313e890/review"

disqualifying_recordsArray of objects(disqualifying_record)

created_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

sent_atstring or null, (date-time)

Timestamp when the notice was delivered. Null until status is sent.

Example:"2024-06-01T14:00:00Z"

feedbackobject or null(pre_adverse_action_feedback)

Information provided by the subject in response to the pre-adverse action notice. Only populated after the subject has reviewed and responded to the notice.

dispute_filed_atstring or null, (date-time)

Timestamp when the subject filed a dispute. Null until a dispute is filed.

Example:"2024-06-05T09:30:00Z"

dispute_resolved_atstring or null, (date-time)

Timestamp when the dispute was resolved. Null until resolved.

Example:"2024-06-15T11:00:00Z"

Response

{
  "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "check_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "status": "AdverseActionInitiated",
  "candidate_report_url": "https://subjects.checkrtrust.com/2b8313e8-4efd-45a1-b578-952b8313e890/review",
  "disqualifying_records": [
    { … }
  ],
  "created_at": "2020-01-01T00:00:00Z",
  "sent_at": "2024-06-01T14:00:00Z",
  "feedback": {
    "user_provided_answer": "no",
    "contexts": [ … ],
    "disputes": [ … ],
    "pii": { … }
  },
  "dispute_filed_at": "2024-06-05T09:30:00Z",
  "dispute_resolved_at": "2024-06-15T11:00:00Z"
}