API Reference

Pull Business Credit Report API Parameters

Parameter NameRequiredFormatComment
full_nameYesASCII String.
Regex check:
^[a-zA-Z\s]{1,200}$
Full name 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.
otp_uuidYesOTP UUIDOTP UUID which has been verified.
company_nameYesValid StringName of the company whose report is being pulled.
company_panYesValid PANPAN of the company whose report is being pulled.
pin_codeYesValid Pin CodePin code of the company whose report is being pulled.
addressYesValid StringAddress of the company whose report is being pulled.
company_typeYesType of the company.

1 - Private Limited
2 - Public Limited
3 - Business Entities created by statute
4 - Proprietorship
5 - Partnership
6 - Trust
7 - Hindu Undivided Family
8 - Co-operative society
9 - Association of persons
10 - Government
11 - Self help group
12 - Not classified
Typically this would be either of Private Limited, Public Limited, Proprietorship, Partnership.

Choose accordingly.