Changing
kycStatus through this API triggers the Updated webhook. The approved / rejected webhooks are not sent; the new status is delivered as a string in data.kyc_result. The same applies when a submission is edited from the dashboard.1. Endpoint
2. Authentication
Include the API key in the “x-api-key” header:x-api-key
3. Request Body
The request body must be in JSON format. Below are the field descriptions: Add commentMore actions4. Request Example
5. Response
5-1. Success Response
result.json
5-2. Error Response
If an error occurs, a400 status code is returned with details in the response body:
error.json
5-3. Error Codes
6. Encryption Options
For enhanced security, the request body can be encrypted. Encrypt the entire request body object and put the resulting string into the HTTP request body as is. Do not wrap it in a JSON object or adata field, and do not URL-encode it.
For POST and PATCH, send the ciphertext in the request body as a raw base64 string. For GET, URL-encode the ciphertext and pass it as the
data query parameter. For the encryption method, see API Request Data Encryption (AES-256-ECB).6-1. Encrypted Request Example
patch-encrypted.py
6-2. Encrypted Response
The response will include theisEncrypted flag and encrypted data:
result.json
Related documents
Getting Started
The ID check API is a solution designed to help enterprise clients manage KYC (Know Your Customer) and AML (Anti-Money Laundering) processes more systematically and efficiently. This API supports seamless integration with existing systems and provides features to securely handle and manage user data.
GET/Submission Response Fields
Detailed definitions of all fields included in GET/Submission API responses
Overview
Monitor ARGOS ID check’s KYC process status changes in real-time. Receive instant updates through webhooks.