Company Score and Calculated Credit Limit¶
Use this API to retrieve the latest company score and calculated credit limit associated with a company
GET https://arc-aegis.billtrust.com/creditprofile/api/v1/tenants/{tenantId}/company/{companyId}/score
- {companyId} is the identifier for the buyer company of a credit application.
Example:
curl -X GET 'https://arc-aegis.billtrust.com/creditprofile/api/v1/tenants/{tenantId}/company/{companyId}/score \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Billtrust-Api-Key: <API key value>'
If successful, this will return a body containing all the information of the score and calculated credit limit for that company. Below is a sample response that contains company score information with the respective data types.
Company Information Response¶
{
"fibs": {
"fibs_confidence": 86,
"fibs_score": 56,
},
"dibs": {
"dibs_score": 32,
"dibs_confidence": 89,
},
"creditLimit": 70000,
"bankruptcyFlag": 0,
"outOfBusinessFlag": 0
}
- fibs - Payment Outlook Index
- dibs - Business Viability Index
- creditLimit - Calculated Credit Limit
- bankruptcyFlag - Indicates whether the company has filed for a bankruptcy
- outOfBusinessFlag - Indicates whether the company is out of business