v1

latestOpenAPI 3.0.32026-07-14265579.8 KB

Order

Retrieve order resource by id

Check on the status of an Order, and all the searches within that order.

get/order/{id}

Path parameters

idstring required

Order ID

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"
    }
  ],
  "products": [
    {
      "id": 53756466,
      "productType": "NCRIM",
      "status": "PENDING",
      "result": "PENDING"
    }
  ],
  "documents": [
    {
      "documentId": "602ad78042dcb1000c24c7a7",
      "documentUrl": "/order/602ad1744b9ccf1bbb4fa292/document/602ad78042dcb1000c24c7a7",
      "documentName": "Addtl doc.jpg",
      "externalDocumentId": "602ad780a424f6000bf08b59"
    }
  ],
  "percentageComplete": 50,
  "source": "INTEGRATION::API-V3",
  "searchId": 197111504,
  "subjectId": 25600748
}