Skip to content
/
Create a new Adverse Acti...

Create a new Adverse Action

Request

Creates a new Adverse Action.

Note: Report must be in a consider status and cannot have any existing Adverse Actions that have not been canceled.

Security
basic_auth
Path
report_idstringrequired

The ID of the Report for which the Adverse Action will be created.

Bodyapplication/jsonrequired
post_notice_scheduled_atstring, (date-time)

Time at which the Post-Adverse Action notification will be sent. Default is 7 days after creation.

Example:"2016-10-07T12:34:00Z"
adverse_item_idsArray of stringsrequired

IDs of Adverse Items selected for the Adverse Action.

contextstring or null

A customizable, semi-unique scoping identifier. Adverse Actions with a context have some special behaviors that do not affect the report adjudication and are not affected by most report adjudication actions. Multiple Adverse Actions can exist for a report as long as the context is unique for the report. Defaults to null.

Example:"context-1"
mediumobject

The medium through which the Adverse Action notification should be sent.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{report_id}/adverse_actions' \
  -H 'Content-Type: application/json' \
  -d '{
    "post_notice_scheduled_at": "2016-10-07T12:34:00Z",
    "adverse_item_ids": [
      "string"
    ],
    "context": "context-1",
    "medium": {
      "email": {
        "priority": 1,
        "required": true
      },
      "postal": {
        "priority": 0,
        "required": false
      }
    }
  }'

Responses

Adverse Action was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"adverse_action"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/adverse_actions/57ed51e57619e8002a6683f2"
created_atstring, (date-time)

Time at which the Adverse Action was created.

Example:"2016-09-29T17:39:49Z"
deliveryobject

Details about the delivery state of the Adverse Action.

statusstring

Status of the Adverse Action.

Enum:"pending""complete""dispute""canceled"
Example:"pending"
report_idstring

ID of the Report causing this adverse action.

Example:"b861a56db1b1b89692dd6118"
post_notice_scheduled_atstring or null, (date-time)

Timestamp at which the post Adverse Action notification will be sent. This time is dependent on the time at which the Pre-Adverse Action was created, and related settings within your Checkr system.

Example:"2016-10-07T12:34:00Z"
post_notice_ready_atstring, (date-time)

Timestamp after which the post notice can be sent. (Often 7 days after created_at.)

Example:"2016-10-06T17:39:48Z"
canceled_atstring or null, (date-time)

Time at which the Adverse Action was canceled.

Example:null
adverse_itemsArray of objects(AdverseItem)

Array of Adverse Items on which the Action is based.

individualized_assessment_engagedboolean
Default:false
contextstring or null

A customizable. semi-unique scoping identifier. Adverse Actions with a context have some special behaviors that do not affect the report adjudication and are not affected by most report adjudication actions. Multiple Adverse Actions can exist for a report as long as the context is unique for the report. Defaults to null.

Example:null
eventsArray of objects

A list of important lifecycle events.

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "adverse_action",
  "uri": "/v1/adverse_actions/57ed51e57619e8002a6683f2",
  "created_at": "2016-09-29T17:39:49Z",
  "delivery": {
    "state": "delivered",
    "reason": "The email account that you tried to reach does not exist. Please double-check the recipient's email address for typos or unnecessary spaces.",
    "updated_at": "2016-09-29T17:39:49Z"
  },
  "status": "pending",
  "report_id": "b861a56db1b1b89692dd6118",
  "post_notice_scheduled_at": "2016-10-07T12:34:00Z",
  "post_notice_ready_at": "2016-10-06T17:39:48Z",
  "canceled_at": null,
  "adverse_items": [
    { … }
  ],
  "individualized_assessment_engaged": false,
  "context": null,
  "events": [
    { … }
  ]
}
© Checkr, Inc.