Practical guides for a confident integration.
API reference
REST · OpenAPI 3.1 · X-API-Key
OpenAPI / Swagger
Explore the contract without executing requests.
KYC API: from identity checks to results
Understand KYC integration architecture, the hosted journey, events and your application’s responsibilities.
Integrate your first KYC journey
Create a transaction on your server, hand over the hosted journey and read its result using KYC API examples.
Integrate KYC with your AI agent
Prepare your KYC integration with prompts, public context, eight languages and MCP documentation.
Authentication and API key protection
Use X-API-Key on your backend, isolate Tenant and environment access and prepare KYC credential rotation.
KYC environments and integration configuration
Separate credentials, URLs, callbacks and data by environment without confusing local examples with operational services.
Create an identity verification transaction
Understand creation fields, correlation identifiers and the KYC API’s 201 response.
Hand the person over to the hosted journey
Use the KYC API’s returned links, protect privacy and track the journey through your backend.
Interpret KYC results, decisions and status
Distinguish operational stages from decisions and handle pending, approved, rejected, expired and manual-review cases.
Idempotency: retry creation without duplicating a transaction
Use Idempotency-Key to repeat the same POST and handle payload conflicts without duplicate transactions.
Receive webhooks and track KYC events
Configure callbacks, verify signatures, deduplicate by event_id and read current transaction state.
Verify webhook HMAC signatures
Verify timestamp and HMAC SHA-256 over original bytes using TypeScript and Python examples with safe comparison.
Event redelivery, duplicates and reconciliation
Design a fault-tolerant consumer with event_id, durable persistence and current-state reconciliation through GET.
Authorized documents, assets and evidence downloads
Explore the four KYC file endpoints, document_download scope, IP authorization and personal-data safeguards.
KYC integration errors and troubleshooting
Identify validation, authentication, permission, transaction and idempotency failures without exposing personal data in logs.
Contract bounds and integration best practices
Apply documented field bounds, timeouts, controlled concurrency and data minimization in your KYC integration.
Go-live checklist for your KYC integration
Review access, webhook security, decision scenarios, recovery and data protection before launching your integration.
KYC public contract history and evolution
Track the public contract version and review examples, consumers and changes before updating your integration.
KYC API examples and integration downloads
Download OpenAPI and Postman resources and explore Node.js, TypeScript and Python creation examples without real credentials.
Explore the local KYC simulator
Learn to interpret synthetic KYC scenarios in your browser without credentials, uploads or real API calls.