openapi: 3.2.0
info:
description: "## Precision News API \n\n The Precision News APIs provide access to curated news annotated with metadata tags. There are three APIs that access their own data sets, municipal, economic, and corporate. Each API has a specific way of querying the data sets and specific data they return, which is described in each of the respective API descriptions, the [Municipal News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) and the [Economic News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) and the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). All of the API's are built on a common foundation described below. \n\n A news article is tagged with metadata that describes the content of the article. Each data set has its own set of unique tags but there is a common set depicted below \n\n  \n\n News queries are time based. The news can be queried either within a specified time window or by a number of days back in history from the current day. The dates used when specifying a time window can be based on the published date of an article or the date which the article was made available by the system. When using a polling strategy to query the latest news using the API, the available date is recommended as published dates can be less predictable. Due to the large number of news articles that may be returned because of a broad criteria or a large window a limit on the number of articles to return by the system can be specified. \n\n Responses to queries are capped at 1000 articles. It is possible however that there are more than 1000 articles that match a given query. To accommodate queries that match more than the maximum size the concept of paging is supported. A page is a set of articles returned by a single query. It may be less than the total result set. The client can indicate which page they want returned on each call. This allows the client to loop through the result set one page at a time until the entire result set is returned. \n\n Both the page to return and the size of the page are specified by the client with the pageNo and pageSize parameters respectively. Each API will list these parameter options as either query parameters or properties of the input message body. A query parameter example is as follows: \n\n ```js\n GET ...&pageNo=1&pageSize=100 HTTP 1.1\n ```\n \n\n This instructs the API to return the first page with a maximum of 100 articles in it. Each news response will identify the number of articles returned for the current page and the total number of articles in the result set so the client can loop if needed. For example: \n\n ```js\n {\n \t\"success\": true,\n \t\"returned\": 100,\n \t\"total\": 1000, \n \t... \n ``` \n The above response indicates the requested page of 100 articles are in the response but there were a total of 1000 articles that matched the query. To then ask for the second page of the result set the pageNo parameter would be incremented as follows: \n\n ```js\n GET ...&pageNo=2&pageSize=100 HTTP 1.1\n ```\n \n\n In this example the next response will return the 101st to 200th article in the result set. \n\n The corporate and municipal data sets require their own API key. The economic data set is shared between the corporate and municipal data sets and does not require its own key. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page. \n\n## Entity API \n\n The corporate entities, companies or organizations, that the articles the Corporate News API returns are persisted in the Bitvore Knowledge Graph. The Entity API provides access to the information about those corporate entities. \n\n  \n\n Companies can be searched for based on some criteria or directly using a Bitvore ID which uniquely identifies an entity in the Bitvore system. When using the Bitvore ID the entire company profile will be returned for that single company. If one is unsure what the Bitvore ID of a company is a search can be performed using different profile properties such as name, ticker, industry, etc. The API will return all companies that match the search criteria. Only summary information is returned but it should be enough information to identify the exact company being searched for. Once the Bitvore ID is found news can be retrieved for the company using the Corporate News API. \n\n  \n\n The Bitvore ID for a company never changes so it is recommended that clients save the Bitvore IDs for future use instead of calling the Entity API each time if possible. \n\n Each company has a monitoring state field which can have the value \"active\" or \"inactive\". Active companies are being monitored by Bitvore so news is being currently collected. An inactive company will need to be activated in order to start news collection. If you see an inactive company you would like activated please contact [customer support](mailto:support@bitvore.com). \n\n The Entity API is part of the corporate data set and requires a corporate data set API key for access. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n## Portfolio API \n\n Bitvore RESTful APIs useful for integrating with a business portfolio so that querying news articles can be focused on business relevant entities and performed in a simplified manner. Two separate APIs are provided to support two different integration approaches. \n\n * The Portfolio Management API provides the ability to create, or replicate, a business portfolio in the Bitvore system. \n * The Identification API maps custom identifiers to Bitvore IDs so that the business portfolio does not have to be replicated in the Bitvore system. \n \n\n Access to any of the Portfolio APIs requires an API key or an API user account for backwards compatibility with 1.0 customers. \n\n A Bitvore Corporate News API key can be used to access any of the Portfolio APIs. A Bitvore Municipal News API key can be used to access the Portfolio Management API only. To register for an API Key please contact [customer support](mailto:support@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page. \n\n ### Portfolio Management API \n\n The Portfolio Management API provides the ability to create, or replicate, a business portfolio in the Bitvore system. The entities to be tracked in the portfolio are identified by either CUSIPs (for bonds) or Bitvore IDs (for companies). The benefit of creating a portfolio in Bitvore is the news APIs both take a portfolio ID as a parameter making it easy to retrieve news for a portfolio. \n\n If creating a portfolio of companies in Bitvore the Bitvore ID of each company will be needed. This ID can be obtained from a company's profile using the Entity API. \n\n  \n\n The returned Bitvore ID can then be added to the portfolio. When querying for news about the portfolio the news for that company will be returned. \n\n A set of sample CSV files listing companies found [here](http://developer.bitvore.com/v1/docs/api-reference/portfolios) can be used to quickly create portfolios of your own. Simply download the CSV file you want to create your portfolio with, create a new company (BVID) portfolio, and then use the [Upload Portfolio Items](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) API call to fill the new portfolio from the CSV file. Note the portfolio ID generated and then use that ID when querying for portfolio news using the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). \n\n Each company has a monitoring state field which can have the value \"active\" or \"inactive\". Active companies are being monitored by Bitvore so news is being currently collected. An inactive company will need to be activated in order to start news collection. Simply adding an inactive company to your portfolio will not start news collection. If you see an inactive company you would like activated please contact [customer support](mailto:support@bitvore.com). \n\n ### Identification API \n\n The Identification API maps custom identifiers to Bitvore IDs so that the business portfolio does not have to be replicated in the Bitvore system. Portfolios typically reference companies using their own identification scheme. The portfolio will remain in an external store and only a mapping of the IDs of the companies using that identification scheme need be mapped to entities in the Bitvore system. This is only required for company based portfolios as no mapping is needed for CUSIPs. \n The API provides the ability to create, modify, and delete an ID map. The map consists of a list of ID mappings. Each mapping associates the external company ID with an internal Bitvore ID. \n\n  \n\n Once the map is created clients can invoke the Corporate News API using the IDs in their own identification scheme instead of Bitvore IDs. \n\n  \n\n The API client will provide a list of external IDs to the News API. The News API will find the Bitvore IDs for each external ID from the ID map created by the same API Client (as identified by their API key). The news is then returned for those associated Bitvore IDs. If there is no mapping in the system for an external ID an error will be returned.\n\n## Financial Filings API \n\n The financial filings submitted by companies or organizations in the Bitvore Knowledge Graph can be obtained through the Financial Filing API. \n\n Filings can be searched for based on filing type (8-K, 10-Q, etc.), company Bitvore ID, and time frame. The API provides the option of returning summary information about each filing such as the filing company information and filing type or returning the entire filing submission. Filing submissions consist of multiple files and will be returned in compressed file downloads. \n\n Filings queries are time based. The filings can be queried either within a specified time window or by a number of days back in history from the current day. The dates used when specifying a time window can be based on the submission date of a filing or the date which the filing was made available by the system. When using a polling strategy to query the latest filings using the API, the available date is recommended as submission dates can be less predictable. Due to the large number (and size) of filings that may be returned because of a broad criteria or a large window a limit on the number of filings to return by the system can be specified. \n\n Responses to summary queries are capped at 1000 filings while responses to submission queries are capped at 200. It is possible however that there are more than the capped amount of filings that match a given query. To accommodate queries that match more than the maximum size the concept of paging is supported. A page is a set of filings returned by a single query. It may be less than the total result set. The client can indicate which page they want returned on each call. This allows the client to loop through the result set one page at a time until the entire result set is returned. \n\n Both the page to return and the size of the page are specified by the client with the pageNo and pageSize parameters respectively. The API will list these parameter options as either query parameters or properties of the input message body. A query parameter example is as follows: \n\n ```js\n GET ...&pageNo=1&pageSize=100 HTTP 1.1\n ```\n \n\n This instructs the API to return the first page with a maximum of 100 filings in it. Each response will identify the number of filings returned for the current page and the total number of filings in the result set so the client can loop if needed. For example: \n\n ```js\n {\n \t\"success\": true,\n \t\"returned\": 100,\n \t\"total\": 1000, \n \t... \n ``` \n The above response indicates the requested page of 100 filings are in the response but there were a total of 1000 filings that matched the query. To then ask for the second page of the result set the pageNo parameter would be incremented as follows: \n\n ```js\n GET ...&pageNo=2&pageSize=100 HTTP 1.1\n ```\n \n\n In this example the next response will return the 101st to 200th filings in the result set. \n\n The Financial Filings API is part of the corporate data set and requires a corporate data set API key for access. To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n## Score API \n\n The Score APIs provide access to the different scores Bitvore generates, such as company sentiment scores. Scores are calculated by gathering data over a period of time and aggregated in some manner to produce a numerical score that can be used to compare, trend, and correlate with other information. The scores are calculated periodically and are made available in a time series format by the APIs. \n\n The [Company Sentiment Score API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) provides scores measuring the sentiment about a company in regards to a given topic, such as a growth, risk, or an overall sentiment. The company sentiment score is calculated daily. Scores for each day are returned for each company requested over a given time period. \n\n The [Company Sentiment Score API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api) uses the same API as the [Corporate News API](http://developer.bitvore.com/v1/docs/api-reference/legacy-api). To register for an API Key please contact the [Products Team](mailto:products@bitvore.com). The API key can be used directly or to obtain an OAuth access token as described on the [Security APIs](http://developer.bitvore.com/v1/docs/security) page.\n\n "
version: '1.0'
title: Bitvore Legacy Entity API
license:
name: Copyright Bitvore Corp. 2026
servers:
- url: https://api.bitvore.com/
tags:
- name: Entity
description: Entity API
paths:
/entityapi/entities:
get:
tags:
- Entity
summary: Organization Search
description: "Search can be performed using one of two approaches, a lookup or a parameterized query. A lookup takes a single string as input to matching entities. The following are the matching rules used. The search results are ordered according to the rules. \n\n 1. Exact match on name (case insensitive)\n 2. Exact match on ticker\n 3. Exact match on domain name\n 4. Exact match on alias (case insensitive)\n 5. Starts with on name (case insensitive)\n 6. Starts with on ticker\n 7. Starts with on domain name\n 8. Starts with on alias (case insensitive)\n \n\n An example of performing a lookup is as follows: \n\n ```js\n GET /entityapi/entities?lookup=acme HTTP 1.1\n Accept: application/json\n ```\n A paramaterized query takes one or more search parameters. A parameter has a name and one or more values. The search will match the company properties and relationships with the parameters and return only those that match all input parameters. The following are the supported search parameters: \n\n * name - One or more names to search for \n * ticker - One or more tickers to search for \n * domainName - One or more domain names to search for. \n * location - One or more locations companies must have their headquarters in. Locations are in the format of city/state code/country. If city or state is unspecified the appropriate / delimiters must still be included, i.e., /California/United States. Must not be used with fips or zip. \n * fips - One or more FIPS codes identifying counties or CBSAs (metropolitan/micropolitan statistical areas) companies must have their headquarters in. FIPS codes for counties can be found [here](https://www.census.gov/prod/techdoc/cbp/95-96cd/fips-st.pdf). FIPS codes for CBSAs can be found [here](https://www2.census.gov/programs-surveys/cps/methodology/2015%20Geography%20Cover.pdf). Maps of CBSAs can be found [here](https://www.census.gov/geographies/reference-maps/2020/geo/cbsa.html). Must not be used with location or zip. \n * zip - One or more zip codes identifying ZIP Code Tabulation Areas (ZCTAs) companies must have their headquarters in. Must not be used with location or fips. \n * naics - One or more [NAICS](https://www.naics.com/search/) codes identifying industries the companies must operate in. \n * sic - One or more [SIC](https://www.osha.gov/pls/imis/sicsearch.html) codes identifying industries the companies must operate in. \n * revRange - Revenue range (in millions) companies must fall in. The range is formated as lower-upper where lower and upper must be one of 0, 1, 10, 50, 100, 500, 1000, 10000. The upper bound can be omitted to report over 10B. Note: On 1/11/2020 the range boundary of 200 was replaced with 500 and will be no longer supported on 7/1/2020. \n * empRange - Employee range companies must fall in. The range is formated as lower-upper where lower and upper must be one of 1, 10, 50, 100, 250, 500, 1000, 5000, 10000. The upper bound can be omitted to report over 10000. Note: On 1/11/2020 the range boundary of 200 was replaced by 100 and 250 and will be no longer supported on 7/1/2020. \n \n\n An example of performing a parameterized query by domain name is \n\n ```js\n GET /entityapi/entities?domainName=acme.com HTTP 1.1\n Accept: application/json\n ```\n \n\n 0 or more companies may be returned that match the supplied query criteria. Only summary information for each matching company is supplied which includes the following fields: \n\n * ID \n * Name \n * Domain Name \n * Ticker \n * State \n * Country \n * Parent \n * Monitoring State \n \n\n A sample successful response is: \n\n ```js\n {\n \t\"success\": true,\n \t\"returned\": 1,\n \t\"total\": 1,\n \t\"response\": [\n \t\t{ \n \t\t\t\"id\": \"b0004i9h2\", \n \t\t\t\"name\": \"LinkedIn\", \n \t\t\t\"domainName\": \"linkedin.com\", \n \t\t\t\"city\": \"Sunnyvale\", \n \t\t\t\"state\": \"CA\", \n \t\t\t\"country\": \"United States\", \n \t\t\t\"monitored\": \"active\", \n \t\t\t\"parent\": { \n \t\t\t\t\"id\": \"b00001adv\", \n \t\t\t\t\"name\": \"MICROSOFT CORPORATION\", \n \t\t\t\t\"ticker\": \"MSFT\", \n \t\t\t\t\"domainName\": \"microsoft.com\", \n \t\t\t\t\"state\": \"WA\", \n \t\t\t\t\"country\": \"United States\", \n \t\t\t\t\"monitored\": \"active\" \n \t\t\t} \n \t\t}, \n \t]\n }\n ```\n A sample unsuccessful response is: \n\n ```js\n {\n \t\"success\": false,\n \t\"reason\": \"b00000000\",\n \t\"reasonSupport\": \"No company with BvId b00000000 found.\",\n \t\"returned\": 0,\n \t\"total\": 1\n }\n ```\n"
operationId: handleOrgLookupUsingGET
parameters:
- name: lookup
in: query
description: Lookup option. Value is used to match multiple fields.
required: false
allowEmptyValue: false
schema:
type: string
- name: name
in: query
description: One or more names to search for.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: ticker
in: query
description: One or more tickers to search for.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: domainName
in: query
description: One or more domain names to search for.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: location
in: query
description: One or more locations companies must have their headquarters in.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: fips
in: query
description: One or more FIPS codes identifying locations the companies must have their headquarters in.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: zip
in: query
description: One or more zip codes identifying locations the companies must have their headquarters in.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: naics
in: query
description: One or more NAICS codes identifying industries the companies must operate in.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: sic
in: query
description: One or more SIC codes identifying industries the companies must operate in.
required: false
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: revRange
in: query
description: Revenue range (in millions) companies must fall in. The range is formated as lower-upper where lower and upper must be one of 0, 1, 10, 50, 100, 200, 1000. The upper bound can be ommited to report over 1B.
required: false
allowEmptyValue: false
schema:
type: string
- name: empRange
in: query
description: Employee range companies must fall in. The range is formated as lower-upper where lower and upper must be one of 1, 10, 50, 200, 500, 1000, 5000, 10000. The upper bound can be ommited to report over 1B.
required: false
allowEmptyValue: false
schema:
type: string
- name: pageNo
in: query
description: Page number of the total result set to return, default is 1.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
description: Number of results out of the total result set per page to return, default is 100, maximum is 1000.
required: false
allowEmptyValue: false
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationSearchResponseLegacy'
originalRef: OrganizationSearchResponseLegacy
'400':
description: Invalid parameter used
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'401':
description: Unauthorized to view organizations
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
/entityapi/entities/{id}:
get:
tags:
- Entity
summary: Organization Details
description: "Returns detailed information about the company with the given Bitvore ID. The full set of company : fields are returned by this call. An example of retrieving the details of a company with a specified Bitvore ID is \n\n ```js\n GET /entityapi/entities/b0004i9h2 HTTP 1.1\n Accept: application/json\n X-CLIENTAPP-APPID: BVAPI\n ```\n \n\n A sample successful response is: \n\n ```js\n { \n \t\"id\": \"b0004i9h2\", \n \t\"name\": \"LinkedIn\", \n \t\"domainName\": \"linkedin.com\", \n \t\"revenue\": \"1000-\", \n \t\"employees\": \"5000-10000\", \n \t\"city\": \"Sunnyvale\", \n \t\"state\": \"CA\", \n \t\"country\": \"United States\", \n \t\"monitored\": \"active\", \n \t\"naicsIndustry\": { \n \t\t\"code\": \"54151\", \n \t\t\"name\": \"Computer Systems Design and Related Services\" \n \t}, \n \t\"sicIndustry\": { \n \t\t\"code\": \"737\", \n \t\t\"name\": \"Computer Programming, Data Processing, And Other Computerrelated\" \n \t}, \n \t\"parent\": { \n \t\t\"id\": \"b00001adv\", \n \t\t\"name\": \"MICROSOFT CORPORATION\", \n \t\t\"ticker\": \"MSFT\", \n \t\t\"domainName\": \"microsoft.com\", \n \t\t\"state\": \"WA\", \n \t\t\"country\": \"United States\", \n \t\t\"linkedInUrl\": \"https://www.linkedin.com/company/1337\", \n \t\t\"twitterUrl\": \"https://twitter.com/LinkedIn\", \n \t\t\"monitored\": \"active\" \n \t}, \n \t\"ultimateParent\": { \n \t\t\"id\": \"b00001adv\", \n \t\t\"name\": \"MICROSOFT CORPORATION\", \n \t\t\"ticker\": \"MSFT\", \n \t\t\"domainName\": \"microsoft.com\", \n \t\t\"state\": \"WA\", \n \t\t\"country\": \"United States\", \n \t\t\"monitored\": \"active\" \n \t} \n } \n ```\n"
operationId: handleGetOrgUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationDetails'
originalRef: OrganizationDetails
'400':
description: Invalid parameter used
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'401':
description: Unauthorized to view organizations
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
/entityapi/matches:
post:
tags:
- Entity
summary: Organization Matching
description: "Attempts to find companies matching input specifications made up of a list of property values. Multiple companies can be matched in a single call. For each company to match a list of properties and values known by the client (the input specification) are passed in. If possible the system will return a single matching company for each input specification. If more than one company matches an input specification and there is not one company that is more qualified than the others all the candidates will be returned. The following are the company properties that can be used in input specifications. More than one value can be supplied for each indicating a match of any of the values will be acceptable. \n * Name \n * DomainName \n * Ticker \n * NAICSCode \n * SICCode \n * City \n * StateCode \n * Country \n \n\n In the following example we'll try to match two companies. In this case they will actually be companies with the same name but by using different properties in the specifications we can see how the system matches differently. The first specification will include the company name and the state it's in. The second specification will include the company name and its domain name. \n\n ```js\n POST /matches \n Content-Type: application/json \n Accept: application/json \n X-BV-APIKEY: xyz123... \n\n [ \n \t{ \n \t\t\"Name\": [\"Bank of Commerce\"], \n \t\t\"StateCode\": [\"OK\"] \n \t}, \n \t{ \n \t\t\"Name\": [\"Bank of Commerce\"], \n \t\t\"DomainName\": [\"bocokonline.com\"] \n \t} \n ] \n ```\n The response to this request will have two sets of matching candidates: \n\n ```js\n [ \n \t{ \n \t\t\"spec\": { \n \t\t\t\"Name\": [\"Bank Of Commerce\"], \n \t\t\t\"StateCode\": [\"OK\"] \n \t\t}, \n \t\t\"candidates\": [ \n \t\t\t{ \n \t\t\t\t\"org\": { \n \t\t\t\t\t\"id\": \"d0007i2x0\", \n \t\t\t\t\t\"name\": \"Bank of Commerce\", \n \t\t\t\t\t\"domainName\": \"bocokonline.com\", \n \t\t\t\t\t\"state\": \"OK\", \n \t\t\t\t\t... \n \t\t\t\t}, \n \t\t\t\t\"hits\": [\"Name\",\"StateCode\"] \n \t\t\t}, \n \t\t\t{ \n \t\t\t\t\"org\": { \n \t\t\t\t\t\"id\": \"d00078oes\", \n \t\t\t\t\t\"name\": \"Bank of Commerce\", \n \t\t\t\t\t\"domainName\": \"bocokla.com\", \n \t\t\t\t\t\"state\": \"OK\", \n \t\t\t\t\t... \n \t\t\t\t}, \n \t\t\t\t\"hits\": [\"Name\",\"StateCode\"] \n \t\t\t}, \n \t\t\t{ \n \t\t\t\t\"org\": { \n \t\t\t\t\t\"id\": \"d0007v0mn\", \n \t\t\t\t\t\"name\": \"BANK OF COMMERCE\", \n \t\t\t\t\t\"state\": \"OK\", \n \t\t\t\t\t... \n \t\t\t\t}, \n \t\t\t\t\"hits\": [\"Name\",\"StateCode\"] \n \t\t\t} \n \t\t] \n \t}, \n \t{ \n \t\t\"spec\": { \n \t\t\t\"Name\": [\"Bank Of Commerce\"], \n \t\t\t\"DomainName\": [\"bocokonline.com\"] \n \t\t}, \n \t\t\"candidates\": [ \n \t\t\t{ \n \t\t\t\t\"org\": { \n \t\t\t\t\t\"id\": \"d0007i2x0\", \n \t\t\t\t\t\"name\": \"Bank of Commerce\", \n \t\t\t\t\t\"domainName\": \"bocokonline.com\", \n \t\t\t\t\t\"state\": \"OK\", \n \t\t\t\t\t... \n \t\t\t\t}, \n \t\t\t\t\"hits\": [\"Name\",\"DomainName\"] \n \t\t\t} \n \t\t] \n \t} \n ] \n ```\n The first set of candidates is returned for the name/state combination. There are three companies with the input name and state code. Since that is the only input the system could not narrow the candidates down any further. \n\n The second set of candidates is returned for the same name but with a domain name instead of a state code. This input specification matched only one company in the system which is returned. \n\n The properties that were matched for each candidate are returned in the \"hits\" field. These will match the input specification properties. However, when matching names the system will attempt to match the input name against the company names in the Knowledge Graph as well as any known aliases for companies. If the input name matched an alias instead of a company name the \"Alias\" property will be returned in \"hits\"."
operationId: handleOrgMatchingUsingPOST
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/SingleOrganizationMatchingResultLegacy'
originalRef: SingleOrganizationMatchingResultLegacy
'400':
description: Invalid parameter used.
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
'500':
description: Internal error.
content:
application/json:
schema:
$ref: '#/components/schemas/ReasonResponse'
originalRef: ReasonResponse
security:
- API key:
- Global
- BasicAuth:
- Global
- OAuth:
- Global
deprecated: false
requestBody:
content:
a
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitvore/refs/heads/main/openapi/bitvore-entity-api-openapi.yml