KYC Solution API Documentation
  1. Clients
KYC Solution API Documentation
  • 📘 Enum Reference
  • Clients
    • Create Client
      POST
    • Get Clients List
      GET
    • Get Client
      GET
  • Documents
    • Add Document
      POST
    • Add Document Attachment
      POST
    • Get Documents List
      GET
    • Get Document
      GET
    • View Document Attachment
      GET
  • Live Photos
    • Add Live Photo
      POST
    • Get Live Photos List
      GET
    • Get Live Photo
      GET
    • View Live Photo
      GET
  • Checks
    • Create Check Request
      POST
    • Get Check Result
      GET
    • Get Checks List
      GET
    • Get Client Latest Check
      GET
  1. Clients

Create Client

POST
/service/clients

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Body Params application/jsonRequired

Examples

Responses

🟢201201
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-sandbox.kycsolution.com/api/service/clients' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": 1,
    "email": "client1@comp1.com",
    "mobile": "+978338383883", //optional
    "external_id": "COMP_CLIENT_1",
    "person_details": {
        "first_name": "Client",
        "middle_name": "", //optional
        "last_name": "Kale",
        "dob": "1990-09-01", //optional
        "gender": 2, //optional
        "nationality": "IN", //optional
        "birth_country": "IN" //optional
    }
}'
Response Response Example
{
    "result": {
        "type": 1,
        "email": "client5@comp1.com",
        "mobile": "+978338383883",
        "external_id": "COMP_CLIENT_5",
        "company": {
            "id": 1
        },
        "id": "a6c82b30-aafc-4c5e-bbb0-811c983c7fb0",
        "created_at": "2025-06-12T14:30:04.166Z",
        "updated_at": "2025-06-12T14:30:04.166Z",
        "deleted_at": null,
        "person_details": {
            "first_name": "CLIENT",
            "middle_name": "",
            "last_name": "KALE",
            "dob": "1990-09-01",
            "gender": 1,
            "nationality": "GB",
            "birth_country": "GB",
            "client": {
                "id": "a6c82b30-aafc-4c5e-bbb0-811c983c7fb0"
            },
            "id": "f975de4c-ddeb-4ae6-988a-aa91dd5ecabd",
            "created_at": "2025-06-12T14:30:04.810Z",
            "updated_at": "2025-06-12T14:30:04.810Z",
            "deleted_at": null
        }
    }
}
Modified at 2025-11-27 20:32:47
Previous
📘 Enum Reference
Next
Get Clients List
Built with