> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Indian Documents
The FrankieOne KYC v2 API supports Indian documents for identity verification. This guide outlines the requirements and best practices for handling these documents.
## Supported Indian Documents
The FrankieOne KYC v2 API currently supports the following Indian documents for identity verification:
| Document | Code |
| :----------------------------- | :---------------- |
| Aadhaar | `NATIONAL_ID` |
| PAN (Permanent Account Number) | `NATIONAL_ID` |
| Voter ID (EPIC) | `NATIONAL_ID` |
| Driver's License | `DRIVERS_LICENSE` |
| Passport | `PASSPORT` |
***
### Passports
Indian passports are official travel documents issued by the Indian government that confirm an individual's identity and citizenship. They include personal details such as the individual's name, date of birth, passport number, and file number.
| Field Name | Field | Notes |
| :------------ | :------------ | :-------------------------------------------------------------------------------------------------------------- |
| Document Type | `type` | Must be `PASSPORT` for Indian passports. |
| Country | `country` | Must be `IND` (India). |
| Date of Birth | `dateOfBirth` | Format: `YYYY-MM-DD`. Must match the date of birth as shown on the passport. |
| Name | `name` | Enter the full name exactly as shown on the passport, including capitalization, special characters, and spaces. |
| Field Name | Field | Notes |
| :-------------- | :-------------------- | :--------------------------------------------------------------------------------------------------------------------- |
| Passport Number | `primaryIdentifier` | Enter exactly as shown on the passport. Format: One uppercase letter followed by 7 digits (e.g., `J1234567`). |
| File Number | `secondaryIdentifier` | Enter exactly as shown on the passport. Format: Two uppercase letters followed by 13 digits (e.g., `DL1234567890123`). |
**Example Document Structure**
```json theme={null}
{
"document": {
"class": "IDENTITY", // Document class must be 'IDENTITY' for KYC verification
"primaryIdentifier": "J1234567", // Passport Number: One uppercase letter followed by 7 digits (e.g., 'J1234567')
"secondaryIdentifier": "DL1234567890123", // File Number: Two uppercase letters followed by 13 digits (e.g., 'DL1234567890123')
"type": "PASSPORT", // Document type must be 'PASSPORT' for Indian passports
"country": "IND" // Country code must be 'IND' for India
}
}
```
### Field Requirements
* Must consist of one uppercase letter followed by 7 digits
* Example: `J1234567`
* Case sensitive: only uppercase letters are accepted
* Enter exactly as shown on the passport
* Must consist of two uppercase letters (typically the state code) followed by 13 digits
* Example: `DL1234567890123`
* Should be provided in the `secondaryIdentifier` field
* Enter exactly as it appears on the passport
* Given name and family name are required; middle name is optional
* Names must match the passport exactly, including capitalization, special characters, and spaces
* Include the display name exactly as shown on the passport
***
### Aadhaar (National ID)
Aadhaar is a 12-digit unique identification number issued by the Unique Identification Authority of India (UIDAI). It serves as a proof of identity and address for Indian residents and is widely used for identity verification purposes.
| Field Name | Field | Notes |
| :------------ | :------------ | :------------------------------------------------------------------------------------------------------------------ |
| Document Type | `type` | Must be `NATIONAL_ID` for Aadhaar. |
| Country | `country` | Must be `IND` (India). |
| Date of Birth | `dateOfBirth` | Format: `YYYY-MM-DD`. Must match the date of birth as shown on the Aadhaar card. |
| Name | `name` | Enter the full name exactly as shown on the Aadhaar card, including capitalization, special characters, and spaces. |
| Field Name | Field | Notes |
| :------------- | :------------------ | :--------------------------------------------------------------------------------------------------- |
| Aadhaar Number | `primaryIdentifier` | Enter exactly as shown on the Aadhaar card. Format: 12 digits without dashes (e.g., `304365000000`). |
**Example Document Structure**
```json theme={null}
{
"document": {
"class": "IDENTITY", // Document class must be 'IDENTITY' for KYC verification
"primaryIdentifier": "304365000000", // Aadhaar Number: 12 digits without dashes
"type": "NATIONAL_ID", // Document type must be 'NATIONAL_ID' for Aadhaar
"country": "IND" // Country code must be 'IND' for India
}
}
```
**Sandbox Testing:** To test Aadhaar verification in the sandbox environment, use the number `304365000000`, which will return a successful (pass) result.
### Field Requirements
* Must consist of exactly 12 digits
* Example: `304365000000`
* Do not include dashes or spaces
* Enter exactly as shown on the Aadhaar card
* Given name and family name are required; middle name is optional
* Names must match the Aadhaar card exactly, including capitalization, special characters, and spaces
* Include the display name exactly as shown on the Aadhaar card
***
### PAN (Permanent Account Number)
PAN is a ten-character alphanumeric identifier issued by the Indian Income Tax Department. It is used for tracking financial transactions and serves as an important identity document.
| Field Name | Field | Notes |
| :------------ | :------------ | :------------------------------------------------------------------------------------------------------- |
| Document Type | `type` | Must be `NATIONAL_ID` for PAN. |
| Country | `country` | Must be `IND` (India). |
| Date of Birth | `dateOfBirth` | Format: `YYYY-MM-DD`. Must match the date of birth associated with the PAN. |
| Name | `name` | Enter the full name exactly as registered with the PAN, including capitalization and special characters. |
| Field Name | Field | Notes |
| :--------- | :------------------ | :----------------------------------------------------------------------------------------------------- |
| PAN Number | `primaryIdentifier` | Format: 5 uppercase letters + 4 digits + 1 uppercase letter (e.g., `AAAPL1234C`). Total 10 characters. |
**Example Document Structure**
```json theme={null}
{
"document": {
"class": "IDENTITY", // Document class must be 'IDENTITY' for KYC verification
"primaryIdentifier": "AAAPL1234C", // PAN Number: 5 letters + 4 digits + 1 letter (10 characters)
"type": "NATIONAL_ID", // Document type must be 'NATIONAL_ID' for PAN
"country": "IND" // Country code must be 'IND' for India
}
}
```
### Field Requirements
* Must be exactly 10 characters
* First 5 characters are uppercase letters
* Next 4 characters are digits
* Last character is an uppercase letter
* Example: `AAAPL1234C`
* Enter exactly as shown on the PAN card
* Given name and family name are required; middle name is optional
* Names must match the PAN registration exactly, including capitalization and special characters
***
### Voter ID (EPIC)
The Electors Photo Identity Card (EPIC) is issued by the Election Commission of India. It serves as a primary proof of identity and is widely accepted for identity verification.
| Field Name | Field | Notes |
| :------------ | :------------ | :----------------------------------------------------------------------------------------------------- |
| Document Type | `type` | Must be `NATIONAL_ID` for Voter ID. |
| Country | `country` | Must be `IND` (India). |
| Date of Birth | `dateOfBirth` | Format: `YYYY-MM-DD`. Must match the date of birth as shown on the Voter ID. |
| Name | `name` | Enter the full name exactly as shown on the Voter ID, including capitalization and special characters. |
| Field Name | Field | Notes |
| :---------- | :------------------ | :------------------------------------------------------------------------------------------ |
| EPIC Number | `primaryIdentifier` | Format: 3 uppercase letters followed by 7 digits (e.g., `ABC0000000`). Total 10 characters. |
**Example Document Structure**
```json theme={null}
{
"document": {
"class": "IDENTITY", // Document class must be 'IDENTITY' for KYC verification
"primaryIdentifier": "ABC0000000", // EPIC Number: 3 letters + 7 digits (10 characters)
"type": "NATIONAL_ID", // Document type must be 'NATIONAL_ID' for Voter ID
"country": "IND" // Country code must be 'IND' for India
}
}
```
### Field Requirements
* Must be exactly 10 characters
* First 3 characters are uppercase letters
* Last 7 characters are digits
* Example: `ABC0000000`
* Enter exactly as shown on the Voter ID card
* Given name and family name are required; middle name is optional
* Names must match the Voter ID exactly, including capitalization and special characters
***
### Driver's License
Indian driver's licenses are issued by the Regional Transport Office (RTO) in each state. They contain a unique license number that encodes the state, RTO, and year of issue.
| Field Name | Field | Notes |
| :------------ | :------------ | :------------------------------------------------------------------------------------------------------------- |
| Document Type | `type` | Must be `DRIVERS_LICENSE` for Indian driver's licenses. |
| Country | `country` | Must be `IND` (India). |
| Date of Birth | `dateOfBirth` | Format: `YYYY-MM-DD`. Must match the date of birth as shown on the license. |
| Name | `name` | Enter the full name exactly as shown on the license, including capitalization, special characters, and spaces. |
| Field Name | Field | Notes |
| :------------- | :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| License Number | `primaryIdentifier` | Format: 16 characters total. 2 letters (state code) + 2 digits (RTO code) + 4 digits (year) + 7 digits. May include a hyphen or space (e.g., `HR-0619850034761` or `HR06 19850034761`). |
**Example Document Structure**
```json theme={null}
{
"document": {
"class": "IDENTITY", // Document class must be 'IDENTITY' for KYC verification
"primaryIdentifier": "HR-0619850034761", // License Number: 16 characters (including hyphen or space)
"type": "DRIVERS_LICENSE", // Document type must be 'DRIVERS_LICENSE' for Indian licenses
"country": "IND" // Country code must be 'IND' for India
}
}
```
### Field Requirements
* Must be 16 characters long (including space or hyphen)
* First 2 characters: uppercase letters representing the state code (e.g., `HR` for Haryana, `DL` for Delhi)
* Next 2 characters: digits representing the RTO code
* Next 4 characters: digits representing the year the license was issued
* Last 7 characters: digits (0-9)
* May include a hyphen or space separator (e.g., `HR-0619850034761` or `HR06 19850034761`)
* Enter exactly as shown on the license
* Given name and family name are required; middle name is optional
* Names must match the driver's license exactly, including capitalization, special characters, and spaces
***
##### Key Guidelines for Indian Document Verification
**Name Matching**
* Ensure the name matches the document exactly, including capitalization, special characters, spaces, and diacritical marks.
* Enter the full name as displayed on the document.
**Country Code**
* For all Indian documents, set the country code to `IND`.
**Document Numbers**
* **Aadhaar:** 12 digits without dashes or spaces (e.g., `304365000000`).
* **PAN:** 5 uppercase letters + 4 digits + 1 uppercase letter (e.g., `AAAPL1234C`).
* **Voter ID (EPIC):** 3 uppercase letters + 7 digits (e.g., `ABC0000000`).
* **Driver's License:** 16 characters — state code + RTO code + year + 7 digits (e.g., `HR-0619850034761`).
* **Passport:** 1 uppercase letter + 7 digits (e.g., `R1234567`). File number in `secondaryIdentifier`.
* Incorrect or expired document numbers will result in verification failure.
**Date of Birth**
* Use the ISO date format (`YYYY-MM-DD`) for the date of birth.
**Best Practices**
* Provide all available optional fields to improve verification accuracy.
* Always include `class: "IDENTITY"` on all identity documents.