Adverse Actions

Actions taken on a report due to findings that may disqualify the candidate.

See the Adverse Action section.

Create an Adverse Action

Create an adverse action on a report with the given ID.

During the creation of the adverse action, in the violations parameter the only required information is the description

The violations parameter is required in most scenarios.
For more details about this parameter and the adverse action process as a whole, check out the Adverse Action section.

SecurityApiKey
Request
path Parameters
reportId
required
string
Request Body schema: application/json
Array of objects
Responses
200

OK

401

Unauthorized

404

Not Found

422

Unprocessable Entity

post/reports/{reportId}/adverse_actions
Request samples
application/json
{ }
Response samples
application/json
{
  • "id": "string",
  • "status": "string",
  • "title": "string",
  • "text": "string",
  • "expires_at": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "violations": [
    ],
  • "comments": [
    ],
  • "applicant_first_name": "string",
  • "account_name": "string",
  • "logo": "string",
  • "styles": { }
}

Cancel an Adverse Action

Cancel an adverse action on a report with the given ID.
See the Adverse Action section.

SecurityApiKey
Request
path Parameters
adverse_action_id
required
string
Responses
200

OK

401

Unauthorized

404

Not Found

422

Unprocessable Entity

patch/adverse_actions/{adverse_action_id}/cancel
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "status": "string",
  • "title": "string",
  • "text": "string",
  • "expires_at": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "violations": [
    ],
  • "comments": [
    ],
  • "applicant_first_name": "string",
  • "account_name": "string",
  • "logo": "string",
  • "styles": { }
}
➔ Next to Account Custom Fields