Sign in

v1

latestOpenAPI 3.0.32026-07-14265579.8 KB
Order

Place an 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.

post/order

Request body

packageType'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY' 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'EXPRESS' | 'INTERACTIVE' 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.

candidateIdstring 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.

copyOfReportboolean

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

requestorstring

A client email address that is linked to a package.

region2string

field used for County for US orders

referenceCodesstring[]

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

clientCommentsstring

Any comments on the order

Example request

{
  "candidateId": "56eb1389a78e5bf65e414cfc",
  "jobLocation": {
    "country": "US",
    "region": "CA",
    "region2": "Orange",
    "city": "Irvine"
  },
  "additionalProductTypes": [
    {
      "productType": "TERB"
    }
  ],
  "complianceTokens": {
    "companyName": "Accurate",
    "companyAddress": "200 Spectrum Ctr",
    "companyCity": "Irvine",
    "companyRegion": "CA",
    "companyCountry": "US",
    "companyEmail": "elmer@wb.com"
  }
}

Response

Success Response

resourcestring
idstring
createdstring date-time
updatedstring date-time
maskedboolean
packageType'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY'
workflow'EXPRESS' | 'INTERACTIVE'
copyOfReportboolean
clientCommentsstring
referenceCodesstring[]
candidateIdstring
candidateInfoCompleteboolean
statusstring
resultstring
percentageCompleteinteger
candidateInfoChangedboolean
sourcestring
searchIdinteger
subjectIdinteger
submittedstring date-time
supportReferenceIdstring

Example response

{
  "clientComments": "Client comments",
  "complianceTokens": {
    "companyName": "Accurate",
    "companyAddress": "200 Spectrum Ctr",
    "companyCity": "Irvine",
    "companyRegion": "CA",
    "companyCountry": "US",
    "companyEmail": "elmer@wb.com"
  },
  "jobLocation": {
    "country": "US",
    "region": "CA",
    "region2": "Orange",
    "city": "Irvine"
  },
  "candidateId": "56eb1389a78e5bf65e414cfc",
  "candidate": {
    "firstName": "Elmer",
    "lastName": "Fudd",
    "middleName": "Fiddlesticks",
    "suffix": "Jr",
    "dateOfBirth": "1945-01-01T00:00:00.000Z",
    "email": "Elmer@wb.com",
    "address": "123 Silly Street",
    "city": "Lousville",
    "region": "KY",
    "country": "US",
    "governmentId": {
      "country": "US",
      "type": "SpyCard",
      "number": "ABC12345"
    }
  },
  "status": "RECEIVED",
  "result": "PENDING",
  "reports": [
    {
      "base64encodedHTML": "/report/572d0904f1b9a4602bc83a09"
    }
  ],
  "additionalProductTypes": [
    {
      "productType": "TERB"
    }
  ],
  "documents": [
    {
      "documentId": "602ad78042dcb1000c24c7a7",
      "documentUrl": "/order/602ad1744b9ccf1bbb4fa292/document/602ad78042dcb1000c24c7a7",
      "documentName": "Addtl doc.jpg",
      "externalDocumentId": "602ad780a424f6000bf08b59"
    }
  ],
  "percentageComplete": 50,
  "source": "INTEGRATION::API-V3",
  "searchId": 197111504,
  "subjectId": 25600748
}