API Documentation

The AIVENTURA REST API lets you programmatically create verification requests, manage candidates, receive webhook events, and integrate with your ATS or HRIS.

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Generate API keys from Settings → Developers in your AIVENTURA dashboard. Use separate keys for sandbox and production environments.

Base URL

https://api.aiventura.com/v1

Sandbox: https://sandbox.api.aiventura.com/v1

Core Endpoints

Create verification

POST /verifications

Create a new background verification request for a candidate. Returns a verification ID and status URL.

Get verification status

GET /verifications/{id}

Retrieve the current status, completed checks, and report download link when available.

List candidates

GET /candidates

Paginated list of candidates with optional filters by status, date range, and package type.

Webhooks

Subscribe to verification.completed, verification.failed, and consent.received events. See the Webhook Integration Guide for setup details.

Rate Limits

Production: 100 requests/minute per API key. Contact sales for higher limits.

SDKs

Official SDKs are available for Node.js, Python, and Java. Community SDKs for PHP and Go are listed in the integration playbook.

Our solutions team is here to help

API setupATS integrationEnterprise deployment