GET
/
v1
/
Business
/
CreditLimit
curl --request GET \
  --url https://api.creditriskmonitor.com/v1/Business/CreditLimit \
  --header 'Authorization: <api-key>'
{
  "Success": true,
  "Data": {
    "MaxLimit": 123,
    "RecommendedCreditLimit": 123,
    "ZScore": 123,
    "StockVolatility": 123,
    "Leverage": 123,
    "LatestStatementDate": "2023-11-07T05:31:56Z",
    "Rationale": "<string>",
    "AvgTransaction": 123,
    "TransactionLimit": 123,
    "MaxExpectedLossLimit": 123,
    "RiskAppetite": "<string>",
    "CostOfCapital": 123,
    "GrossMargin": 123,
    "ExistingCreditLimit": 123,
    "MonitorFlag": "<string>",
    "MonitorHi": 123,
    "MonitorLo": 123,
    "CurrencyCode": "<string>",
    "BusinessId": 123,
    "PrimaryBusinessName": "<string>"
  },
  "ErrorCode": "<string>"
}

Use the Login endpoint to retrieve the SessionKey, then include it in the Authorization field for authentication.

Authorizations

​
Authorization
string
header
required

Enter the Session Key with the Bearer prefix, e.g. "Bearer abcde12345".

Query Parameters

​
id
integer

BusinessId of the Business to get a Credit Limit for

​
CustomerId
string

If you are a Trade Provider you can use your CustomerId to idenfity a Business with the CustomerId parameter.

​
SupplierId
string

If you have a Supplier List you can use your SupplierId to identify a Business with the SupplierId parameter.

Response

200
application/json
OK
​
Success
boolean
​
Data
object
​
ErrorCode
string

Was this page helpful?