Aiviue Partner API
Build hiring into your platform
A REST API for HCM and ATS partners: publish jobs on behalf of your customers and get back AI-screened, ranked candidates and hiring events.
How it works
- 1
Publish jobs
Create jobs for each of your customers (tenants) from your HCM or ATS.
- 2
Aiviue screens candidates
Applicants are screened by Aivi on WhatsApp and voice, in their own language.
- 3
Receive results
Get screened candidates, scores and status changes by webhook or by polling the API.
Guides
Authentication
OAuth 2.0 client credentials, test and live secrets, and scopes.
Tenants
How your customers map to Aiviue tenants and the X-Tenant-ID header.
Idempotency
Retry write requests safely with X-Idempotency-Key.
Webhooks
Subscribe to hiring events, verify signatures and handle retries.
Errors and rate limits
Error format, status codes and request limits.
Sandbox
Build and test end to end against the partner test environment.
Versioning and changelog
How the Partner API is versioned and how changes are announced.
For AI agents and tools
Every guide is also available as plain markdown. Point your coding assistant at llms-full.txt or import the OpenAPI spec into Postman, Insomnia or a client generator.
Need credentials or help? Email partners@aiviue.com.