Sending a Candidate In

This route accepts a POST request consisting of a JSON payload and some authentication Headers. The response will consist of a success flag and either a transaction ID (success) or an error.

POST https://candidatehub.adcourier.com/candidate

Authentication is required for all requests to Candidate Hub. Authentication is sent via request headers in the following format. Note: Signatures are valid for 5 mins, please ensure your system clock time is accurate.

HEADERS:

'X-CHUB-SIGNATURE-TIME: 1577965016
'X-CHUB-SOURCE: board1
'X-CHUB-SIGNATURE: c57ed8130b75a69458416e9e91ac0baef604f8fce3bf1d7cf5bcb03d13af2765

Example of creating X-CHUB-SIGNATURE Header:

1. Obtain secret from Veritone Hire. eg: secret
2. Obtain source ID from Veritone Hire. eg: board1
3. Generate an EPOCH Time. eg: 1577965016 (Thursday, 2 January 2020 11:36:56)
4. Concatenate Source ID and EPOCH Time, separated by a pipe. eg: board1|1577965016
5. HMAC-SHA256 encode the concatenated string with the secret from Veritone Hire.

Example using Bash and OpenSSL:

# Usage: echo -n {SOURCE_ID}|{SIGNATURE_TIME_EPOCH} | openssl dgst -sha256 -hmac {secret}

echo -n 'board1|1577965016' | openssl dgst -sha256 -hmac secret

# Output: (stdin)= c57ed8130b75a69458416e9e91ac0baef604f8fce3bf1d7cf5bcb03d13af2765

{
    "transaction": {
        "client_id": "123",
        "source_id": "native"
    },
    "candidate": {
        "name": "John Doe",
        "email": "tronan@applicant.com",
        "contact_telephone": "5555555555",
        "mobile_telephone": "5555555555",
        "location_city": "Austin, TX",
        "location_country": "US",
        "location_postcode": "78758",
        "location_latitude": "51.803398",
        "location_longitude": "-0.564736",
        "current_job_title": "Customer Success Manager",
        "current_job_employer": "CircleBack Inc",
        "current_job_startdate": "2013-07-01T12:00:00",
        "documents": [
            {
                "filename": "John_Doe.pdf",
                "type": "cv",
                "content": ""
            },
            {
                "filename": "cover_letter.pdf",
                "type": "coverletter",
                "content": ""
            }
        ]
    },
    "context": {
        "job_id": "123345",
        "shortlist_id": "869",
        "aplitrak_email_address": "cons.4567.312@dev.aplitrak.com"
    }
}

{
   "success": 1,
   "hub_transaction_id": "guid"
}

{
   "success": 0,
   "error": "clientId not known"
}