Dela via


ORB Intelligence (Independent Publisher) (Preview)

Orb provides with a framework of API calls to use the Orb database for various use cases. The framework comprises five calls, Match, Fetch, Search, Lookalike and Corporate Tree.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Aaryan Arora, Ankita Singh
Email aaryan2134@gmail.com
Connector Metadata
Publisher Aaryan Arora, Ankita Singh
Website http://orb-intelligence.com
Privacy policy https://www.dnb.com/utility-pages/privacy-policy.html
Categories Business Intelligence; Sales and CRM

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
apiKey_auth securestring The apiKey_auth for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Obtain a full company profile from the Orb database

The Fetch API call allows a user to obtain a full company profile from the Orb database, based on an Orb Number. The Orb Number for a company record can be obtained from a choosing a candidate from the Match call or from a previously identified matched record. The Fetch API call will return back all the standard fields in the Orb database for a single company record that corresponds to the Orb Number.

Retrieves a list of companies for the given search criteria

The Search API call allows a user to retrieve a list of companies for the given search criteria. This enables a user to build out a list of companies for use cases such as building out a list of companies in a specific territory or segment. The input to the Search call are a list of filtering attributes that define the companies in the list. These filters can include the geographic location of the companies (at a city, state or country level), revenue, number of employees and their industry profile (e.g., SIC, NAICS, or Orb's proprietary categories classification).

Retrieves a list of companies similar to a target company

The Lookalike API call allows a user to retrieve a list of companies similar to a target company. The input to the Lookalike call are the Orb Number of the target company.

Retrieves full corporate tree of subsidiaries

The Corporate Tree API call allows a user to retrieve full corporate tree of subsidiaries for a given company, starting from its ultimate parent company. The input to the Corporate Tree call is the Orb Number of the target company (mandatory field).

The Match API call performs a candidate retrieval process

The Match API call performs a candidate retrieval process; the process by which Orb records are identified as potential matches to the query. The input fields must either include the name and country, or the website/email, or the EIN of the company record. All other fields are optional. Users can review the candidates to choose their preferred match based on the candidate with the highest Confidence Score, algorithmically, based on the match mask (for example, take those that match by website, even though the name didn't match) or manually.

Obtain a full company profile from the Orb database

The Fetch API call allows a user to obtain a full company profile from the Orb database, based on an Orb Number. The Orb Number for a company record can be obtained from a choosing a candidate from the Match call or from a previously identified matched record. The Fetch API call will return back all the standard fields in the Orb database for a single company record that corresponds to the Orb Number.

Parameters

Name Key Required Type Description
API Access Key.
api_key string

API Access Key.

Orb Number
orb_num True string

Orb Number

Returns

Name Path Type Description
Orb Number
orb_num integer

Orb Number

orb_nums
orb_nums array of integer

Secondary Orb Numbers

name
name string

Company name

parent_orb_num
parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
parent_name string

Name of a parent company.

ultimate_parent_orb_num
ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
subsidiaries_count integer

Number of subsidiaries

branches_count
branches_count integer

Number of company branches/locations

names
names array of string

Company's other names - tradestyles, DBA names, former names, abbreviations

website
website string

Company's website

webdomain
webdomain string

Company's web domain

webdomains
webdomains array of string

All company's web domains

webdomains_info
webdomains_info array of object

All company's web domains with additional info: domain_has_email; domain_has_website; domain_is_email_hosting - such as gmail.com, hotmail.com; orb_web_rank - normalized Alexa rank

orb_web_rank
webdomains_info.orb_web_rank integer

is a normalized Alexa rank. The normalization handles two cases: 1. Alexa service does not have this web domain in their database, so there is no Alexa rank for this web domain, then we set it to the maximum - 39999999; 2. For third and higher -level domains, like for example, dolls.stores.shop.ebay.com Alexa service returns alexa rank for ebay.com, which is not good in our use case, as it is a small online shop, not Ebay website. We set this to 39999999.

domain_has_website
webdomains_info.domain_has_website integer
domain_is_email_hosting
webdomains_info.domain_is_email_hosting integer

1 if this domain is a popular email service provider, such as, for example, gmail.com, yahoo.com, outlook.com and others. 1 - the domain is an email service provider; 0 - we are not aware of any popular email service provider with this domain. This flag is useful when the domain you want to get company information for was extracted from a person's contact email. So, for example, when it is 'yahoo.com', it does not mean that the person works at Yahoo!

webdomain
webdomains_info.webdomain string
domain_has_email
webdomains_info.domain_has_email integer
address1
address.address1 string

Address Line 1

address2
address.address2 string

Address Line 2

city
address.city string

Address Line 2

state
address.state string

Address Line 2

zip
address.zip string

Zip Code

country
address.country string

Country

industry
industry string

Orb proprietary industry class

naics_code
naics_code string

Primary NAICS code according to 2012 Census.gov standard

naics_description
naics_description string

Primary NAICS code description

naics_codes
naics_codes array of object

Array of secondary NAICS codes

code
naics_codes.code string

Industry Code

description
naics_codes.description string

Industry Description

sic_code
sic_code string

Primary SIC code according to 1987 standard

sic_description
sic_description string

Primary SIC description

sic_codes
sic_codes array of object

Array of secondary SIC codes

code
sic_codes.code string

Industry Code

description
sic_codes.description string

Industry Description

categories
categories array of object

Array of Orb proprietary business categories with weights

name
categories.name string

Category Name

weight
categories.weight float

Category Weight

employees_range
employees_range string

Number of employees range

employees
employees integer

Number of employees

revenue_range
revenue_range string

Revenue range

revenue
revenue integer

Revenue

year_founded
year_founded integer

Year company was founded

description
description string

Textual description of the company

url
linkedin_account.url string
likes
linkedin_account.likes integer
followers
linkedin_account.followers integer
url
facebook_account.url string
likes
facebook_account.likes integer
followers
facebook_account.followers integer
url
twitter_account.url string
likes
twitter_account.likes integer
followers
twitter_account.followers integer
url
googleplus_account.url string
likes
googleplus_account.likes integer
followers
googleplus_account.followers integer
url
youtube_account.url string
likes
youtube_account.likes integer
followers
youtube_account.followers integer
technologies
technologies array of object

List of frontend technologies installed on the company's website

name
technologies.name string
rankings
rankings array of string

Popular list the company may be included, such as Fortune, Forbes, Inc.com

ranking_positions
ranking_positions array of object

Popular list the company may be included, such as Fortune, Forbes, Inc.com (with positions)

ranking
ranking_positions.ranking string
position
ranking_positions.position integer
eins
eins array of string

U.S. Federal Employer Identification Number

npis
npis array of string

National Provider Identifier (NPI), a unique 10-digit identification number issued to health care providers in the United States.

favicon
favicon string

URL to the company's favicon

total_funding
total_funding integer

Total funding amount raised by the company

last_funding_round_amount
last_funding_round_amount integer

Last funding round amount

last_funding_round_year
last_funding_round_year integer

Last funding round year

phone
phone string

General phone number of the company

fax
fax string

Company's fax number

email
email string

General email of the company

importance_score
importance_score string

Importance score: A, B or C. See documentation for more details

tickers
tickers array of object

Stock exchange tickers if the company is publicly listed.Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

exchange
tickers.exchange string
ticker
tickers.ticker string
market_cap
market_cap integer
cik
cik string
cusip
cusip string
fiscal_year_end
fiscal_year_end string
cidrs_count
cidrs_count integer
liveramp_idl_count
liveramp_idl_count integer
liveramp_device_count
liveramp_device_count integer
latitude
latitude string
longitude
longitude string

Retrieves a list of companies for the given search criteria

The Search API call allows a user to retrieve a list of companies for the given search criteria. This enables a user to build out a list of companies for use cases such as building out a list of companies in a specific territory or segment. The input to the Search call are a list of filtering attributes that define the companies in the list. These filters can include the geographic location of the companies (at a city, state or country level), revenue, number of employees and their industry profile (e.g., SIC, NAICS, or Orb's proprietary categories classification).

Parameters

Name Key Required Type Description
API Access Key.
api_key string

API Access Key.

Number of results in response (in a page).
limit integer

Number of results in response (in a page).

Number of results to skip (to get a particular page).
offset integer

Number of results to skip (to get a particular page).

Entity Type(company or branch)
entity_type string

Entity Type(company or branch)

Parent Orb Number
parent_orb_num string

Parent Orb Number

Ultimate Parent Orb Number
ultimate_parent_orb_num integer

Ultimate Parent Orb Number

Company's industry.
industry string

Company's industry. Use GET /dictionaries/industries to get a list of all industry names

Filter by address line 1
address1 string

Filter by address line 1

Filter by city
city string

Filter by city

Filter by state
state string

Filter by state

Filter by zip code
zip string

Filter by zip code

Filter by country
country string

Filter by country

Number of employees
employees array

Number of employees

Revenue
revenue array

Revenue

Filter by techonologies installed.
techs string

Filter by techonologies installed. Use GET /dictionaries/technologies to get a list of all technologies names that we track

Filter by techonologies classes
tech_categories string

Filter by techonologies classes. Use GET /dictionaries/technologies/categories to get a list of all technologies classes

Filter by NAICS code
naics_codes string

Filter by NAICS code

Filter by SIC code
sic_codes string

Filter by SIC code

Get companies from companies ranked lists
rankings string

Get companies from companies ranked lists, such as Forbes, Fortune or Inc.5000. Get the full list of rankings using GET /dictionaries/rankings

Filter companies by importances classes A, B or C
importance_score string

Filter companies by importances classes A, B or C. See description of our importance classes in internal documentation

Filter by CIK (The Central Index Key from SEC).
cik string

Filter by CIK (The Central Index Key from SEC).

Filter by CUSIP (https://en.wikipedia.org/wiki/CUSIP).
cusip string

Filter by CUSIP (https://en.wikipedia.org/wiki/CUSIP).

Filter by stock exchange ticker.
ticker string

Filter by stock exchange ticker.

Filter by stock exchange
exchange string

Filter by stock exchange. Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

Embed full company profile
show_full_profile boolean

Embed full company profile

Extra output fields to include in response
include string

Extra output fields to include in response, for example optional orb_nums field.

Orb Number of the company.
orb_num integer

Orb Number of the company.

Categories
categories array

Categories

Returns

Name Path Type Description
request_fields
request_fields object

Input data to search

facets
facets object
results_count
results_count integer
results
results array of object
orb_num
results.orb_num integer

Orb Number of the candidate profile.

orb_nums
results.orb_nums array of integer

Secondary Orb Numbers of the candidate profile. Hidden by default, use include option to show.

name
results.name string

Company's name.

entity_type
results.entity_type string

"company" or "branch".

company_status
results.company_status string

"active" or "inactive".

parent_orb_num
results.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.subsidiaries_count integer

Number of subsidiaries

branches_count
results.branches_count integer

Number of company branches/locations

is_standalone_company
results.is_standalone_company boolean

Company is considered as standalone if it does not have parent and subsidiaries.

address1
results.address1 string

First line of the company's address.

city
results.city string

City.

state
results.state string

State.

zip
results.zip string

Zip code.

country
results.country string

Country.

iso_country_code
results.iso_country_code string

ISO country code.

fetch_url
results.fetch_url string

'Fetch' API call to retrieve the full company profile for this Orb Number.

orb_num
results.full_profile.orb_num integer

Orb Number

orb_nums
results.full_profile.orb_nums array of integer

Secondary Orb Numbers

name
results.full_profile.name string

Company name

parent_orb_num
results.full_profile.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.full_profile.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.full_profile.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.full_profile.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.full_profile.subsidiaries_count integer

Number of subsidiaries

branches_count
results.full_profile.branches_count integer

Number of company branches/locations

names
results.full_profile.names array of string

Company's other names - tradestyles, DBA names, former names, abbreviations

website
results.full_profile.website string

Company's website

webdomain
results.full_profile.webdomain string

Company's web domain

webdomains
results.full_profile.webdomains array of string

All company's web domains

webdomains_info
results.full_profile.webdomains_info array of object

All company's web domains with additional info: domain_has_email; domain_has_website; domain_is_email_hosting - such as gmail.com, hotmail.com; orb_web_rank - normalized Alexa rank

orb_web_rank
results.full_profile.webdomains_info.orb_web_rank integer

is a normalized Alexa rank. The normalization handles two cases: 1. Alexa service does not have this web domain in their database, so there is no Alexa rank for this web domain, then we set it to the maximum - 39999999; 2. For third and higher -level domains, like for example, dolls.stores.shop.ebay.com Alexa service returns alexa rank for ebay.com, which is not good in our use case, as it is a small online shop, not Ebay website. We set this to 39999999.

domain_has_website
results.full_profile.webdomains_info.domain_has_website integer
domain_is_email_hosting
results.full_profile.webdomains_info.domain_is_email_hosting integer

1 if this domain is a popular email service provider, such as, for example, gmail.com, yahoo.com, outlook.com and others. 1 - the domain is an email service provider; 0 - we are not aware of any popular email service provider with this domain. This flag is useful when the domain you want to get company information for was extracted from a person's contact email. So, for example, when it is 'yahoo.com', it does not mean that the person works at Yahoo!

webdomain
results.full_profile.webdomains_info.webdomain string
domain_has_email
results.full_profile.webdomains_info.domain_has_email integer
address1
results.full_profile.address.address1 string

Address Line 1

address2
results.full_profile.address.address2 string

Address Line 2

city
results.full_profile.address.city string

Address Line 2

state
results.full_profile.address.state string

Address Line 2

zip
results.full_profile.address.zip string

Zip Code

country
results.full_profile.address.country string

Country

industry
results.full_profile.industry string

Orb proprietary industry class

naics_code
results.full_profile.naics_code string

Primary NAICS code according to 2012 Census.gov standard

naics_description
results.full_profile.naics_description string

Primary NAICS code description

naics_codes
results.full_profile.naics_codes array of object

Array of secondary NAICS codes

code
results.full_profile.naics_codes.code string

Industry Code

description
results.full_profile.naics_codes.description string

Industry Description

sic_code
results.full_profile.sic_code string

Primary SIC code according to 1987 standard

sic_description
results.full_profile.sic_description string

Primary SIC description

sic_codes
results.full_profile.sic_codes array of object

Array of secondary SIC codes

code
results.full_profile.sic_codes.code string

Industry Code

description
results.full_profile.sic_codes.description string

Industry Description

categories
results.full_profile.categories array of object

Array of Orb proprietary business categories with weights

name
results.full_profile.categories.name string

Category Name

weight
results.full_profile.categories.weight integer

Category Weight

employees_range
results.full_profile.employees_range string

Number of employees range

employees
results.full_profile.employees integer

Number of employees

revenue_range
results.full_profile.revenue_range string

Revenue range

revenue
results.full_profile.revenue integer

Revenue

year_founded
results.full_profile.year_founded integer

Year company was founded

description
results.full_profile.description string

Textual description of the company

url
results.full_profile.linkedin_account.url string
likes
results.full_profile.linkedin_account.likes integer
followers
results.full_profile.linkedin_account.followers integer
url
results.full_profile.facebook_account.url string
likes
results.full_profile.facebook_account.likes integer
followers
results.full_profile.facebook_account.followers integer
url
results.full_profile.twitter_account.url string
likes
results.full_profile.twitter_account.likes integer
followers
results.full_profile.twitter_account.followers integer
url
results.full_profile.googleplus_account.url string
likes
results.full_profile.googleplus_account.likes integer
followers
results.full_profile.googleplus_account.followers integer
url
results.full_profile.youtube_account.url string
likes
results.full_profile.youtube_account.likes integer
followers
results.full_profile.youtube_account.followers integer
technologies
results.full_profile.technologies array of object

List of frontend technologies installed on the company's website

name
results.full_profile.technologies.name string
rankings
results.full_profile.rankings array of string

Popular list the company may be included, such as Fortune, Forbes, Inc.com

ranking_positions
results.full_profile.ranking_positions array of object

Popular list the company may be included, such as Fortune, Forbes, Inc.com (with positions)

ranking
results.full_profile.ranking_positions.ranking string
position
results.full_profile.ranking_positions.position integer
eins
results.full_profile.eins array of string

U.S. Federal Employer Identification Number

npis
results.full_profile.npis array of string

National Provider Identifier (NPI), a unique 10-digit identification number issued to health care providers in the United States.

favicon
results.full_profile.favicon string

URL to the company's favicon

total_funding
results.full_profile.total_funding integer

Total funding amount raised by the company

last_funding_round_amount
results.full_profile.last_funding_round_amount integer

Last funding round amount

last_funding_round_year
results.full_profile.last_funding_round_year integer

Last funding round year

phone
results.full_profile.phone string

General phone number of the company

fax
results.full_profile.fax string

Company's fax number

email
results.full_profile.email string

General email of the company

importance_score
results.full_profile.importance_score string

Importance score: A, B or C. See documentation for more details

tickers
results.full_profile.tickers array of object

Stock exchange tickers if the company is publicly listed.Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

exchange
results.full_profile.tickers.exchange string
ticker
results.full_profile.tickers.ticker string
market_cap
results.full_profile.market_cap integer
cik
results.full_profile.cik string
cusip
results.full_profile.cusip string
fiscal_year_end
results.full_profile.fiscal_year_end string
cidrs_count
results.full_profile.cidrs_count integer
liveramp_idl_count
results.full_profile.liveramp_idl_count integer
liveramp_device_count
results.full_profile.liveramp_device_count integer
latitude
results.full_profile.latitude string
longitude
results.full_profile.longitude string

Retrieves a list of companies similar to a target company

The Lookalike API call allows a user to retrieve a list of companies similar to a target company. The input to the Lookalike call are the Orb Number of the target company.

Parameters

Name Key Required Type Description
API Access Key
api_key string

API Access Key.

Number of results in response (in a page).
limit integer

Number of results in response (in a page).

Number of results to skip (to get a particular page).
offset integer

Number of results to skip (to get a particular page).

Company's industry
industry string

Company's industry. Use GET /dictionaries/industries to get a list of all industry names

Filter by address line 1
address1 string

Filter by address line 1

Filter by city
city string

Filter by city

Filter by state
state string

Filter by state

Filter by zip code
zip string

Filter by zip code

Filter by country
country string

Filter by country

Number of Employees
employees array

Number of Employees

Revenue
revenue array

Revenue

Filter by techonologies installed
techs string

Filter by techonologies installed. Use GET /dictionaries/technologies to get a list of all technologies names that we track

Filter by techonologies classes
tech_categories string

Filter by techonologies classes. Use GET /dictionaries/technologies/categories to get a list of all technologies classes

Filter by NAICS code
naics_codes string

Filter by NAICS code

Filter by SIC code
sic_codes string

Filter by SIC code

Get companies from companies ranked lists
rankings string

Get companies from companies ranked lists, such as Forbes, Fortune or Inc.5000. Get the full list of rankings using GET /dictionaries/rankings

Filter by CIK (The Central Index Key from SEC).
cik string

Filter by CIK (The Central Index Key from SEC).

Filter by CUSIP (https://en.wikipedia.org/wiki/CUSIP).
cusip string

Filter by CUSIP (https://en.wikipedia.org/wiki/CUSIP).

Filter by stock exchange ticker.
ticker string

Filter by stock exchange ticker.

Filter by stock exchange
exchange string

Filter by stock exchange. Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

Embed full company profile
show_full_profile boolean

Embed full company profile

Extra output fields to include in response
include string

Extra output fields to include in response, for example optional orb_nums field.

Orb Number of the company to get a list of look-alikes for.
orb_num True integer

Orb Number of the company to get a list of look-alikes for.

Returns

Name Path Type Description
request_fields
request_fields object

Input data to search

facets
facets object
results_count
results_count integer
results
results array of object
orb_num
results.orb_num integer

Orb Number of the candidate profile.

orb_nums
results.orb_nums array of integer

Secondary Orb Numbers of the candidate profile. Hidden by default, use include option to show.

name
results.name string

Company's name.

entity_type
results.entity_type string

"company" or "branch".

company_status
results.company_status string

"active" or "inactive".

parent_orb_num
results.parent_orb_num string

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.ultimate_parent_orb_num string

Orb Number of the ultimate parent company.

ultimate_parent_name
results.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.subsidiaries_count integer

Number of subsidiaries

branches_count
results.branches_count integer

Number of company branches/locations

is_standalone_company
results.is_standalone_company boolean

Company is considered as standalone if it does not have parent and subsidiaries.

address1
results.address1 string

First line of the company's address.

city
results.city string

City.

state
results.state string

State.

zip
results.zip string

Zip code.

country
results.country string

Country.

iso_country_code
results.iso_country_code string

ISO country code.

fetch_url
results.fetch_url string

'Fetch' API call to retrieve the full company profile for this Orb Number.

orb_num
results.full_profile.orb_num integer

Orb Number

orb_nums
results.full_profile.orb_nums array of integer

Secondary Orb Numbers

name
results.full_profile.name string

Company name

parent_orb_num
results.full_profile.parent_orb_num string

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.full_profile.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.full_profile.ultimate_parent_orb_num string

Orb Number of the ultimate parent company.

ultimate_parent_name
results.full_profile.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.full_profile.subsidiaries_count integer

Number of subsidiaries

branches_count
results.full_profile.branches_count integer

Number of company branches/locations

names
results.full_profile.names array of string

Company's other names - tradestyles, DBA names, former names, abbreviations

website
results.full_profile.website string

Company's website

webdomain
results.full_profile.webdomain string

Company's web domain

webdomains
results.full_profile.webdomains array of string

All company's web domains

webdomains_info
results.full_profile.webdomains_info array of object

All company's web domains with additional info: domain_has_email; domain_has_website; domain_is_email_hosting - such as gmail.com, hotmail.com; orb_web_rank - normalized Alexa rank

orb_web_rank
results.full_profile.webdomains_info.orb_web_rank integer

is a normalized Alexa rank. The normalization handles two cases: 1. Alexa service does not have this web domain in their database, so there is no Alexa rank for this web domain, then we set it to the maximum - 39999999; 2. For third and higher -level domains, like for example, dolls.stores.shop.ebay.com Alexa service returns alexa rank for ebay.com, which is not good in our use case, as it is a small online shop, not Ebay website. We set this to 39999999.

domain_has_website
results.full_profile.webdomains_info.domain_has_website integer
domain_is_email_hosting
results.full_profile.webdomains_info.domain_is_email_hosting integer

1 if this domain is a popular email service provider, such as, for example, gmail.com, yahoo.com, outlook.com and others. 1 - the domain is an email service provider; 0 - we are not aware of any popular email service provider with this domain. This flag is useful when the domain you want to get company information for was extracted from a person's contact email. So, for example, when it is 'yahoo.com', it does not mean that the person works at Yahoo!

webdomain
results.full_profile.webdomains_info.webdomain string
domain_has_email
results.full_profile.webdomains_info.domain_has_email integer
address1
results.full_profile.address.address1 string

Address Line 1

address2
results.full_profile.address.address2 string

Address Line 2

city
results.full_profile.address.city string

Address Line 2

state
results.full_profile.address.state string

Address Line 2

zip
results.full_profile.address.zip string

Zip Code

country
results.full_profile.address.country string

Country

industry
results.full_profile.industry string

Orb proprietary industry class

naics_code
results.full_profile.naics_code string

Primary NAICS code according to 2012 Census.gov standard

naics_description
results.full_profile.naics_description string

Primary NAICS code description

naics_codes
results.full_profile.naics_codes array of object

Array of secondary NAICS codes

code
results.full_profile.naics_codes.code string

Industry Code

description
results.full_profile.naics_codes.description string

Industry Description

sic_code
results.full_profile.sic_code string

Primary SIC code according to 1987 standard

sic_description
results.full_profile.sic_description string

Primary SIC description

sic_codes
results.full_profile.sic_codes array of object

Array of secondary SIC codes

code
results.full_profile.sic_codes.code string

Industry Code

description
results.full_profile.sic_codes.description string

Industry Description

categories
results.full_profile.categories array of object

Array of Orb proprietary business categories with weights

name
results.full_profile.categories.name string

Category Name

weight
results.full_profile.categories.weight float

Category Weight

employees_range
results.full_profile.employees_range string

Number of employees range

employees
results.full_profile.employees integer

Number of employees

revenue_range
results.full_profile.revenue_range string

Revenue range

revenue
results.full_profile.revenue integer

Revenue

year_founded
results.full_profile.year_founded integer

Year company was founded

description
results.full_profile.description string

Textual description of the company

url
results.full_profile.linkedin_account.url string
likes
results.full_profile.linkedin_account.likes integer
followers
results.full_profile.linkedin_account.followers integer
url
results.full_profile.facebook_account.url string
likes
results.full_profile.facebook_account.likes integer
followers
results.full_profile.facebook_account.followers integer
url
results.full_profile.twitter_account.url string
likes
results.full_profile.twitter_account.likes integer
followers
results.full_profile.twitter_account.followers integer
url
results.full_profile.googleplus_account.url string
likes
results.full_profile.googleplus_account.likes integer
followers
results.full_profile.googleplus_account.followers integer
url
results.full_profile.youtube_account.url string
likes
results.full_profile.youtube_account.likes integer
followers
results.full_profile.youtube_account.followers integer
technologies
results.full_profile.technologies array of object

List of frontend technologies installed on the company's website

name
results.full_profile.technologies.name string
rankings
results.full_profile.rankings array of string

Popular list the company may be included, such as Fortune, Forbes, Inc.com

ranking_positions
results.full_profile.ranking_positions array of object

Popular list the company may be included, such as Fortune, Forbes, Inc.com (with positions)

ranking
results.full_profile.ranking_positions.ranking string
position
results.full_profile.ranking_positions.position integer
eins
results.full_profile.eins array of string

U.S. Federal Employer Identification Number

npis
results.full_profile.npis array of string

National Provider Identifier (NPI), a unique 10-digit identification number issued to health care providers in the United States.

favicon
results.full_profile.favicon string

URL to the company's favicon

total_funding
results.full_profile.total_funding integer

Total funding amount raised by the company

last_funding_round_amount
results.full_profile.last_funding_round_amount integer

Last funding round amount

last_funding_round_year
results.full_profile.last_funding_round_year integer

Last funding round year

phone
results.full_profile.phone string

General phone number of the company

fax
results.full_profile.fax string

Company's fax number

email
results.full_profile.email string

General email of the company

importance_score
results.full_profile.importance_score string

Importance score: A, B or C. See documentation for more details

tickers
results.full_profile.tickers array of object

Stock exchange tickers if the company is publicly listed.Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

exchange
results.full_profile.tickers.exchange string
ticker
results.full_profile.tickers.ticker string
market_cap
results.full_profile.market_cap integer
cik
results.full_profile.cik string
cusip
results.full_profile.cusip string
fiscal_year_end
results.full_profile.fiscal_year_end string
cidrs_count
results.full_profile.cidrs_count integer
liveramp_idl_count
results.full_profile.liveramp_idl_count integer
liveramp_device_count
results.full_profile.liveramp_device_count integer
latitude
results.full_profile.latitude string
longitude
results.full_profile.longitude string

Retrieves full corporate tree of subsidiaries

The Corporate Tree API call allows a user to retrieve full corporate tree of subsidiaries for a given company, starting from its ultimate parent company. The input to the Corporate Tree call is the Orb Number of the target company (mandatory field).

Parameters

Name Key Required Type Description
API Access Key.
api_key string

API Access Key.

Embed full company profile
show_full_profile boolean

Embed full company profile

Extra output fields to include in response
include string

Extra output fields to include in response, for example optional orb_nums field.

Orb Number
orb_num True string

Orb Number

Returns

Name Path Type Description
request_fields
request_fields object

Input data to search

facets
facets object
results_count
results_count integer
results
results array of object
orb_num
results.orb_num integer

Orb Number of the candidate profile.

orb_nums
results.orb_nums array of integer

Secondary Orb Numbers of the candidate profile. Hidden by default, use include option to show.

name
results.name string

Company's name.

entity_type
results.entity_type string

"company" or "branch".

company_status
results.company_status string

"active" or "inactive".

parent_orb_num
results.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.subsidiaries_count integer

Number of subsidiaries

branches_count
results.branches_count integer

Number of company branches/locations

is_standalone_company
results.is_standalone_company boolean

Company is considered as standalone if it does not have parent and subsidiaries.

address1
results.address1 string

First line of the company's address.

city
results.city string

City.

state
results.state string

State.

zip
results.zip string

Zip code.

country
results.country string

Country.

iso_country_code
results.iso_country_code string

ISO country code.

fetch_url
results.fetch_url string

'Fetch' API call to retrieve the full company profile for this Orb Number.

orb_num
results.full_profile.orb_num integer

Orb Number

orb_nums
results.full_profile.orb_nums array of integer

Secondary Orb Numbers

name
results.full_profile.name string

Company name

parent_orb_num
results.full_profile.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.full_profile.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.full_profile.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.full_profile.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.full_profile.subsidiaries_count integer

Number of subsidiaries

branches_count
results.full_profile.branches_count integer

Number of company branches/locations

names
results.full_profile.names array of string

Company's other names - tradestyles, DBA names, former names, abbreviations

website
results.full_profile.website string

Company's website

webdomain
results.full_profile.webdomain string

Company's web domain

webdomains
results.full_profile.webdomains array of string

All company's web domains

webdomains_info
results.full_profile.webdomains_info array of object

All company's web domains with additional info: domain_has_email; domain_has_website; domain_is_email_hosting - such as gmail.com, hotmail.com; orb_web_rank - normalized Alexa rank

orb_web_rank
results.full_profile.webdomains_info.orb_web_rank integer

is a normalized Alexa rank. The normalization handles two cases: 1. Alexa service does not have this web domain in their database, so there is no Alexa rank for this web domain, then we set it to the maximum - 39999999; 2. For third and higher -level domains, like for example, dolls.stores.shop.ebay.com Alexa service returns alexa rank for ebay.com, which is not good in our use case, as it is a small online shop, not Ebay website. We set this to 39999999.

domain_has_website
results.full_profile.webdomains_info.domain_has_website integer
domain_is_email_hosting
results.full_profile.webdomains_info.domain_is_email_hosting integer

1 if this domain is a popular email service provider, such as, for example, gmail.com, yahoo.com, outlook.com and others. 1 - the domain is an email service provider; 0 - we are not aware of any popular email service provider with this domain. This flag is useful when the domain you want to get company information for was extracted from a person's contact email. So, for example, when it is 'yahoo.com', it does not mean that the person works at Yahoo!

webdomain
results.full_profile.webdomains_info.webdomain string
domain_has_email
results.full_profile.webdomains_info.domain_has_email integer
address1
results.full_profile.address.address1 string

Address Line 1

address2
results.full_profile.address.address2 string

Address Line 2

city
results.full_profile.address.city string

Address Line 2

state
results.full_profile.address.state string

Address Line 2

zip
results.full_profile.address.zip string

Zip Code

country
results.full_profile.address.country string

Country

industry
results.full_profile.industry string

Orb proprietary industry class

naics_code
results.full_profile.naics_code string

Primary NAICS code according to 2012 Census.gov standard

naics_description
results.full_profile.naics_description string

Primary NAICS code description

naics_codes
results.full_profile.naics_codes array of object

Array of secondary NAICS codes

code
results.full_profile.naics_codes.code string

Industry Code

description
results.full_profile.naics_codes.description string

Industry Description

sic_code
results.full_profile.sic_code string

Primary SIC code according to 1987 standard

sic_description
results.full_profile.sic_description string

Primary SIC description

sic_codes
results.full_profile.sic_codes array of object

Array of secondary SIC codes

code
results.full_profile.sic_codes.code string

Industry Code

description
results.full_profile.sic_codes.description string

Industry Description

categories
results.full_profile.categories array of object

Array of Orb proprietary business categories with weights

name
results.full_profile.categories.name string

Category Name

weight
results.full_profile.categories.weight integer

Category Weight

employees_range
results.full_profile.employees_range string

Number of employees range

employees
results.full_profile.employees integer

Number of employees

revenue_range
results.full_profile.revenue_range string

Revenue range

revenue
results.full_profile.revenue integer

Revenue

year_founded
results.full_profile.year_founded integer

Year company was founded

description
results.full_profile.description string

Textual description of the company

url
results.full_profile.linkedin_account.url string
likes
results.full_profile.linkedin_account.likes integer
followers
results.full_profile.linkedin_account.followers integer
url
results.full_profile.facebook_account.url string
likes
results.full_profile.facebook_account.likes integer
followers
results.full_profile.facebook_account.followers integer
url
results.full_profile.twitter_account.url string
likes
results.full_profile.twitter_account.likes integer
followers
results.full_profile.twitter_account.followers integer
url
results.full_profile.googleplus_account.url string
likes
results.full_profile.googleplus_account.likes integer
followers
results.full_profile.googleplus_account.followers integer
url
results.full_profile.youtube_account.url string
likes
results.full_profile.youtube_account.likes integer
followers
results.full_profile.youtube_account.followers integer
technologies
results.full_profile.technologies array of object

List of frontend technologies installed on the company's website

name
results.full_profile.technologies.name string
rankings
results.full_profile.rankings array of string

Popular list the company may be included, such as Fortune, Forbes, Inc.com

ranking_positions
results.full_profile.ranking_positions array of object

Popular list the company may be included, such as Fortune, Forbes, Inc.com (with positions)

ranking
results.full_profile.ranking_positions.ranking string
position
results.full_profile.ranking_positions.position integer
eins
results.full_profile.eins array of string

U.S. Federal Employer Identification Number

npis
results.full_profile.npis array of string

National Provider Identifier (NPI), a unique 10-digit identification number issued to health care providers in the United States.

favicon
results.full_profile.favicon string

URL to the company's favicon

total_funding
results.full_profile.total_funding integer

Total funding amount raised by the company

last_funding_round_amount
results.full_profile.last_funding_round_amount integer

Last funding round amount

last_funding_round_year
results.full_profile.last_funding_round_year integer

Last funding round year

phone
results.full_profile.phone string

General phone number of the company

fax
results.full_profile.fax string

Company's fax number

email
results.full_profile.email string

General email of the company

importance_score
results.full_profile.importance_score string

Importance score: A, B or C. See documentation for more details

tickers
results.full_profile.tickers array of object

Stock exchange tickers if the company is publicly listed.Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

exchange
results.full_profile.tickers.exchange string
ticker
results.full_profile.tickers.ticker string
market_cap
results.full_profile.market_cap integer
cik
results.full_profile.cik string
cusip
results.full_profile.cusip string
fiscal_year_end
results.full_profile.fiscal_year_end string
cidrs_count
results.full_profile.cidrs_count integer
liveramp_idl_count
results.full_profile.liveramp_idl_count integer
liveramp_device_count
results.full_profile.liveramp_device_count integer
latitude
results.full_profile.latitude string
longitude
results.full_profile.longitude string

The Match API call performs a candidate retrieval process

The Match API call performs a candidate retrieval process; the process by which Orb records are identified as potential matches to the query. The input fields must either include the name and country, or the website/email, or the EIN of the company record. All other fields are optional. Users can review the candidates to choose their preferred match based on the candidate with the highest Confidence Score, algorithmically, based on the match mask (for example, take those that match by website, even though the name didn't match) or manually.

Parameters

Name Key Required Type Description
API Key
api_key string

API Access Key.

Company's name
name string

Company's name.

First line of the company's address.
address1 string

First line of the company's address.

City
city string

City

State
state string

State.

Zip Code
zip string

Zip code

Country
country string

Country

Company's website
website string

Company's website.

Any email based on a company's domain.
email string

Any email based on a company's domain.

Company's phone number.
phone string

Company's phone number.

U.S. Federal Enployeer Tax ID (EIN) of the company, for example, "204971292".
ein string

Employer Tax ID (EIN)

National Provider Identifier (NPI)
npi string

National Provider Identifier, a unique 10-digit identification number issued to health care providers in the United States.

Legal Entity Identifier (LEI)
lei string

Legal Entity Identifier, 20-character, alpha-numeric code based on the ISO 17442.

Optional customer's request ID
request_id string

Optional customer's request ID

Orb Number to match input data with particular company
orb_num string

Orb Number to match input data with particular company

Returns

Name Path Type Description
Input data to match
request_fields object

Input data to match

results_count
results_count integer
results
results array of object
result_number
results.result_number integer
Orb Number of the candidate profile.
results.orb_num integer

Orb Number of the candidate profile.

Secondary Orb Numbers of the candidate profile. Hidden by default, use `include` option to show.
results.orb_nums array of integer

Secondary Orb Numbers of the candidate profile. Hidden by default, use include option to show.

name
results.name string

Company's name.

entity_type
results.entity_type string

"company" or "branch".

company_status
results.company_status string

"active" or "inactive".

parent_orb_num
results.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.subsidiaries_count integer

Number of subsidiaries

branches_count
results.branches_count integer

Number of company branches/locations

is_standalone_company
results.is_standalone_company boolean

Company is considered as standalone if it does not have parent and subsidiaries.

address1
results.address1 string

First line of the company's address.

city
results.city string

City.

state
results.state string

State.

zip
results.zip string

Zip code.

country
results.country string

Country.

iso_country_code
results.iso_country_code string

ISO country code.

fetch_url
results.fetch_url string

'Fetch' API call to retrieve the full company profile for this Orb Number.

orb_num
results.full_profile.orb_num integer

Orb Number

orb_nums
results.full_profile.orb_nums array of integer

Secondary Orb Numbers

name
results.full_profile.name string

Company name

parent_orb_num
results.full_profile.parent_orb_num integer

Orb Number of a parent company, if this company is a subsidiary

parent_name
results.full_profile.parent_name string

Name of a parent company.

ultimate_parent_orb_num
results.full_profile.ultimate_parent_orb_num integer

Orb Number of the ultimate parent company.

ultimate_parent_name
results.full_profile.ultimate_parent_name string

Name of the ultimate parent company.

subsidiaries_count
results.full_profile.subsidiaries_count integer

Number of subsidiaries

branches_count
results.full_profile.branches_count integer

Number of company branches/locations

names
results.full_profile.names array of string

Company's other names - tradestyles, DBA names, former names, abbreviations

website
results.full_profile.website string

Company's website

webdomain
results.full_profile.webdomain string

Company's web domain

webdomains
results.full_profile.webdomains array of string

All company's web domains

webdomains_info
results.full_profile.webdomains_info array of object

All company's web domains with additional info: domain_has_email; domain_has_website; domain_is_email_hosting - such as gmail.com, hotmail.com; orb_web_rank - normalized Alexa rank

orb_web_rank
results.full_profile.webdomains_info.orb_web_rank integer

is a normalized Alexa rank. The normalization handles two cases: 1. Alexa service does not have this web domain in their database, so there is no Alexa rank for this web domain, then we set it to the maximum - 39999999; 2. For third and higher -level domains, like for example, dolls.stores.shop.ebay.com Alexa service returns alexa rank for ebay.com, which is not good in our use case, as it is a small online shop, not Ebay website. We set this to 39999999.

domain_has_website
results.full_profile.webdomains_info.domain_has_website integer
domain_is_email_hosting
results.full_profile.webdomains_info.domain_is_email_hosting integer

1 if this domain is a popular email service provider, such as, for example, gmail.com, yahoo.com, outlook.com and others. 1 - the domain is an email service provider; 0 - we are not aware of any popular email service provider with this domain. This flag is useful when the domain you want to get company information for was extracted from a person's contact email. So, for example, when it is 'yahoo.com', it does not mean that the person works at Yahoo!

webdomain
results.full_profile.webdomains_info.webdomain string
domain_has_email
results.full_profile.webdomains_info.domain_has_email integer
address1
results.full_profile.address.address1 string

Address Line 1

address2
results.full_profile.address.address2 string

Address Line 2

city
results.full_profile.address.city string

Address Line 2

state
results.full_profile.address.state string

Address Line 2

zip
results.full_profile.address.zip string

Zip Code

country
results.full_profile.address.country string

Country

industry
results.full_profile.industry string

Orb proprietary industry class

naics_code
results.full_profile.naics_code string

Primary NAICS code according to 2012 Census.gov standard

naics_description
results.full_profile.naics_description string

Primary NAICS code description

naics_codes
results.full_profile.naics_codes array of object

Array of secondary NAICS codes

code
results.full_profile.naics_codes.code string

Industry Code

description
results.full_profile.naics_codes.description string

Industry Description

sic_code
results.full_profile.sic_code string

Primary SIC code according to 1987 standard

sic_description
results.full_profile.sic_description string

Primary SIC description

sic_codes
results.full_profile.sic_codes array of object

Array of secondary SIC codes

code
results.full_profile.sic_codes.code string

Industry Code

description
results.full_profile.sic_codes.description string

Industry Description

categories
results.full_profile.categories array of object

Array of Orb proprietary business categories with weights

name
results.full_profile.categories.name string

Category Name

weight
results.full_profile.categories.weight integer

Category Weight

employees_range
results.full_profile.employees_range string

Number of employees range

employees
results.full_profile.employees integer

Number of employees

revenue_range
results.full_profile.revenue_range string

Revenue range

revenue
results.full_profile.revenue integer

Revenue

year_founded
results.full_profile.year_founded integer

Year company was founded

description
results.full_profile.description string

Textual description of the company

url
results.full_profile.linkedin_account.url string
likes
results.full_profile.linkedin_account.likes integer
followers
results.full_profile.linkedin_account.followers integer
url
results.full_profile.facebook_account.url string
likes
results.full_profile.facebook_account.likes integer
followers
results.full_profile.facebook_account.followers integer
url
results.full_profile.twitter_account.url string
likes
results.full_profile.twitter_account.likes integer
followers
results.full_profile.twitter_account.followers integer
url
results.full_profile.googleplus_account.url string
likes
results.full_profile.googleplus_account.likes integer
followers
results.full_profile.googleplus_account.followers integer
url
results.full_profile.youtube_account.url string
likes
results.full_profile.youtube_account.likes integer
followers
results.full_profile.youtube_account.followers integer
technologies
results.full_profile.technologies array of object

List of frontend technologies installed on the company's website

name
results.full_profile.technologies.name string
rankings
results.full_profile.rankings array of string

Popular list the company may be included, such as Fortune, Forbes, Inc.com

ranking_positions
results.full_profile.ranking_positions array of object

Popular list the company may be included, such as Fortune, Forbes, Inc.com (with positions)

ranking
results.full_profile.ranking_positions.ranking string
position
results.full_profile.ranking_positions.position integer
eins
results.full_profile.eins array of string

U.S. Federal Employer Identification Number

npis
results.full_profile.npis array of string

National Provider Identifier (NPI), a unique 10-digit identification number issued to health care providers in the United States.

favicon
results.full_profile.favicon string

URL to the company's favicon

total_funding
results.full_profile.total_funding integer

Total funding amount raised by the company

last_funding_round_amount
results.full_profile.last_funding_round_amount integer

Last funding round amount

last_funding_round_year
results.full_profile.last_funding_round_year integer

Last funding round year

phone
results.full_profile.phone string

General phone number of the company

fax
results.full_profile.fax string

Company's fax number

email
results.full_profile.email string

General email of the company

importance_score
results.full_profile.importance_score string

Importance score: A, B or C. See documentation for more details

tickers
results.full_profile.tickers array of object

Stock exchange tickers if the company is publicly listed.Use GET /3/dictionaries/stock_exchanges to get a list of all stock exchanges.

exchange
results.full_profile.tickers.exchange string
ticker
results.full_profile.tickers.ticker string
market_cap
results.full_profile.market_cap integer
cik
results.full_profile.cik string
cusip
results.full_profile.cusip string
fiscal_year_end
results.full_profile.fiscal_year_end string
cidrs_count
results.full_profile.cidrs_count integer
liveramp_idl_count
results.full_profile.liveramp_idl_count integer
liveramp_device_count
results.full_profile.liveramp_device_count integer
latitude
results.full_profile.latitude string
longitude
results.full_profile.longitude string
confidence_score
results.confidence_score float

Confidence Score of this match.

main_name
results.match_mask.main_name string

match | similar: x% | relaxed match | no match | missing input | no data

corp_elem
results.match_mask.corp_elem string

match | no match

other_names
results.match_mask.other_names string

match | similar: x% | relaxed match | no match | missing input | no data

webdomain
results.match_mask.webdomain string

match | no match | redirect match | email match | missing input | no data

address1
results.match_mask.address1 string

match | no match | missing input | no data

city
results.match_mask.city string

match | no match | missing input | no data

state
results.match_mask.state string

match | no match | missing input | no data

zip
results.match_mask.zip string

match | no match | missing input | no data

country
results.match_mask.country string

match | no match | missing input | no data

phone
results.match_mask.phone string

match | no match | missing input | no data

ein
results.match_mask.ein string

match | no match | missing input | no data

npi
results.match_mask.npi string

match | no match | missing input | no data

lei
results.match_mask.lei string

match | no match | missing input | no data

matched_fields
results.matched_fields object

Orb company fields which matched input data.