Skip to main content

​
SearchTypeDto Schema

The SearchTypeDto defines the type of verification search to perform.

​
Supported Fields

FieldRequiredTypeRules and behavior
searchTypeYesEMPLOYMENT or EDUCATIONType of search to perform. CRIMINAL and REFERENCE are not accepted.
externalSearchIdNostringClient correlation ID for this search. Useful for webhook idempotency and internal reconciliation.
questionnaireUrlNostringOptional direct link to the online questionnaire for this search.
questionnaireAccessCodeNostringOptional access code required for the online questionnaire.
searchConfigNoobjectPer-search policy overrides. When present, even as {}, it fully replaces request-level defaultSearchConfig for this search. See SearchConfigDto.

​
Search Type Options

ValueVerifies
EMPLOYMENTEmployment history, job titles, dates of employment, and salary information.
EDUCATIONEducational credentials, degrees, graduation dates, and academic achievements.

​
Complete Example

{
  "searchType": "EMPLOYMENT"
}

​
Multiple Search Types

You can request multiple verification types in a single order: 
[
  {
    "searchType": "EMPLOYMENT",
    "externalSearchId": "client-emp-001",
    "searchConfig": {
      "thirdPartyBan": ["TALX_WORK_NUMBER"]
    }
  },
  {
    "searchType": "EDUCATION",
    "externalSearchId": "client-edu-001",
    "searchConfig": {
      "thirdPartyBan": ["NSCH"]
    }
  }
]

​
Validation Rules

  • Enum Validation: searchType must be EMPLOYMENT or EDUCATION.
  • searchConfig: if present (even as {}) it fully replaces any request-level defaultSearchConfig for this search.
  • thirdPartyBan: when set inside searchConfig, values must be canonical vendor codes. See Third-party ban.