Skip to main content
POST
/
kyc
/
inquiry
Create KYC inquiry
curl --request POST \
  --url https://platform.inklink.com/api/v1/kyc/inquiry \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "subject_id": "user_123",
  "return_url": "<string>",
  "level": 1,
  "features": {},
  "metadata": {}
}
'
{
  "id": "kyc_iq_xxx",
  "subject_id": "<string>",
  "features": {},
  "return_url": "<string>",
  "metadata": {},
  "expires_at": "2023-11-07T05:31:56Z",
  "level": 1,
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

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.

Headers

​
api-key
string
required
Example:

"secret_live_xxx"

Body

application/json
​
subject_id
string
required

Your stable identifier for the subject being verified.

Example:

"user_123"

​
return_url
string<uri>
required

URL where the user is redirected after the hosted IDV flow completes.

​
level
enum<integer>

Preset: 1 = document + selfie, 2 = + address, 3 = + PEP/AML/adverse media. Mutually exclusive with features.

Available options:
1,
2,
3
​
features
object

Feature map (doc_scan, selfie_scan, etc.). Mutually exclusive with level.

​
metadata
object

Response

200 - application/json

Inquiry created.

​
id
string
Example:

"kyc_iq_xxx"

​
subject_id
string
​
features
object
​
return_url
string
​
metadata
object
​
expires_at
string<date-time>
​
level
enum<integer> | null
Available options:
1,
2,
3
​
created_by
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time> | null