Place an Order.

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

The 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, and include the Candidate resource ID in the URL and POST parameters to specify your desired Package and Workflow.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

packageType

string

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.

workflow

string

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.

candidateId

string

required

Describes the candidate for which the order is being placed; This ID is returned by the API in the Create Candidate API call described above.

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

Reference codes. Array of strings, support up to a maximum of 4 elements. Zero based index.

referenceCodes

additionalProductTypes

array of objects

length ≤ 4

Choose any number of additional searches and serch 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

Responses

Response body

object

resource

string

created

date-time

updated

date-time

masked

boolean

packageType

string

PKG_BASIC PKG_STANDARD PKG_PRO PKG_EMPTY

workflow

string

EXPRESS INTERACTIVE

copyOfReport

boolean

clientComments

string

complianceTokens

object

companyName

string

name of company for End User Company

companyAddress

string

Street Address for End User Company

companyCity

string

City for End User Company

companyRegion

string

Region for End User Company

companyCountry

string

Country for End User Company

companyPostalCode

string

Postal Code for End User Company

companyPhone

string

Phone Number for End User Company

companyEmail

string

Email for End User Company

jobLocation

object

country

string

Country of job location. Accurate Background uses ISO 3166 Country Codes.

region

string

Region/State of job location. For US must provide state code.

region2

string

Required for US – County must exist within the state passed

city

string

City of job location

referenceCodes

array of strings

referenceCodes

candidateId

string

candidate

object

firstName

string

lastName

string

middleName

string

suffix

string

dateOfBirth

date

ssn

string

phone

string

address

string

city

string

region

string

country

string

postalCode

string

governmentId

object

aliases

array of objects

aliases

object

firstName

string

lastName

string

middleName

string

educations

array of objects

educations

object

school

string

Required for EDU product only in Express workflow; School candidate attended. Only required if education information is entered.

country

string

Required for EDU product only in Express workflow; Country code of school. Only required if education information is entered. Accurate Background uses ISO 3166 Country Codes.

region

string

Required for EDU product only in Express workflow; State of school. Only required if education information is entered.

city

string

Required for EDU product only in Express workflow; City of school. Only required if education information is entered.

degree

string

Required for EDU product only in Express workflow; Candidate’s degree at school

major

string

Required for EDU product only in Express workflow; Candidate’s major at school

startDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, start date candidate attended school. Only required if education information is entered.

endDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, end date candidate finished school. Only required if education information is entered.

graduated

string

Required for EDU product only in Express workflow; Has the candidate graduated?

graduationDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, graduation date

presentlyEnrolled

string

Required for EDU product only in Express workflow; Is the candidate currently in school? PresentlyEnrolled will default as "false" when no value is provided

prevEmployed

boolean

employments

array of objects

employments

object

employer

string

Required for EMP product only in Express workflow, Name of company candidate was previously employed. Only required if PrevEmployed is “true”.

country

string

Required for EMP product only in Express workflow, Country code of company. Only required if employment information is entered. Accurate Background uses ISO 3166 Country Codes.

region

string

state of company. Only required if employment information is entered.

city

string

Required for EMP product only in Express workflow; State of company. Only required if employment information is entered.

startDate

string

Required for EMP product only in Express workflow; In the format: yyyy-mm, start date at company. Only required if employment information is entered.

endDate

string

Required for EMP product only in Express workflow; In the format: yyyy-mm, end date at company. Only required if employment information is entered.

presentlyEmployed

string

Required for EMP product only in Express workflow; Is this the candidate’s current employer? presentlyEmployed will default as “false” when no value is provided

position

string

Required for EMP product only in Express workflow; Position at company

supervisor

string

Required for EMP product only in Express workflow; Supervisor at company

reasonForLeaving

string

Required for EMP product only in Express workflow; Reason for leaving company

okToCall

string

Required for EMP product only in Express workflow; Is it ok to contact the employer? okToCall will default as “true” when no value is provided

phone

string

Required for EMP product only in Express workflow; Employer’s phone number

salary

string

Required for EMP product only in Express workflow; Salary at company

contactEmail

string

Email of contact for employment verification. Required for Email Verification product.

contactTitle

string

Title of contact for employment verification. Required for Email Verification product.

contactPerson

string

Name of contact for employment verification. Required for Email Verification product.

licenses

array of objects

licenses

object

category

string

Required for MVR and PLV products only in Express workflow; Allowed values: drivers-license , professional-license. Only required if license information is entered

type

string

Required for MVR and PLV products only in Express workflow; Type of license (*only required for category professional-license)

number

string

Required for MVR and PLV products only in Express workflow; License number

issuingAuthority

string

Not required when category is drivers-license

country

string

Required for MVR and PLV products only in Express workflow;

region

string

Required for MVR and PLV products only in Express workflow; State of license

city

string

Not required when category is drivers-license or professional-license

convicted

boolean

Must be configured by reaching out to apisupport@accuratebackground.com; Has candidate been convicted?

convictions

array of objects

convictions

object

convictionDate

date

Must be configured by reaching out to apisupport@accuratebackground.com; Date of conviction, in format: YYYY-MM-DD. Only required if convicted is true.

description

string

Must be configured by reaching out to apisupport@accuratebackground.com; Details of conviction

country

string

Must be configured by reaching out to apisupport@accuratebackground.com; Country code of conviction. Only required if convicted is true.

region

string

Must be configured by reaching out to apisupport@accuratebackground.com; State of conviction

region2

string

Must be configured by reaching out to apisupport@accuratebackground.com; County of conviction

city

string

Must be configured by reaching out to apisupport@accuratebackground.com; City of conviction

references

array of objects

references

object

name

string

Required for REF1 product only in Express workflow; Full name of reference. Only required if reference information is entered.

relationship

string

Required for REF1 product only in Express workflow; Type of relationship to reference. Only required if reference information is entered.

phone

string

Required for REF1 product only in Express workflow; Phone number of reference. Only required if reference information is entered.

string

Required for REF1 product only in Express workflow; Email of reference

country

string

Required for REF1 product only in Express workflow; Country code of reference

region

string

Required for REF1 product only in Express workflow; State of reference

city

string

Required for REF1 product only in Express workflow; City of reference

postalCode

string

Required for REF1 product only in Express workflow; Postal code of reference

addressHistory

array of objects

addressHistory

object

address

string

Required only for Express workflow of non-US orders. Address of current or previous residence.

address2

string

Address detail of current or previous residence like suite, apartment or room number.

city

string

Required only for Express workflow of non-US orders. City of current or previous residence.

region

string

Required for all workflows of non-US orders. Can be State or Province of current or previous residence.

postalCode

string

Required only for Express workflow of non-US orders. Postal code of current or previous residence

country

string

Required for all workflows of non-US orders. Country of current or previous residence. Uses ISO 3166 Country Codes.

fromDate

date

Required only for Express workflow of non-US orders. Date when current or previous residency began (yyyy-mm-dd).

toDate

date

Required only for Express workflow of non-US orders. Date when current or previous residency ended (yyyy-mm-dd).

candidateInfoComplete

boolean

status

string

result

string

reports

array of objects

reports

object

base64encodedHTML

string

additionalProductTypes

array of objects

additionalProductTypes

object

productType

string

documents

array of objects

documents

object

documentId

string

documentUrl

string

documentName

string

externalDocumentId

string

percentageComplete

integer

candidateInfoChanged

boolean

source

string

searchId

integer

subjectId

integer

submitted

date-time

supportReferenceId

string

Language

Credentials

Basic

base64


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.accuratebackground.com/v3/order \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "packageType": "PKG_BASIC",
8
  "workflow": "EXPRESS"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success Response

400Bad Request

401Unauthorized Response

500Internal Server error