Create Application
Parameter | Type | Description | Mandatory/Optional |
schemeId | String | Identifier for the associated scheme. | Mandatory |
tenure | Number | Tenure of the application. | Mandatory |
amount | Number | Amount applied. | Mandatory |
payableTo | String | Payable to. Value: ["first_holder"] | Mandatory |
applicants | Array of Objects | Applicant information. (1 items) | Mandatory |
applicants.salutation | String | Salutation of the applicant. Value: ["mr", "mrs", "ms"] | Mandatory |
applicants.firstName | String | First name of the applicant. | Mandatory |
applicants.middleName | String | Middle name of the applicant. | Optional |
applicants.lastName | String | Last name of the applicant. | Mandatory |
applicants.dateOfBirth | String | Date of birth of the applicant (ISO 8601 date format). For example, "2017-07-21" | Mandatory |
applicants.gender | String | Gender of the applicant. Value: ["male", "female", "transgender"] | Mandatory |
applicants.email | String | Email address of the applicant. | Mandatory |
applicants.mobile | String | Mobile number of the applicant. | Mandatory |
applicants.pan | String | PAN number of the applicant (10 characters). | Mandatory |
applicants.aadhaar | String | Aadhaar number of the applicant (12 characters). | Mandatory |
applicants.ckycNumber | String | ckyc number of the applicant. | Optional |
applicants.maritalStatus | String | Marital status of the applicant. Value: ["married", "unmarried", "other"] | Mandatory |
applicants.annualIncome | String | Annual income range of the applicant. Value: ["upto_5_lakh", "above_5_lakh_upto_10_lakh", "above_10_lakh_upto_15_lakh", "above_15_lakh_upto_25_lakh", "above_25_lakh_upto_50_lakh", "above_50_lakh_upto_1_crore", "above_1_crore"] | Mandatory |
applicants.occupation | String | Occupation of the applicant. Value: ["business", "agriculture", "forex_dealer", "service_public_sector", "service_private_sector", "service_government_sector", "others_professional", "others_self_employed", "others_retired", "others_housewife", "others_student", "others"] | Mandatory |
applicants.birthPlace | String | Place of birth of the applicant. | Mandatory |
applicants.birthCountry | String | Country of birth of the applicant. | Mandatory |
applicants.nationality | String | Nationality of the applicant. Value: ["indian"] | Mandatory |
applicants.spouse | Object | Details of the spouse, if applicable. | Optional, If provided then all details inside it is mandatory except Middle name |
applicants.spouse.salutation | String | Salutation of the spouse. Value: ["mr", "mrs", "ms"] | Mandatory |
applicants.spouse.firstName | String | First name of the spouse. | Mandatory |
applicants.spouse.middleName | String | Middle name of the spouse. | Optional |
applicants.spouse.lastName | String | Last name of the spouse. | Mandatory |
applicants.father | Object | Details of the father, if applicable. | Optional, If provided then all details inside it is mandatory except Middle name |
applicants.father.salutation | String | Salutation of the father. Value: ["mr", "mrs", "ms"] | Mandatory |
applicants.father.firstName | String | First name of the father. | Mandatory |
applicants.father.middleName | String | Middle name of the father. | Optional |
applicants.father.lastName | String | Last name of the father. | Mandatory |
applicants.residentialAddress | Object | Residential address of the applicant. | Mandatory |
applicants.residentialAddress.addressLine1 | String | Address line 1. | Mandatory |
applicants.residentialAddress.addressLine2 | String | Address line 2. | Optional |
applicants.residentialAddress.addressLine3 | String | Address line 3. | Optional |
applicants.residentialAddress.city | String | City | Mandatory |
applicants.residentialAddress.state | String | State | Mandatory |
applicants.residentialAddress.pincode | String | Pincode | Mandatory |
applicants.residentialAddress.country | String | Country | Mandatory |
applicants.permanentAddressSameAsResidential | Boolean | Indicates if the permanent address is the same as residential address. | Mandatory |
applicants.permanentAddress | Object | Permanent address of the applicant, if different from residential address. Value: [true, false]
| Conditionally Mandatory |
applicants.permanentAddress.addressLine1 | String | Address line 1. | Mandatory |
applicants.permanentAddress.addressLine2 | String | Address line 2. | Optional |
applicants.permanentAddress.addressLine3 | String | Address line 3. | Optional |
applicants.permanentAddress.city | String | City | Mandatory |
applicants.permanentAddress.state | String | State | Mandatory |
applicants.permanentAddress.pincode | String | Pincode | Mandatory |
applicants.permanentAddress.country | String | Country | Mandatory |
bank | Object | Bank details of applicant. | Mandatory |
bank.accountType | String | Type of bank account. Value: ["savings", "current"] | Mandatory |
bank.ifsc | String | IFSC code of the bank branch. | Mandatory |
bank.accountNumber | String | Account number. | Mandatory |
nominees | Array of Objects | Detail of nominees. | Optional, If provided then all details inside it is mandatory |
nominees.salutation | String | Salutation of the nominee. Value: ["mr", "mrs", "ms"] | Mandatory |
nominees.firstName | String | First name of the nominee. | Mandatory |
nominees.middleName | String | Middle name of the nominee. | Optional |
nominees.lastName | String | Last name of the nominee. | Mandatory |
nominees.dateOfBirth | String | Date of birth of the nominee (ISO 8601 date format). For example, "2017-07-21" | Mandatory |
nominees.relation | String | Relation to the applicant. Value: ["brother", "sister", "father", "mother", "son", "daughter", "husband", "wife", "other"] | Mandatory |
nominees.guardian | Object | Guardian details of nominee. Its required if nominee is minor. | Conditionally Optional, If provided then all details inside it is mandatory except middle name |
nominees.guardian.salutation | String | Salutation of the guardian. Value: ["mr", "mrs", "ms"] | Mandatory |
nominees.guardian.firstName | String | First name of the guardian. | Mandatory |
nominees.guardian.middleName | String | Middle name of the guardian. | Optional |
nominees.guardian.lastName | String | Last name of the guardian. | Mandatory |
ipAddress | String | IP address of the user. | Mandatory |
Key | Type | Description |
id | String | The unique identifier of the application |
status | String | Status of the application. Value: ["new""awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"] |