Data Dictionary

API Description
CreditRiskMonitor Data Dictionary Documentation on the data points available via api.creditriskmonitor.com.

BusinessLookup

APIDescription
GET v1/BusinessLookup?BusinessName={BusinessName}&PageSize={PageSize}&MatchType={MatchType}&StreetAddress={StreetAddress}&CityName={CityName}&ProvinceName={ProvinceName}&PostalCode={PostalCode}&CountryCode={CountryCode}&PhoneNumber={PhoneNumber}&TickerSymbol={TickerSymbol}&Threshold={Threshold}&SearchUniverse={SearchUniverse}

Searches for a Business.

Business

APIDescription
GET v1/Business/{id}/ReportPDF?layout={layout}&encoding={encoding}

Generates and returns a PDF report for the Business

GET v1/Business/ReportPDF?layout={layout}&encoding={encoding}&id={id}

Generates and returns a PDF report for the Business

GET v1/Business/{id}/Officers

Gets the officers for this Business

GET v1/Business/Officers?id={id}

Gets the officers for this Business

GET v1/Business/{id}/News

Gets the 20 most recent news articles about this business

GET v1/Business/News?id={id}

Gets the 20 most recent news articles about this business

GET v1/Business/{id}/Summary

Gets the summary text for a Business.

GET v1/Business/Summary?id={id}

Gets the summary text for a Business.

GET v1/Business/{id}/WordFill

Gets the WordFill for a Business.

GET v1/Business/WordFill?id={id}

Gets the WordFill for a Business.

GET v1/Business/{id}/FSR

Gets the Experian FSR for a Business

GET v1/Business/FSR?id={id}

Gets the Experian FSR for a Business

GET v1/Business/{id}/PeerAnalysis?Year={Year}&Quarter={Quarter}&SICCode={SICCode}&SICPrimary={SICPrimary}&FolderId={FolderId}&TargetCountry={TargetCountry}&RiskLevelFilter={RiskLevelFilter}&ZScoreFilter={ZScoreFilter}&PayceScoreFilter={PayceScoreFilter}&DBTFilter={DBTFilter}

Gets the Peer Analysis for a Business.

GET v1/Business/PeerAnalysis?Year={Year}&Quarter={Quarter}&SICCode={SICCode}&SICPrimary={SICPrimary}&FolderId={FolderId}&TargetCountry={TargetCountry}&RiskLevelFilter={RiskLevelFilter}&ZScoreFilter={ZScoreFilter}&PayceScoreFilter={PayceScoreFilter}&DBTFilter={DBTFilter}&id={id}

Gets the Peer Analysis for a Business.

GET v1/Business/{id}/NAICSCodes

Gets the NAICS Codes for a Business

GET v1/Business/NAICSCodes?id={id}

Gets the NAICS Codes for a Business

GET v1/Business/{id}/SICCodes

Gets the SIC Codes for a Business

GET v1/Business/SICCodes?id={id}

Gets the SIC Codes for a Business

GET v1/Business/{id}/CreditScoreHistory

Gets the FRISK, PAYCE, DBT, and Z-Score history for a business.

GET v1/Business/CreditScoreHistory?id={id}

Gets the FRISK, PAYCE, DBT, and Z-Score history for a business.

GET v1/Business/{id}/FRISKHistory?count={count}

Gets the FRISKHistory for a Business.

GET v1/Business/FRISKHistory?id={id}&count={count}

Gets the FRISKHistory for a Business.

GET v1/Business/{id}/LatestAnnualStatements?count={count}

Gets the Latest Annual Statements for a Business

GET v1/Business/LatestAnnualStatements?id={id}&count={count}

Gets the Latest Annual Statements for a Business

GET v1/Business/{id}/LatestInterimStatements?count={count}

Gets the Latest Interim Statements for a Business

GET v1/Business/LatestInterimStatements?id={id}&count={count}

Gets the Latest Interim Statements for a Business

GET v1/Business/{id}/LatestYTDStatements?count={count}

Gets the latest Year To Date statements for a business

GET v1/Business/LatestYTDStatements?id={id}&count={count}

Gets the latest Year To Date statements for a business

GET v1/Business/{id}/CustomLayout/{Layout}

Gets the results for a custom layout.

GET v1/Business/CustomLayout/{Layout}?id={id}

Gets the results for a custom layout.

GET v1/Business/{id}

Returns the Identification Group for a single Business.

GET v1/Business/{id}/IdentificationGroup

Returns the Identification Group for a single Business.

GET v1/Business/IdentificationGroup?id={id}

Returns the Identification Group for a single Business.

GET v1/Business/{id}/Subsidiaries?FirstRow={FirstRow}&LastRow={LastRow}

Gets a list of Subsidiaries for a single Business.

GET v1/Business/Subsidiaries?id={id}&FirstRow={FirstRow}&LastRow={LastRow}

Gets a list of Subsidiaries for a single Business.

GET v1/Business/{id}/BusinessNames?FirstRow={FirstRow}&LastRow={LastRow}

Returns the Business Names for a Business

GET v1/Business/BusinessNames?id={id}&FirstRow={FirstRow}&LastRow={LastRow}

Returns the Business Names for a Business

GET v1/Business/{id}/PaymentSummary/Monthly

Returns the Payment Summary for the Business

GET v1/Business/PaymentSummary/Monthly?id={id}

Returns the Payment Summary for the Business

GET v1/Business/{id}/PaymentSummary/SIC

Returns the Payment Summary for the Business

GET v1/Business/PaymentSummary/SIC?id={id}

Returns the Payment Summary for the Business

GET v1/Business/{id}/CreditLimit

Gets the Credit Limit for the company

GET v1/Business/CreditLimit?id={id}

Gets the Credit Limit for the company

POST v1/Business/{id}/CreditLimit?MonitorHi={MonitorHi}&MonitorLo={MonitorLo}

Creates a new Credit Limit

POST v1/Business/CreditLimit?MonitorHi={MonitorHi}&MonitorLo={MonitorLo}&id={id}

Creates a new Credit Limit

News

APIDescription
GET v1/News?Subset={Subset}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the top 20 News stories for the current user

GET v1/News/{id}

Gets a single News Story

GET v1/Industries/{id}/News

Gets the top 20 News stories for this industry

GET v1/SICCodes/{SICCode}/News

Gets the top 20 News stories for this SIC Code

User

APIDescription
POST v1/Users/Login

Logs a user in

GET v1/Users/Info

Gets the User Info for the currently logged in user

POST v1/Users/2FAKey

Accepts a Two Factor Authentication Key

Portfolio

APIDescription
GET v1/Portfolio?FirstRow={FirstRow}&LastRow={LastRow}

Returns the Bussinesses in the current user's Portfolio.

POST v1/Portfolio

Adds or Removes Businesses from the Portfolio

GET v1/Portfolio/Folders

Gets the Portfolio Folders for the current user

POST v1/Portfolio/Folders

Creates or Deletes a Portfolio Folder for the current user

POST v1/Portfolio/Folders/{FolderId}

Adds or Removes Businesses from a Folder

GET v1/Portfolio/Folders/{FolderId}?FirstRow={FirstRow}&LastRow={LastRow}

Gets the Businesses in a Folder

GET v1/Portfolio/Folders/{FolderId}/News

Gets the News for Businesses in a Folder

GET v1/Portfolio/News

Gets the News for Businesses in the Portfolio

GET v1/Portfolio/Download?Format={Format}&Layout={Layout}&Folder={Folder}

Downloads the Portfolio

GET v1/Portfolio/Folders/{FolderId}/ZScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly Z Scores for Businesses in the selected Folder

GET v1/Portfolio/ZScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly Z Scores for Businesses in the current user's portfolio

GET v1/Portfolio/Folders/{FolderId}/DBTScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly DBT Scores for Businesses in the selected Folder

GET v1/Portfolio/DBTScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly DBT Scores for Businesses in the current user's portfolio

GET v1/Portfolio/Folders/{FolderId}/PAYCEScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly PAYCE Scores for Businesses in the selected Folder

GET v1/Portfolio/PAYCEScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly PAYCE Scores for Businesses in the current user's portfolio

GET v1/Portfolio/Folders/{FolderId}/FRISKScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly FRISK Scores for Businesses in the selected Folder

GET v1/Portfolio/FRISKScoreHistory?StartDate={StartDate}&EndDate={EndDate}&FirstRow={FirstRow}&LastRow={LastRow}

Gets the Monthly FRISK Scores for Businesses in the current user's portfolio