CreditRiskMonitor API Help Page

Data Dictionary

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

BusinessLookup

API	Description
GET v1/BusinessLookup?BusinessName={BusinessName}&PageSize={PageSize}&MatchType={MatchType}&StreetAddress={StreetAddress}&CityName={CityName}&ProvinceName={ProvinceName}&PostalCode={PostalCode}&CountryCode={CountryCode}&PhoneNumber={PhoneNumber}&TickerSymbol={TickerSymbol}&FederalTaxId={FederalTaxId}&Threshold={Threshold}&SearchUniverse={SearchUniverse}	Searches for a Business.

TradeProvider

API	Description
GET v1/Trade/TradeProviders	Gets the list of Trade Providers
POST v1/Trade/TradeProviders	Sets the Trade Provider Id to use if more than one are available. Necessary for referencing a Business by CustomerId if there are more than 1 Trade Provider Ids on a user account.
GET v1/Trade/TradeProviders/Accounts?Layout={Layout}&FromDate={FromDate}	Returns Trade Provider accounts.

Business

API	Description
GET v1/Business/IdentificationGroup?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Returns the Identification Group for a single Business.
GET v1/Business/ReportPDF?layout={layout}&encoding={encoding}&id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&Breakpoint={Breakpoint}	Generates and returns a PDF report for the Business
GET v1/Business/Officers?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the officers for this Business
GET v1/Business/News?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the 20 most recent news articles about this business
GET v1/Business/Summary?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the summary text for a Business.
GET v1/Business/WordFill?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the WordFill for a Business.
GET v1/Business/FSR?id={id}&CustomerId={CustomerId}	Gets the Experian FSR 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}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the Peer Analysis for a Business.
GET v1/Business/NAICSCodes?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the NAICS Codes for a Business
GET v1/Business/SICCodes?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the SIC Codes for a Business
GET v1/Business/CreditScoreHistory?id={id}&StartDate={StartDate}&EndDate={EndDate}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the FRISK, PAYCE, DBT, and Z-Score history for a business.
GET v1/Business/FRISKHistory?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&count={count}	Gets the FRISKHistory for a Business.
GET v1/Business/LatestAnnualStatements?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&count={count}&StandardYear={StandardYear}&SortOrder={SortOrder}	Gets the Latest Annual Statements for a Business
GET v1/Business/LatestInterimStatements?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&count={count}&StandardQuarter={StandardQuarter}&StandardYear={StandardYear}&SortOrder={SortOrder}	Gets the Latest Interim Statements for a Business
GET v1/Business/LatestYTDStatements?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&count={count}&StandardYear={StandardYear}&SortOrder={SortOrder}	Gets the latest Year To Date statements for a business
GET v1/Business/CustomLayout?Layout={Layout}&id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	No documentation available.
GET v1/Business/Subsidiaries?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&FirstRow={FirstRow}&LastRow={LastRow}	Gets a list of Subsidiaries for a single Business.
GET v1/Business/BusinessNames?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&FirstRow={FirstRow}&LastRow={LastRow}	Returns the Business Names for a Business
GET v1/Business/PaymentSummary/Monthly?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Returns the Payment Summary for the Business
GET v1/Business/PaymentSummary/SIC?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Returns the Payment Summary for the Business
GET v1/Business/CreditLimit?id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}	Gets the Credit Limit for the company
POST v1/Business/CreditLimit?MonitorHi={MonitorHi}&MonitorLo={MonitorLo}&id={id}	Creates a new Credit Limit

News

API	Description
GET v1/News?Subset={Subset}&FirstRow={FirstRow}&LastRow={LastRow}	Gets the top 20 News stories for the current user
GET v1/Industries/News?id={id}	Gets the top 20 News stories for this industry
GET v1/SICCodes/News?SICCode={SICCode}	Gets the top 20 News stories for this SIC Code

User

API	Description
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

API	Description
GET v1/Portfolio?FirstRow={FirstRow}&LastRow={LastRow}&FromDate={FromDate}	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}&FromDate={FromDate}	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