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.
Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessName |
Name of a Business to search for |
string |
Optional |
| PageSize |
Number of rows to return |
integer |
Optional Default value is 15 |
| MatchType |
How to match the Business. NM: Name Match. PN: Phone Match. TS: Ticker Symbol Match. TI: TaxId Match TW: Ticker Symbol Wildcard Match. |
string |
Optional Default value is NM |
| StreetAddress |
Street Address to search against |
string |
Optional |
| CityName |
City Name to search against |
string |
Optional |
| ProvinceName |
State / Province to search against |
string |
Optional |
| PostalCode |
Zip / Postal code to search against |
string |
Optional |
| CountryCode |
Two digit code of the country |
string |
Optional |
| PhoneNumber |
Phone Number to search against. |
string |
Optional |
| TickerSymbol |
Ticker Symbol to search against. |
string |
Optional |
| FederalTaxId |
Federal Tax Id to search against. |
string |
Optional |
| Threshold |
Match Threshold |
integer |
Optional Default value is 15 |
| SearchUniverse |
A: All businesses. P: Public companies only. |
string |
Optional Default value is A |
Response
Collection of APIBusiness| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessId |
ID of the Business |
integer |
None. |
| PrimaryBusinessName |
Name of the Business |
string |
None. |
| Address1 |
Address of the Business |
string |
None. |
| Address2 |
Secondary Address of the Business |
string |
None. |
| CityName |
City of the Business |
string |
None. |
| StateCode |
Two Digit State / Province code |
string |
None. |
| PostalCode |
Zip / Postal code for the Business |
string |
None. |
| CountryName |
Country name for the Business |
string |
None. |
| CountryCode |
Two digit Country Code for the Business |
string |
None. |
| PhoneNumber |
Phone Number for the Business |
string |
None. |
| TradingStatus |
Trading Status for the Business |
string |
None. |
| IncorporatedDate |
Date the Business was Incorporated |
string |
None. |
| IncorporatedIn |
City the Business was Incorporated In |
string |
None. |
| IncorporatedInState |
State the Business was Incorporated In |
string |
None. |
| TickerSymbol |
Ticker Symbol for the Business |
string |
None. |
| StockExchange |
Stock Exchange the Business is in |
string |
None. |
| FederalTaxId |
Federal Tax Id for the Business |
string |
None. |
| CIKNumber |
Central Index Key for the Business |
string |
None. |
| LatestStatementDate |
Date of the Latest Statement for the Business |
date |
None. |
| Employees |
Number of Employees in the Business |
integer |
None. |
| EmployeesAsOfDate |
Date the Number of Employees is accurate as of |
date |
None. |
| MarketCap |
Market Capitalization for the Business |
integer |
None. |
| BusinessNameOfMatch |
Business Name found from Matching |
string |
None. |
| Address1OfMatch |
Address1 found from Matching |
string |
None. |
| Address2OfMatch |
Address2 found from Matching |
string |
None. |
| CityNameOfMatch |
City Name found from Matching |
string |
None. |
| StateCodeOfMatch |
State Code found from Matching |
string |
None. |
| PostalCodeOfMatch |
Zip/Postal Code found from Matching |
string |
None. |
| CountryCodeOfMatch |
Country Code found from Matching |
string |
None. |
| PhoneNumberOfMatch |
Phone Number found from Matching |
string |
None. |
| FaxNumberOfMatch |
Fax Number found from Matching |
string |
None. |
| FriskScore |
FRISKScore of the Business |
byte |
None. |
| FriskScoreDate |
Date of the FRISKScore |
date |
None. |
| PayceScore |
PAYCEScore of the Business |
byte |
None. |
| PayceScoreDate |
Date of the PAYCEScore |
date |
None. |
| MoodysIssuerCount |
If the Business has a Moodys Rating |
integer |
None. |
| FitchRatingCount |
If the Business has a Fitch Rating |
integer |
None. |
| BankruptcyCount |
Count of Bankruptcies for the Business |
integer |
None. |
| JudgmentCount |
Count of Judgements for the Business |
integer |
None. |
| LienCount |
Count of Liens for the Business |
integer |
None. |
| BusinessNewsCount |
Count of News for the Business |
integer |
None. |
| TradePayments |
If Trade Payments are available |
boolean |
None. |
| ParentBusinessId |
The BusinessId of the Parent Business if this Business is a Subsidiary |
integer |
None. |
Example
curl -H "Authorization: Bearer {SessionKey}" -X GET https://api.creditriskmonitor.com/v1/BusinessLookup/{BusinessName}