ACaccuratebackground
Order

Place an Order.

Changed on

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.
post/order

Request

  • Base URL
    https://api.accuratebackground.com/v3
  • URL
    https://api.accuratebackground.com/v3/order
  • Auth
    HTTP basic

Request body

OR

Example request

{
  "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"
  },
  "candidateId": "56eb1389a78e5bf65e414cfc"
}

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
}

Changes

  • 6c756a44350fRevision changes
    • breaking

      the / request property's minLength was increased from 0 to 2

    • breaking

      added the pattern ^[A-Z]{2}$ to the request property /

    • warning

      the / request property's maxLength was set to 100

    • warning

      the / request property's maxLength was set to 2

    • warning

      the / request property's maxLength was set to 100

    • warning

      removed the request property

    • info

      added subschema #1: PROVIDE CANDIDATE ID (CANDIDATE MUST ALREADY BE CREATED) subschema #2: PROVIDE CANDIDATE DATA (IF CANDIDATE NOT ALREADY CREATED) to the request body oneOf list

    • info

      the / response's property pattern ^[A-Z]{2}$ was added for the status