NRI UAE

🌍 NRI KYC APIs (v2.0)

Base URL:

http://127.0.0.1:8000/api/v2.0/taas/nri-kyc/

Authentication:

API-KEY: <your-api-key>

---

🔐 NRI KYC Flow Overview

1. Fetch Supported Countries

2. Initiate NRI KYC

3. Submit Document (Number / File)

4. Check Session Status

5. Cleanup Session

---

🌐 1. Get Supported NRI Countries

Endpoint

GET /countries/

Description

Returns supported countries along with required and optional KYC documents.

---

Request

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

---

Response

{
  "success": true,
  "data": {
    "supported_countries": [
      {
        "code": "USA",
        "verification_methods": ["ssn", "driving_license"]
      },
      {
        "code": "UAE",
        "verification_methods": ["emirates_id"]
      }
    ]
  }
}

---

📌 Key Concepts

• verification_methods → Allowed verification flows

• required_documents → Mandatory for KYC completion

• optional_documents → Used for manual review / additional checks

---

🚀 2. Initiate NRI KYC

Endpoint

POST /initiate/

Description

Starts an NRI KYC session for a specific country.

---

Request

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

---

Response

{
  "success": true,
  "message": "NRI KYC session initiated for UAE",
  "session": {
    "session_id": "8aa716d8-36d1-4992-9a6f-39e4e0aa44db",
    "country": "UAE",
    "status": "pending",
    "required_documents": ["emirates_id"],
    "all_documents": [
      "emirates_id",
      "utility_bill",
      "uae_driving_license"
    ]
  }
}

---

📄 3. Submit Document (Number-based)

Endpoint

POST /document/submit/

Description

Submit structured document data for verification.

---

📌 Example: UAE Emirates ID

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/nri-kyc/document/submit/' \
--header 'Content-Type: application/json' \
--header 'API-KEY: <API_KEY>' \
--data '{
    "nri_session_id": "8aa716d8-36d1-4992-9a6f-39e4e0aa44db",
    "document_type": "emirates_id",
    "document_data": {
        "id_number": "784-1988-8690895-7",
        "date_of_birth": "09/12/1988",
        "current_nationality": "INDIA",
        "name": "Naimish Sanghvi",
        "gender": "Male"
    }
}'

---

Response

{
  "success": true,
  "message": "emirates_id document submitted for verification",
  "document": {
    "document_type": "emirates_id",
    "document_id": 19,
    "status": "pending",
    "country": "UAE"
  }
}

---

📂 4. Submit Document File

Endpoint

POST /document_file/submit/

Description

Upload document images for OCR and verification.

---

Example: Emirates ID Upload

curl --location 'http://127.0.0.1:8000/api/v2.0/taas/nri-kyc/document_file/submit/' \
--header 'API-KEY: <API_KEY>' \
--form 'nri_session_id="<session_id>"' \
--form 'document_type="emirates_id"' \
--form 'file_type="image"' \
--form 'doc_front=@"/path/front.png"'

---

Response

{
  "success": true,
  "message": "Document images submitted for OCR and verification",
  "document": {
    "document_type": "emirates_id",
    "document_id": 17,
    "status": "pending",
    "country": "UAE",
    "files_uploaded": ["front"]
  }
}

---

📊 5. Get NRI KYC Status

Endpoint

GET /status/

---

Request

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

---

Response

{
  "success": true,
  "sessions": [
    {
      "session_id": "5ff853cb-41b7-4c26-8fcc-c17841fe5584",
      "country": "UAE",
      "status": "verification_failed",
      "documents": [
        {
          "document_type": "emirates_id",
          "status": "verification_failed"
        }
      ]
    }
  ]
}

---

🧹 6. Cleanup NRI KYC Session

Endpoint

POST /cleanup/

---

Request

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

---

Response

{
  "success": true,
  "message": "NRI KYC cleanup completed",
  "cleanup_stats": {
    "sessions_deleted": 1,
    "documents_deleted": 1,
    "linked_documents_deleted": 1
  }
}

---

📌 Notes

• Each country has custom document requirements

• Required documents must be completed for verification

• Optional documents are used for manual review / compliance

• Status lifecycle:

  • pending

  • verified

  • verification_failed

• File upload triggers OCR + backend verification