API Documentation

Integrate Indicia HR screening services into your applications with our REST API.

API Overview

Everything you need to integrate with Indicia HR programmatically.

Authentication

Secure API access using API keys and OAuth 2.0 tokens for all requests.

Screening

Initiate and manage background screenings, identity checks, and verifications.

Candidates

Create, update, and retrieve candidate profiles and screening results.

Webhooks

Receive real-time notifications when screening statuses change.

API Endpoints

Core endpoints available in the Indicia HR API.

Authentication

POST /api/v1/auth/token Generate access token

Screenings

POST /api/v1/screenings Create a new screening
GET /api/v1/screenings/{id} Get screening details
GET /api/v1/screenings List all screenings

Candidates

POST /api/v1/candidates Create a candidate
GET /api/v1/candidates/{id} Get candidate details
PUT /api/v1/candidates/{id} Update candidate info

Webhooks

POST /api/v1/webhooks Register a webhook
DELETE /api/v1/webhooks/{id} Remove a webhook