API Reference

Pull Credit Report API Parameters

Parameter NameRequiredFormatComment
full_nameYesAscii string.
Regex check:
^[a-zA-Z\s]{1,200}$
Full name of the customer.
genderYes1: Male
2: Female

Note that integer codes should be passed in the API request.
Gender of the customer.
id_numberYesASCII 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_typeYesChoose 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_birthYesDate format
YYYY-MM-DD.
For e.g.
2019-01-30 should be passed as “2019-01-30”
Date of birth of the customer.
mobile_numberYesThe 10-digit mobile number, should start with 6/7/8/9.OTP verified mobile number of the customer.
emailYesValid email formatEmail of the customer.
street_addressYesASCII StringAddress of the customer.
pin_codeYesValid 6-digit PincodePincode where the customer currently resides.
cityYesCity NameCity name where the customer currently resides.
regionYesFor 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_typeYes 1. Permanent Address
2. Residence Address
* 3. Office Address
Have to choose what should be the address type provided by the customer.
user_consentYesTrue or FalseIn case verbal consent is not provided pass false, OneFin will trigger SMS with consent link to the customer’s mobile number.