Commercial Credit Report API
See a business’s credit facilities, overdues and defaults from its name and PAN before you lend to it or sell to it on credit.
The documentation opens in the VerifyAll dashboard after sign-in, for accounts with approved API access. New to the API? Start with the developer guide.
Overview
What the Commercial Credit Report API does
The Commercial Credit Report API pulls a business’s commercial credit report from two details: its registered name and its PAN. The answer is JSON with the business score and band, the business profile (constitution, size category, industry and date of incorporation), a summary of its credit facilities, each facility with its repayment record, and the enquiries made on it.
It is the credit check for counterparties rather than people. Finance and procurement teams use it to set credit terms for a distributor, size an invoice-discounting limit, or decide whether a supplier can carry an advance. Lenders use it for MSME and working capital loans, where the business’s own borrowing matters as much as its promoters’ personal reports.
The report uses the same schema as the consumer credit reports, with the business block filled in. Return it once with POST /universal/commercial-credit-report, or save it with POST /credit-report/commercial/create to keep the report and its PDF in the counterparty file.
How it works
- 1
Record the business’s consent to the pull (its time, method and consent-text version), then send POST /credit-report/commercial/create with business_name, pan (the business PAN) and the consent object.
- 2
The request is checked first; a malformed PAN, an empty name or incomplete consent is refused with 400 and nothing is charged.
- 3
The commercial report is answered in the same call, usually within about 8 seconds, and charged from your prepaid wallet.
- 4
A saved report gets a report_id: read it with GET /credit-report/commercial/list/{id}, download it with POST /pdf-reports/credit-commercial and delete it when it is no longer needed.
Request and response
Commercial credit report API endpoints and fields
The main fields; the full reference with every field, error code and a cURL sample is in the dashboard docs.
| Endpoint | What it does |
|---|---|
| POST/universal/commercial-credit-report | Pull a business’s commercial credit report, returned and not saved |
| POST/credit-report/commercial/create | Pull a commercial credit report and save it |
| GET/credit-report/commercial/list | List saved commercial reports (Production key) |
| GET/credit-report/commercial/list/{id} | Read one saved commercial report (Production key) |
| DELETE/credit-report/commercial/delete/{id} | Delete a saved commercial report (Production key) |
Request fields
| Field | What it is |
|---|---|
| business_nameRequired | Registered name of the business. |
| panRequired | PAN of the business (not a promoter’s personal PAN). |
| consentRequired | The business’s consent: obtained: true, purpose, obtained_at (ISO 8601), method (web_form, paper, voice, sms or other) and text_version. |
| client_refOptional | Your reference, for example a vendor code or credit application number. |
What the answer returns
| Field | What it is |
|---|---|
| bureau | commercial for this report. |
| score / score_band / score_name | The business score, its band in words and the scorecard used; null when the business cannot be scored. |
| business | name, constitution (proprietorship, partnership, private limited and so on), size category, industry and incorporated_on. |
| subject | The business name on the report and its PAN, masked. |
| summary | Facility counts (total, active, closed, overdue, written off) and rupee totals for sanctioned, balance and overdue. |
| accounts | Each credit facility: type, lender, status, sanctioned amount, balance, overdue, instalment and secured flag. |
| accounts[].written_off_or_settled | On a commercial report, also true for a wilful default or a suit filed on the facility. |
| accounts[].dpd_summary / enquiries | Each facility’s counted repayment record, and the enquiries made on the business with purpose, amount and date. |
Base URL https://api.verifyall.ai. Authenticate with the X-API-Key header (a va_sandbox_ or va_live_ key). Every answer carries data, status_code, success, message and message_code; checks add outcome, checkResultId, charged and charged_amount.
Key features
Commercial Credit Report API features and capabilities
Business profile with the score
Constitution, size category, industry and incorporation date come back with the credit data, so one call tells you what kind of entity you are dealing with.
Defaults and suits flagged
written_off_or_settled marks facilities with a write-off, settlement, wilful default or suit filed, the signals a trade credit policy usually stops on.
Two inputs only
Business name and business PAN are enough, which suits vendor and distributor onboarding where you hold the PAN from the start.
Same schema as consumer reports
Promoters’ personal reports and the business report share their field names, so a combined credit memo can be built from one parser.
Use cases
Where businesses use the Commercial Credit Report API
Trade credit and payment terms
Decide credit days and limits for a distributor or dealer from its overdues and repayment record.
MSME and working capital lending
Read existing facilities, utilisation and defaults before sanctioning a business loan or overdraft.
Supplier advances and large orders
Check a supplier’s financial stress before paying an advance or placing a long-dated order.
Invoice discounting and leasing
Size a discounting line or an equipment lease on the buyer’s or lessee’s own borrowing record.
Industries
Coverage
Businesses in India with a PAN: proprietorships, partnerships, LLPs and companies. The report covers the business’s credit facilities, repayment record and enquiries, not its promoters’ personal loans.
Limitations to plan for
- Use the business PAN and registered name. A promoter’s personal credit needs one of the consumer credit report APIs.
- Consent with obtained_at, method and text_version is required, given on behalf of the business.
- A business with no commercial credit history is a completed lookup and is charged.
- Saved commercial reports can be listed, read and deleted with the Production key only.
Integration
How to integrate the Commercial Credit Report API
From a business account to your first live call.
Step 1
Create a business account on VerifyAll and get it approved, as for running checks in the dashboard.
Step 2
Request Developer API access under Developers in the dashboard: the APIs you need, your expected monthly volume and your use case. The VerifyAll team reviews it and shares the API Services Agreement.
Step 3
Once the agreement is signed and access is approved, create your Sandbox key and build against sample data. Sandbox calls are never charged.
Step 4
Create your Production key, recharge your wallet and switch the key in your code: the endpoint and fields stay the same.
Get started
Request access to the Commercial Credit Report API
Tell us what you want to verify. We reply within one business day with access steps, Sandbox details and your API pricing.
View API documentation
The full reference for Commercial Credit Report API (endpoints, fields, errors, cURL) opens in the dashboard once your access is approved.
Open the docs (sign-in)Create a business account
API keys are issued to an approved business account. Sign up, then request access under Developers.
Create account
Pricing
Production calls are charged per check from your prepaid VerifyAll wallet, at your account’s API price; GST is added separately when you recharge. Sandbox calls are never charged. Your API prices are shown in the dashboard once access is approved. How pricing works
Already have a business account? Sign in to request access
Commercial Credit Report API: frequently asked questions
Answers for teams planning an integration.
Still have questions? Our team is happy to help.
Contact SupportRelated APIs
GST Verification API
LiveInstant answerSend a GSTIN and get the business behind it: names, status, place of business and the returns it has filed, in one call.
View API detailsCIN Verification API
LiveInstant answerSend a Corporate Identification Number and get the company’s name, status, capital, address and compliance dates back in one call.
View API detailsBasic Business Verification API
LiveFinishes laterOne request runs the business checks a KYB review needs and returns one report with an overall result.
View API detailsPAN to CIN API
LiveInstant answerTurn a company’s or LLP’s PAN into its CIN, and get the company’s details in the same answer.
View API details
All credit reports APIsRun Commercial credit report in the dashboard, without codeBrowse the API Marketplace
Start with the Commercial Credit Report API
Request access, build against the Sandbox, then go live with your Production key.