Authentication
Authenticate your HRMS, ATS, or custom application with the People Index API using Bearer tokens and API keys.
API Keys
Every API request must be authenticated using an API key. You can create and manage API keys in the Developer Settings of your portal.
To authenticate, provide your secret key via the Authorization header in your HTTP requests.
HTTP Header
Authorization: Bearer idx_test_51Lx98472948274...OAuth2 for Enterprise HRMS
If you are building an integration for a commercial HRMS (like BambooHR or SuccessFactors) to be listed in their app marketplaces, you must use our OAuth2 flow to act on behalf of mutual customers.
- Authorization URL:
https://auth.peopleindex.ai/oauth/authorize - Token URL:
https://api.peopleindex.ai/oauth/token
Required Scopes
| Scope | Description |
|---|---|
| credentials:write | Allows your integration to issue employment credentials. |
| assessments:read | Allows your integration to read candidate trust assessment reports. |
| graph:read | Grants access to traverse the identity trust graph. |