These docs are for v2.0. Click to read the latest docs for v3.0.

Customising and Embedding the Search UI

Affinda's Search Interface can be customised and embedded within recruitment platforms and job boards. A customised and signed URL is generated by our API which can then be added securely to your platform as an iFrame. Each URL is valid for 60 minutes.

Customisations

The following settings can be adjusted within the Search UI:

  • Indices to Search
  • Number of results displayed
  • Categories searched - select which out of Job Title, Location, Years of Experience, Occupation Group, Education, Skills, Languages, Management Level and Keywords are visible in the interface
  • Category weightings - change the weighting for each search category that is returned initially. Each category is weighted equally as default
  • Ability to download original candidate resumes
  • Theme / Styling (see below)

Styling

The default search UI theme can be set at the user level and can then be overridden within the API request.

Our team will assist in customising the theming so please send us a list of the fonts and colours required. Once completed, this will be applied to your account.

This themed tool is available when embedding the Search Interface within your platform.

Options for styling include:

**Colour palette

  • Light or dark mode
  • Background colour
  • Text colour
  • Primary colour (pink by default)
  • No match colour (red)
  • Partial Match colour (orange)
  • Info colour (blue)
  • Good Match colour (green)

Font settings

  • Font family (system font by default; can use any system font, Adobe Fonts, Google Fonts)
  • Base font size
  • Font weights (regular, medium, bold)

Border radius

  • Used for anything with rounded corners, eg. buttons, annotations, popovers

To update your default theme, contact our team.

Embedding the UI

Generating a URL to be embedded within your platform is a two-step process

  1. Configure your Search UI using either:
    1. Update the config for the logged-in user's embeddable resume search tool
    2. Update the config for the logged-in user's embeddable job description search tool
  2. Generate a URL using either:
    1. Create a signed URL for the embeddable resume search tool
    2. Create a signed URL for the embeddable job description search tool

Embedded URLs expire after 60 minutes. They will use the config settings at the time when they are generated. That means if you change the config, you need to generate a new URL for the changes to be effective.

Optionally, you can override the config directly when generating a URL by including configOverride in the body:

{
  "configOverride": {...}
}