Introduction
Broadbean facilitates the ability to pre-populate a client's applicant tracking systems apply form in order to reduce the drop off rate and improve ROI for your clients.
In order to utilise this, you will first need to contact our Integration team on 0800 169 3921 to discuss and be set up with the relevant technical information required to access the API. Please note, this feature is currently in BETA and you may be added to a waiting list for the required information.
Technical Overview
In order to import a candidate's profile, you must send a HTTP request at the time of apply to our Candidate Hub if it is enabled on the job. We can send you a flag per job during posting that you can store to identify jobs with this feature, or you can check at runtime whether the application URL resides on aplitrak.com. The Candidate Hub will respond with a Transaction ID and a URL for you to redirect the candidate to.
Please note, we recommend strict timeout settings on the API call to the Candidate Hub and if you are not presented with a Candidate Hub ID for any reason, the applicant workflow should remain uninterrupted without the pre-population feature being utilised.
Technical Specification
The route accepts a JSON package with configuration information, basic authentication and a base64 encoded package of raw candidate information. It responds with a simple binary indicating whether the package was accepted and the Candidate Hub Transaction ID and the application URL of the job.
The endpoint for the Candidate Hub is https://candidatehub.adcourier.com/candidates/prepopulator_receiver and requests should be sent via POST with a content type of application/json.
Example request
{
"transaction" : {
"source_id" : "native"
},
"candidates" : [
{
"data" : "base64Data", # Arbitrary candidate data as base64 string
"context" : {
"candidate_source_id" : "provided",
"job_id" : "12345",
"job_data" : {
"apply_url" : "https://aplitrak.com...",
"reference" : "",
"title" : "",
"description" : "",
"contract_type" : "",
"industry" : "",
"salary_per" : "hour|day|week|month|annum",
"salary_from" : "",
"salary_to" : "",
"salary_currency" : "GBP", #iso4217
"location" : ""
},
"consent_level" : "future_roles|role_only"
}
}
]
}
Candidate data should be sent as a base64 string, the candidate data should be structured like the below example:
{"candidate" : {
"name" : "John Renbourn",
"email" : "john@renbourn.com",
"contact_telephone" : "0123 456 7890",
"mobile_telephone" : "0123 456 7890",
"location_address" : "Address Details",
"location_city" : "Edinburgh",
"location_county" : "Leith",
"location_country" : "Scotland",
"location_postcode" : "EH6 4AU",
"location_longitude" : "-0.564736",
"location_latitude" : "51.803398",
"current_job_title" : "Guitar Maestro",
"current_job_employer" : "Broadbean Technology",
"current_job_startdate" : "1944-08-08T00:00:00",
"current_job_enddate" : "2015-03-26T00:00:00",
"documents" : [
{
"filename" : "blah.doc",
"type" : "cv",
"content" : "base64"
},
{
"filename" : "blah.json",
"type" : "parsed_cv",
"content" : "base64"
}
]
}
}
Response
{
"success": 1,
"message": "Data Received",
"hub_transaction_id": "1234566",
"url": "https://www.aplitrak.com/?adid=xyz&hub_transaction_id=1234566"
}
Please note, you will be provided with a candidate_source_id during onboarding with our Integration team. To get started, please call us on 0800 169 3921 to discuss.