ACaccuratebackground
Order

Retrieve order resources

Changed on

Retrieve order resources is used to retrieve all orders filtered by parameters.

get/order

Request

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

Query parameters

firstNamestring

Returns orders matching this specific candidate name.

lastNamestring

Returns orders matching this specific candidate name.

middleNamestring

Returns orders matching this specific candidate name.

ssnstring

Returns orders matching the specific SSN.

status'COMPLETE' | 'PENDING' | 'INCOMPLETE'

Returns orders matching the specific status.

result'FAIL' | 'SUCCESS' | 'PENDING'

Returns orders matching the specific result.

packageType'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY'

Returns orders matching the specific result.

source'INTEGRATION::ADP' | 'INTEGRATION::API-V3' | 'INTEGRATION::AVATURE' | 'INTEGRATION::DAYFORCE_API' | 'INTEGRATION::GREENHOUSE_API' | 'INTEGRATION::ICIMS_API' | 'INTEGRATION::JAZZHR_API' | 'INTEGRATION::JOBVITE_API' | 'INTEGRATION::KENEXA-CS' | 'INTEGRATION::KIOSK' | 'INTEGRATION::KRONOS' | 'INTEGRATION::NP' | 'INTEGRATION::PAGEUP_API' | 'INTEGRATION::PEOPLESOFT' | 'INTEGRATION::SALESFORCE' | 'INTEGRATION::SMART_RECRUITERS_API' | 'INTEGRATION::STD-API' | 'INTEGRATION::SUCCESS_FACTORS_API' | 'INTEGRATION::SYMPLR_API' | 'INTEGRATION::TALEO-BE' | 'INTEGRATION::TALEO-EE' | 'INTEGRATION::ULTIPRO_API' | 'INTEGRATION::VERTAFORE_API' | 'INTEGRATION::WORKDAY_WWS' | 'WEB_UI::NP'

Returns orders matching the specific result.

createdstring
Example:2025-11-30

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
beginCreatedstring
Example:2025-11-30

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
endCreatedstring
Example:2025-11-30

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
beginCompletedstring
Example:2025-11-30

Orders completed after a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
endCompletedstring
Example:2025-11-30

Orders completed before a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
beginUpdatedstring
Example:2025-11-30

Orders updated after a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
endUpdatedstring
Example:2025-11-30

Orders updated before a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)

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
  }
]

Changes

  • 6c756a44350fRevision changes
    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter beginCompleted

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter beginCreated

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter beginUpdated

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter created

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter endCompleted

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter endCreated

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$ to the query request parameter endUpdated

    • info

      added the new enum value INTEGRATION::DAYFORCE_API to the query request parameter source

    • info

      added the new enum value INTEGRATION::GREENHOUSE_API to the query request parameter source

    • info

      added the new enum value INTEGRATION::JAZZHR_API to the query request parameter source

    • info

      added the new enum value INTEGRATION::SYMPLR_API to the query request parameter source

    • info

      added the new enum value INTEGRATION::VERTAFORE_API to the query request parameter source

    • info

      added the new enum value WEB_UI::NP to the query request parameter source

    • info

      for the query request parameter beginCompleted, the format was generalized from date-time to no format

    • info

      for the query request parameter beginCreated, the format was generalized from date-time to no format

    • info

      for the query request parameter beginUpdated, the format was generalized from date-time to no format

    • info

      for the query request parameter created, the format was generalized from date-time to no format

    • info

      for the query request parameter endCompleted, the format was generalized from date-time to no format

    • info

      for the query request parameter endCreated, the format was generalized from date-time to no format

    • info

      for the query request parameter endUpdated, the format was generalized from date-time to no format

    • info

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