KYC Operations
POST /kyc
Description: Processes KYC (Know Your Customer) documents for a user.
Request Body:
{
"user_id": "4cca2275-5b1d-426f-977f-6448dea5a679",
"kyc": [
{
"document_type": "pid",
"document_name": "aadhar",
"document_number": "31345630******,
"dateOfBirth": "26-05-2004",
"Nationality": "Indian",
"nameOnCard": "UserName on pid"
},
{
"document_type": "tid",
"document_name": "pan",
"document_number": "",
"dateOfBirth": "26-05-2004",
"Nationality": "Indian",
"nameOnCard": "UserName on tid"
}
]
}Success Response (201 Created):
{
"status": true,
"code": 201,
"message": "KYC processed",
"data": [
{
"status": true,
"message": "KYC created",
"data": {
"kyc_id": "67424111-d8b6-4d4d-b23b-77879f7efcf9",
"country": "IN",
"document_type": "pid",
"document_name": "aadhar",
"document_number": "31345630****",
"full_name": "UserName ",
"user_id": "46c7dc1e-c229-4f9f-83d6-d64851bedde7",
"dob": "2004-05-26",
"kyc_status": "pending",
"verified_by": "client",
"updated_at": "2025-07-11T07:17:44.228Z",
"created_at": "2025-07-11T07:17:44.228Z",
"vp": null,
"metadata": null
}
},
{
"status": true,
"message": "KYC created",
"data": {
"kyc_id": "b6de3631-fdda-40d2-93ba-86c418c90afe",
"country": "IN",
"document_type": "tid",
"document_name": "pan",
"document_number": "CGKPB9*****",
"full_name": "UserName",
"user_id": "46c7dc1e-c229-4f9f-83d6-d64851bedde7",
"dob": "1997-04-11",
"kyc_status": "failed",
"verified_by": "system",
"updated_at": "2025-07-11T07:17:44.236Z",
"created_at": "2025-07-11T07:17:44.236Z",
"vp": null,
"metadata": {
"statusCode": 200,
"response": {
"status": true,
"code": 200,
"message": "PAN verified successfully",
"data": {
"status": "success",
"statusCode": 200,
"result": {
"pan": "CGKPB9*****",
"panStatus": "EXISTING AND VALID",
"name": "MATCHING",
"dateOfBirth": "MATCHING",
"aadhaarSeedingStatus": "Y"
},
"metaData": {
"requestId": "1752218264262-60c62698-2b6e-432d-9333-43b2cb6dca80",
"transactionId": "0001"
}
}
}
}
}
}
]
}GET /kyc/:userId
Description: Retrieves KYC information for a specific user.
Success Response (200 OK):
{
"status": true,
"data": {
"statusCode": 200,
"response": {
"status": true,
"code": 200,
"message": "KYC data retrieved successfully",
"data": {
"user": [
{
"user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
"client_id": "e513739a-5231-4538-a818-ea2b8a1a2bc0",
"pid": null,
"tid": null,
"bank_id": "178621e1-ac93-48dc-9f07-b55b2d5b7746",
"user_type": "individual",
"email": "[email protected]",
"mobile": "9876543211",
"created_at": "2025-07-07T07:14:27.683Z",
"updated_at": "2025-07-07T07:19:45.151Z"
}
],
"kycData": [
{
"kyc_id": "cbd087d8-cf9b-4000-b9d1-5c911f978b5f",
"user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
"document_type": "pid",
"document_name": "aadhar",
"document_number": "3034563*****",
"dob": "1997-04-11",
"full_name": "UserName ",
"country": "IN",
"kyc_status": "pending",
"vp": null,
"verified_by": "client",
"metadata": null,
"created_at": "2025-07-07T07:17:27.805Z",
"updated_at": "2025-07-07T07:17:27.805Z"
}
]
}
}
}
}