This allows the user to be dropped into the Veritone Hire job board Search widget. The user will be dropped into the Veritone Hire Search product pre-authenticated as the Veritone Hire user and with access to all job board subscriptions configured for that Veritone Hire user.
Additionally, you can provide two optional URLs:
- Import candidate – A URL to send candidates from job boards in search you wish to save to your ATS.
- Shortlist values – This is used to provide name value pairs that will be included as a context when candidates are sent via Shortlist in Search.
Request
Method: POST
Endpoint:
https://beanwidget.adcourier.com/candidates/search
Content Type: application/json
Body:
Request Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | authentication | object | Y | ||
| 1.1 | api_key | string | Y | Unique API key for each client, supplied by Veritone Hire | |
| 1.2 | time | string | Y | epoch value (as string) | |
| 1.3 | signature | string | Y | SHA256/HMAC message digest encoded with shared secret key | |
| 2 | identification | object | Y | ||
| 2.1 | client_id | string | Y | AdCourier client id | |
| 2.2 | adc_username | string | Y | AdCourier (ADC) username | |
| 3 | transaction | object | |||
| 3.1 | custom_fields | array list | N | ||
| 3.1.1 | name | string | Y | ATS_Job_Id | |
| 3.1.2 | value | string | Y | A12345 | |
| 3.2 | config | object | |||
| 3.2.1 | shortlist | array | |||
| 3.2.1.1 | name | string | Shortlist_name | ||
| 3.2.1.2 | label | string | Label for button | ||
| 3.2.1.3 | url | string | URL providing name/value pairs | ||
| 3.2.2 | import_candidate_url | string | URL to send candidate data. |
Response Fields
| Level | Field | Type | Mandatory | Example Values | Notes |
|---|---|---|---|---|---|
| 1 | success | boolean | Y | 1 or 0 | |
| 2 | url | string | Y (In case of success) | iFrame Url for new managed response screen. | |
| 3 | error | string | Y (In case of error) | Error message |