GET
/
v1
/
Business
/
PeerAnalysis
curl --request GET \
  --url https://api.creditriskmonitor.com/v1/Business/PeerAnalysis \
  --header 'Authorization: Bearer <token>'
{
  "Success": true,
  "Data": {
    "PeerYear": 123,
    "PeerQuarter": 123,
    "SIC": "<string>",
    "IndustryName": "<string>",
    "PeerCount": 123,
    "Ratios": [
      {
        "Ratio": "<string>",
        "Value": 123,
        "Max": 123,
        "Min": 123,
        "Median": 123,
        "Count": 123,
        "Rank": 123
      }
    ]
  },
  "ErrorCode": "<string>"
}

Please refer to the Data Fields page to review the fields available under different access models.

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

​
Year
integer

Year to get data for

​
Quarter
integer

Quarter to get data for

​
SICCode
string

SIC Code to filter by

​
SICPrimary
string

Filter by Primary SIC Code only or Primary and Secondary SIC Codes (Y/N)

​
FolderId
integer

Portfolio FolderId

​
TargetCountry
string

Two Letter country code

​
RiskLevelFilter
string

Risk Level (NS - Non-Scored / FS - Non-FRISK Scored / H1 - Risk Level 1 / H2 - Risk Level 1 and 2 / H3 - Risk Level 1, 2 and 3 / H4 - Risk Level 1, 2, 3 and 4 / H5 - Risk Level 1, 2, 3, 4 and 5 / FS - FRISK Scored / FH - FRISK High Risk / FM - FRISK Medium Risk / FL - FRISK Low Risk / F1 - FRISK 1 (Highest Risk) / F2 - FRISK 2 / F3 - FRISK 3 / F4 - FRISK 4 / F5 - FRISK 5 / F6 - FRISK 7 / F8 - FRISK 8 / F9 - FRISK 9 / F10 - FRISK 10 (Lowest Risk))

​
ZScoreFilter
string

Filter by ZScore (N - Non Scored/ S - Scored / H - High Risk / M - Medium Risk / L - Low Risk)

​
PayceScoreFilter
string

Filter by PAYCE Score (N - Non - PAYCE Scored / S - PAYCE Scored / H - PAYCE Score High Risk / M - PAYCE Score Medium Risk / L - PAYCE Score Low Risk)

​
DBTFilter
string

Filter by DBT (S - Scored Customers / N - Non-Scored Customers / D - Delinquent / W - Slow / P - Prompt / 1 - (160+ days beyond terms) / 2 - (91 - 105 days beyond terms) / 3 - (76 - 90 days beyond terms) / 4 - (61 - 75 days beyond terms) / 5 - (46 - 60 days beyond terms) / 6 - (31 - 45 days beyond terms) / 7 - 2(1 - 30 days beyond terms) / 8 - (11 - 20 days beyond terms) / 9 - (0 - 10 days beyond terms) / 10 - (no past due balances for six periods))

​
id
integer

Business ID

​
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