Parameter Name | Required | Format | Comment |
---|---|---|---|
full_name | Yes | Ascii string. Regex check: ^[a-zA-Z\s]{1,200}$ | Full name of the customer. |
gender | Yes | 1: Male 2: Female Note that integer codes should be passed in the API request. | Gender of the customer. |
id_number | Yes | ASCII String. Regex check E.g. for pan: ^[A-Z]{3}[P|H][A-Z][0-9]{4}[A-Z] | Identifier number of the customer. |
doc_type | Yes | Choose the Type of identifier. For e.g. PAN == ‘TaxId’ passport == ‘PassportId’ | Choose the appropriate choice type from the given table. And pass the value of the identifier type. Identifier Types |
date_of_birth | Yes | Date format YYYY-MM-DD. For e.g. 2019-01-30 should be passed as “2019-01-30” | Date of birth of the customer. |
mobile_number | Yes | The 10-digit mobile number, should start with 6/7/8/9. | OTP verified mobile number of the customer. |
Yes | Valid email format | Email of the customer. | |
street_address | Yes | ASCII String | Address of the customer. |
pin_code | Yes | Valid 6-digit Pincode | Pincode where the customer currently resides. |
city | Yes | City Name | City name where the customer currently resides. |
region | Yes | For State name check the Choices Type and add the same value. | From the Provided State Choices choose customer’s current state and send the value of the state. States |
address_type | Yes | 1. Permanent Address 2. Residence Address * 3. Office Address | Have to choose what should be the address type provided by the customer. |
user_consent | Yes | True or False | In case verbal consent is not provided pass false, OneFin will trigger SMS with consent link to the customer’s mobile number. |