Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.inklink.com/llms.txt

Use this file to discover all available pages before exploring further.

KYC inquiries verify a subject’s identity through a hosted flow with document capture and selfie checks.
For most integrations, the flow is simple: create an inquiry on your backend, send the user to https://idv.inklink.com?inquiry_id=<id>, then read status and inquiry_id on your return_url.
Create inquiries with your server-side api-key only. Do not expose the key in the browser or create inquiries from a public client.

​
Integration flow

1

Create an inquiry

Call POST https://platform.inklink.com/api/v1/kyc/inquiry from your backend with your org api-key. Send a minimal payload with subject_id (your stable user key), return_url, and level (1-3). See Quickstart and the API reference for the full payload.
2

Hosted verification

Open the user’s browser to:https://idv.inklink.com?inquiry_id=<id>Use the id from the create response as inquiry_id. The IDV app runs the document scan and selfie check.
3

Read the outcome on your return URL

When the hosted flow finishes, IDV redirects the user to your return_url with status and inquiry_id as query parameters.
For most integrations, those query parameters are enough. Call the result endpoint only if you need extra metadata such as timestamps.

​
Return URL and Result API

https://your-app.com/kyc/complete?status=approved&inquiry_id=kyc_iq_xxx

​
Verification levels

LevelWhat it enables
1Document scan + selfie
2Level 1 + address check
3Level 2 + PEP, AML, and adverse media screening (enabled together)
StatusMeaning
pendingVerification was created or is still in progress
manual_reviewAutomatic checks finished and the inquiry needs human review
approvedVerification passed
rejectedVerification did not pass
GET https://platform.inklink.com/api/v1/kyc/inquiry/<inquiry_id>/result returns fuller JSON with timestamps and other metadata. It does not include raw document images or evidence payloads; use the InkLink dashboard for detailed review.

​
Next steps

Quickstart

Create an inquiry, redirect to IDV, and handle the return URL.

API reference

Review the create inquiry request and response schema.

Error handling

Check common API and integration errors before going live.