Searching Custom Data

While Affinda returns a wide range of data from resumes as standard, often customers will have other additional data typically not found in these documents that they would like to include in search criteria. Examples of this may include salary expectations, availability, or recruiters' notes from interviews.

Affinda has functionality available for users to add custom data to candidate records and then to be able to search across this, either via API or through the Search UI.

Adding custom data

To be able to add custom data to a candidate, the data point needs to be first created for your Organization. Custom data points can be any of the following types:

  • Boolean (true / false)
  • Date
  • Number
  • String

To create these data points, get in touch with the Affinda team who will add the fields to your Organization.

Once created, custom data can be added by either:

  • Updating an existing candidate record (e.g. one that has been parsed using Affinda's Resume or Job Description Parser)
    • Simply add the custom field name to the API request and its corresponding value and the custom data will be added (E.g. "availabilityEndDate": "2022-12-31")
  • Creating a new candidate record using data(e.g. without parsing a document)

For more information, see Adding and Updating Candidates Directly.

Searching via API

Once added, the custom fields can then be easily searched via the API.

  • Use the standard search endpoint
  • Specifying the custom fields to search within the request, where:
    o "filterType" is either equals or range
    o "dataPoint" is the custom field name
    o "value" is the search criteria
    • If the filter type is range, the value can be expressed in the formats like the following:
      • {"gte": "2022-12-01", "lte": "2022-12-31"} – between 1-Dec-22 and 31-Dec-22
      • {"lte": "2022-12-31"} – before 31-Dec-22
      • {"gte": "2022-12-01"} – on or after 1-Dec-22

Searching via the Search UI

Custom fields can be searched through the Search UI by updating the embeddable URL configuration. For more information, see Customising and Embedding the Search UI.