Place an Order.

post

https://api.accuratebackground.com/v3/order

The Create Order resource represents your request to complete a background check
on a specific Candidate, with your choice of search package and perhaps
additional optional search products.

When you make the API call you will POST to the /order resource, with POST parameters to
specify your desired Package and Workflow.

For passing the candidate info, you can either:

Create a Candidate and supply the corresponding candidate id.
Or, supply the candidate data directly within the order submission request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Provide an existing candidate created via Candidate Creation.

Note: Alternatively, you can provide the candidate data directly via the
PROVIDE CANDIDATE DATA option.

candidateId

string

required

ID of the candidate created via Candidate Creation.

packageType

string

enum

required

Describes the package of searches to run in the order. We will provide the correct package type for this parameter if you move forward with the API.

Allowed:

workflow

string

enum

required

Options are EXPRESS and INTERACTIVE; In the EXPRESS workflow, the developer is responsible for providing all the required Candidate information in the Candidate resource. In the INTERACTIVE workflow, an email to a secure data collection form will be sent to the candidate to record their consent to the background check and all the required information necessary to conduct the checks.

Allowed:

jobLocation

object

required

copyOfReport

boolean

Describes if a copy of the completed report needs to be sent to the candidate.

requestor

string

A client email address that is linked to a package.

region2

string

field used for County for US orders

referenceCodes

array of strings

length ≤ 4

Reference codes to associate with the order. Also known as billing identifiers.

Array of strings, supports up to a maximum of 4 elements.

referenceCodes

additionalProductTypes

array of objects

Choose any number of additional searches and search options to run on the given Candidate.

This can include foreign country searches, extra drug screens, etc.

additionalProductTypes

clientComments

string

Any comments on the order

complianceTokens

object

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Success Response

400Bad Request

401Unauthorized Response

500Internal Server error