KYC

📘 KYC APIs (v2.0)

Base URL:

http://127.0.0.1:8000/api/v2.0/taas/

Authentication:

API-KEY: <your-api-key>

---

🔐 KYC Flow Overview

1. Initiate KYC Session

2. Submit Documents (Number / File)

3. Upload Selfie

4. Fetch KYC Status

5. Cleanup (optional)

---

🚀 1. Initiate KYC

Endpoint

POST /kyc/initiate/

Description

Starts a new KYC session for a given account.

---

Request

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/kyc/initiate/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
    "account_id": 114
}'

---

Response

{
  "success": true,
  "message": "KYC session initiated successfully",
  "session": {
    "session_id": "3e2bb2ae-86fc-41b7-8e62-6e947ecefd8e",
    "status": "pending",
    "initiated_at": "2026-03-06T14:48:48.530096+05:30"
  }
}

---

🔍 2. Get KYC Info

Endpoint

GET /kyc/{account_id}/

Description

Fetch complete KYC details including submitted documents and verification status.

---

Request

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/kyc/85/' \
--header 'API-KEY: <API_KEY>'

---

Response

{
  "success": true,
  "kyc_info": {
    "kyc_session": "9e9043af-9dee-4feb-a3cc-58e37f1e9de3",
    "kyc_status": "verified",
    "ovd_documents": [
      {
        "document_type": "pan",
        "document_category": "poi",
        "document": {
          "status": "verified",
          "pan_no": "DDYPM3329E"
        }
      }
    ]
  }
}

---

🧹 3. Cleanup KYC

Endpoint

POST /kyc/cleanup/

Description

Deletes KYC sessions and related data for an account.

---

Request

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/kyc/cleanup/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
    "account_id": 85
}'

---

Response

{
  "success": true,
  "message": "Cleaned up 1 KYC session(s) for account 85",
  "cleaned": {
    "sessions_deleted": 1,
    "kyc_info_deleted": 1,
    "ovd_documents_deleted": 3,
    "linked_documents_deleted": 3
  }
}

---

📄 4. Submit Document (Number-based)

Endpoint

POST /kyc/document/submit/

Description

Submit document details (no file upload).

---

🔹 Supported Document Types

• pan

• passport

• driving_license

• voter_id

---

📌 Example: PAN

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/kyc/document/submit/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
  "kyc_session_id": "9e9043af-9dee-4feb-a3cc-58e37f1e9de3",
  "document": {
      "document_type": "pan",
      "document_number": "DDYPM3329E",
      "name": "Anurag Maurya",
      "dob": "21/03/2000"
  }
}'

---

📌 Example: Passport

--data '{
  "kyc_session_id": "<session_id>",
  "document": {
      "document_type": "passport",
      "document_number": "Z3649390",
      "name": "Shuja",
      "surname_from_passport": "Hussain",
      "dob": "26/03/1991",
      "file_number": "AH2061231654417",
      "date_of_issue": "24/07/2017"
  }
}'

---

📌 Example: Driving License

--data '{
  "kyc_session_id": "<session_id>",
  "document": {
      "document_type": "driving_license",
      "document_number": "KA1420170006950",
      "name": "Gowrish Patel",
      "dob": "23/09/1998"
  }
}'

---

📌 Example: Voter ID

--data '{
  "kyc_session_id": "<session_id>",
  "document": {
      "document_type": "voter_id",
      "document_number": "WFW2240133",
      "name": "Karan Mehta",
      "dob": "18/01/2003"
  }
}'

---

Response

{
  "success": true,
  "message": "Document submitted for verification",
  "document": {
    "document_type": "pan",
    "status": "pending"
  }
}

---

📂 5. Submit Document Files

Endpoint

POST /kyc/document_file/submit/

Description

Upload document images or XML for verification.

---

🔹 File Types Supported

• image

• pdf

• xml

---

📌 Example: PAN Upload

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/kyc/document_file/submit/' \
--header 'API-KEY: <API_KEY>' \
--form 'kyc_session="<session_id>"' \
--form 'doc_type="pan"' \
--form 'doc_front=@"/path/pan.jpg"' \
--form 'file_type="image"'

---

📌 Example: Driving License (Front + Back)

--form 'doc_type="driving_license"' \
--form 'doc_front=@"/path/front.jpeg"' \
--form 'doc_back=@"/path/back.jpeg"' \
--form 'file_type="image"'

---

📌 Example: Aadhaar XML

--form 'doc_type="aadhaar"' \
--form 'doc_front=@"/path/aadhaar.xml"' \
--form 'file_type="xml"'

---

Aadhaar XML Response

{
  "success": true,
  "message": "XML Aadhaar document processed successfully",
  "document": {
    "document_type": "aadhaar",
    "status": "verified",
    "xml_validation": true
  }
}

---

📌 Example: Selfie Upload

--form 'doc_type="selfie"' \
--form 'doc_front=@"/path/selfie.png"' \
--form 'file_type="image"'

---

Selfie Response

{
  "success": true,
  "message": "Selfie uploaded successfully and face matching verification initiated",
  "document": {
    "document_type": "selfie",
    "status": "face_matching_in_progress"
  }
}

---

📌 Notes

• kyc_session_id is required for all document submissions

• Face matching is triggered after selfie upload

• Aadhaar XML is auto-verified if valid