​
API Key Authentication

This API uses API keys to authenticate requests. An API key is required for every API call. This document outlines how to obtain and use your API key.

​
Obtaining Your API Key

To obtain an API key, please contact our team directly. We will provide you with a unique API key for your application.

​
Using Your API Key

You must include your API key in the header of every API request. The header name is X-API-Key, and the value is your unique API key. Example Request (using curl): 
curl -X POST https://api.hiringbranch.com/connect/v1/assessment \
  -H 'X-API-Key: YOUR_API_KEY'
Header: 
X-API-Key: YOUR_API_KEY
Replace YOUR_API_KEY with the actual API key provided to you.
Important Security Notes
  • Keep your API key confidential. Do not share it publicly, including in code repositories, client-side code, or public forums.
  • Store your API key securely. Use environment variables or secure configuration files to store your API key, rather than embedding it directly in your code.
  • If you believe your API key has been compromised, contact us immediately to have it revoked and obtain a new one.
  • We may implement usage limits or other restrictions on API keys to ensure fair use and prevent abuse. We will communicate these limits to you.