KYB Verification Links
Операций: 6
ApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
page?integerPage (1-based)
page_size?integerPage size (1-100)
status?stringFilter by status (active, consumed, revoked)
external_user_id?stringFilter by external user ID
external_reference?stringFilter by external reference
flow_id?stringFilter by flow UUID
sort_by?stringSort field (default created_at)
sort_order?stringSort order: asc, desc (default desc)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification links
*/*- response
data?success?booleancurl -X GET 'https://api.onekyc.io/tenant/v1/kyb/verification-links' \ -H 'X-Timestamp: string'{ "success": true, "data": { "items": [ { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" } ], "pagination": { "page": 0, "page_size": 0, "total": 0, "total_pages": 0 } }}ApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Link options (flow_id required)
application/json- body
expires_in?integerseconds
external_reference?stringexternal_user_id?stringflow_id?stringlocale?stringmetadata?prefilled?redirect_url?stringutm_campaign?stringutm_medium?stringutm_source?stringCreated or reused link
application/json- response
data?success?booleancurl -X POST 'https://api.onekyc.io/tenant/v1/kyb/verification-links' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'{ "success": true, "data": { "created_at": "string", "delivery_eligible": true, "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "id": "string", "link_url": "string", "locale": "string", "qr_code_url": "string", "redirect_url": "string", "reuse_reason": "external_reference", "reused": true, "session_id": "string", "session_resumable": true, "session_status": "string", "short_url": "string", "status": "string", "url": "string", "verification_link": "string", "verification_url": "string" }}ApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Verification link details
*/*- response
data?success?booleancurl -X GET 'https://api.onekyc.io/tenant/v1/kyb/verification-links/string' \ -H 'X-Timestamp: string'{ "success": true, "data": { "activated_at": "string", "consumed_at": "string", "created_at": "string", "created_by": "string", "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "flow_session_id": "string", "id": "string", "locale": "string", "metadata": { "property1": null, "property2": null }, "prefilled_data": { "property1": null, "property2": null }, "redirect_url": "string", "revoked_at": "string", "revoked_reason": "string", "short_code": "string", "status": "string", "token": "string", "updated_at": "string", "utm_campaign": "string", "utm_medium": "string", "utm_source": "string" }}ApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
size?integerQR size in pixels (1-1024, default 256)
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
PNG image
response?unknownimage/pngcurl -X GET 'https://api.onekyc.io/tenant/v1/kyb/verification-links/string/qr' \ -H 'X-Timestamp: string'nullApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
id*stringLink UUID
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Optional revoke reason
application/json- body
reason?stringRevoked link info
application/json- response
data?success?booleancurl -X POST 'https://api.onekyc.io/tenant/v1/kyb/verification-links/string/revoke' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'{ "success": true, "data": { "id": "string", "revoked_at": "string", "status": "string" }}ApiKeyAuthAuthorization<token>HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.
X-Timestamp*stringUnix timestamp (seconds, max 5 min drift)
Batch create request
application/json- body
defaults?items?array<>Created links
application/json- response
data?success?booleancurl -X POST 'https://api.onekyc.io/tenant/v1/kyb/verification-links/batch' \ -H 'X-Timestamp: string' \ -H 'Content-Type: application/json' \ -d '{}'{ "success": true, "data": { "failed": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "created_at": "string", "delivery_eligible": true, "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "id": "string", "link_url": "string", "locale": "string", "qr_code_url": "string", "redirect_url": "string", "reuse_reason": "external_reference", "reused": true, "session_id": "string", "session_resumable": true, "session_status": "string", "short_url": "string", "status": "string", "url": "string", "verification_link": "string", "verification_url": "string" } } ], "successful": [ { "error": "string", "error_code": "string", "existing_session_id": "string", "index": 0, "link": { "created_at": "string", "delivery_eligible": true, "expires_at": "string", "external_reference": "string", "external_user_id": "string", "flow_id": "string", "id": "string", "link_url": "string", "locale": "string", "qr_code_url": "string", "redirect_url": "string", "reuse_reason": "external_reference", "reused": true, "session_id": "string", "session_resumable": true, "session_status": "string", "short_url": "string", "status": "string", "url": "string", "verification_link": "string", "verification_url": "string" } } ], "summary": { "failed": 0, "successful": 0, "total": 0 } }}