{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Factset Concordance API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Factset Concordance", "type": "folder" }, "items": [ { "info": { "name": "Factset Get Entity Candidates and Matches for a single name and attributes.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/entity-match", "params": [ { "name": "name", "value": "FactSet", "type": "query", "description": "Name of Entity to match." }, { "name": "country", "value": "US", "type": "query", "description": "ISO2 country code corresponding to the entity name that is used when evaluating candidates for a match. For a list of ISO2 Country codes, visit [OA 8754](https://my.apps.factset.com/oa/pages/8754)." }, { "name": "state", "value": "CT", "type": "query", "description": "Two-character state code corresponding to the entity name that is used when evaluating candidates for a match. Currently, only US state codes are supported." }, { "name": "url", "value": "", "type": "query", "description": "URL corresponding to the entity name that is used when evaluating candidates for a match." }, { "name": "includeEntityType", "value": "", "type": "query", "description": "Three-character FactSet entity type code used to filter candidates in order to determine the final match result. Only candidates with an entity type specified will be considered for the final match result. Multiple types can be entered separated by commas.\n |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|\n |||||\n |ABS|Asset-Backed||MED|Broadcast Call Sign|\n |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|\n |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|\n |CMD|Commodity||MUT|Mutual Fd-Open End|\n |COL|College/University||NPO|Non-Profit Organization|\n |CUR|Currency||OPD|Operating Division|\n |ESP|Emp Stk Ownership Plan||OTH|Other|\n |EXT|Extinct||PEF|Pension Fund|\n |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|\n |FND|Foundation/Endowment||PUB|Public Company|\n |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|\n |FRX|ForEx||PVT|Private Company|\n |GOV|Government||SOV|Sovereign Wealth Fund|\n |HED|Hedge Fund||SUB|Subsidiary|\n |HOL|Holding Company||TRU|Trust/Trustee|\n |IDX|Index||UMB|Umbrella Fund|\n |VEN|Venture Capital Fund||JVT|Joint Venture|\n" }, { "name": "excludeEntityType", "value": "", "type": "query", "description": "Three-character FactSet entity type code used to filter candidates in order to determine the final match result. Candidates with an entity type specified will *not* be considered for the final match result. Multiple types can be entered separated by commas.\n |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|\n |||||\n|ABS|Asset-Backed||MED|Broadcast Call Sign|\n|BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|\n|CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|\n|CMD|Commodity||MUT|Mutual Fd-Open End|\n|COL|College/University||NPO|Non-Profit Organization|\n|CUR|Currency||OPD|Operating Division|\n|ESP|Emp Stk Ownership Plan||OTH|Other|\n|EXT|Extinct||PEF|Pension Fund|\n|FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|\n|FND|Foundation/Endowment||PUB|Public Company|\n|FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|\n|FRX|ForEx||PVT|Private Company|\n|GOV|Government||SOV|Sovereign Wealth Fund|\n|HED|Hedge Fund||SUB|Subsidiary|\n|HOL|Holding Company||TRU|Trust/Trustee|\n|IDX|Index||UMB|Umbrella Fund|\n|VEN|Venture Capital Fund||JVT|Joint Venture|\n" }, { "name": "includeEntitySubType", "value": "", "type": "query", "description": "Two-character FactSet entity subtype code used to filter candidates in order to determine the final match result. Only candidates with an entity subtype specified will be considered for the final match result. Multiple types can be entered separated by commas.\n |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|\n |||||\n |AR|Arbitrage|IC|Investment Company|\n |BM|Bank Investment Division|IN|Insurance Company|\n |BR|Broker|MF|Mutual Fund Manager|\n |CP|Corporate|ML|Master Ltd Part|\n |CU|Custodial|MM|Market Maker|\n |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|\n |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|\n |FO|Foundation/Endowment Manager|PP|Real Estate Manager|\n |FS|Fund Distributor|RE|Research Firm|\n |FU|Fund|SB|Subsidiary Branch|\n |FY|Family Office|ST|Stock Borrowing/Lending|\n |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|\n |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|\n |IA|Investment Adviser|\n |IB|Investment Banking|\n" }, { "name": "excludeEntitySubType", "value": "", "type": "query", "description": "Two-character FactSet entity subtype code used to filter candidates in order to determine the final match result. Candidates with an entity subtype specified will not be considered for the final match result. Multiple types can be entered separated by commas.\n|Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|\n|||||\n|AR|Arbitrage|IC|Investment Company|\n|BM|Bank Investment Division|IN|Insurance Company|\n|BR|Broker|MF|Mutual Fund Manager|\n|CP|Corporate|ML|Master Ltd Part|\n|CU|Custodial|MM|Market Maker|\n|FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|\n|FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|\n|FO|Foundation/Endowment Manager|PP|Real Estate Manager|\n|FS|Fund Distributor|RE|Research Firm|\n|FU|Fund|SB|Subsidiary Branch|\n|FY|Family Office|ST|Stock Borrowing/Lending|\n|GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|\n|HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|\n|IA|Investment Adviser|\n|IB|Investment Banking|\n" }, { "name": "includeParent", "value": "", "type": "query", "description": "Flag to include parent entities in the list of candidates. This parameter does not influence the match result." }, { "name": "bbgFigi", "value": "", "type": "query", "description": "Input identifiers for the Bloomberg Listing/Regional/Security ID symbol type." }, { "name": "bbgTicker", "value": "", "type": "query", "description": "Input identifiers for the Bloomberg Listing and Regional Ticker symbol Type." }, { "name": "bic", "value": "", "type": "query", "description": "Input identifiers for the BICCode - Bank Indentification Code symbol Type." }, { "name": "cik", "value": "", "type": "query", "description": "Input identifiers for the CIK - Edgar Central Index Keys symbol type." }, { "name": "crd", "value": "", "type": "query", "description": "Input identifiers for the CRD - Central Registration Depository symbol type." }, { "name": "cusip", "value": "", "type": "query", "description": "Input identifiers for the CUSIP symbol type." }, { "name": "duns", "value": "", "type": "query", "description": "Input identifiers for the DUNS - Dun & Bradstreet Data Universal Numbering System symbol type." }, { "name": "ein", "value": "", "type": "query", "description": "Input identifiers for the EIN - Employer Identification Number symbol type." }, { "name": "factsetId", "value": "", "type": "query", "description": "Input identifiers for the type FactSet Identifier - FactSet -E,-S,-R, -L Permanent Identifier symbol type." }, { "name": "fitch", "value": "", "type": "query", "description": "Input identifiers for the Fitch - Fitch Ratings symbol type." }, { "name": "gvkey", "value": "", "type": "query", "description": "Input identifiers for the type GVKEY - Compustat Global Company Key symbol type." }, { "name": "gvkeyIid", "value": "", "type": "query", "description": "Input identifiers for the type GVKEY+IID - Compustat Global Company Key and Issue Identifier symbol type." }, { "name": "isin", "value": "", "type": "query", "description": "Input identifiers for the ISIN - International Securities Identification Number symbol type." }, { "name": "jcn", "value": "", "type": "query", "description": "Input identifiers for the type JCN - Japanese Corporate Number symbol type." }, { "name": "lei", "value": "", "type": "query", "description": "Input identifiers for the LEI - Legal Entity Identifier symbol type" }, { "name": "lxid", "value": "", "type": "query", "description": "Input identifiers for the type LXID - Markit Syndicated Loan Identifier symbol type." }, { "name": "md", "value": "", "type": "query", "description": "Input identifiers for the Moody's Ratings Identifier type." }, { "name": "redCode", "value": "", "type": "query", "description": "Input identifiers for the type Red Code - Markit Reference Entity Identifier symbol type." }, { "name": "rssd", "value": "", "type": "query", "description": "Input identifiers for the RSSD - Federal Reserve RSSD symbol typ." }, { "name": "sedol", "value": "", "type": "query", "description": "Input identifiers for the SEDOL symbol type." }, { "name": "spr", "value": "", "type": "query", "description": "Input identifiers for the Price Ticker symbol type." }, { "name": "ticker", "value": "", "type": "query", "description": "Input identifiers for the Price Ticker symbol type." }, { "name": "tickerExchange", "value": "", "type": "query", "description": "Input identifiers for the TickerExchange." }, { "name": "tickerRegion", "value": "", "type": "query", "description": "Input identifiers for the TickerRegion." }, { "name": "ukch", "value": "", "type": "query", "description": "Input identifiers for the UKCH - UK Company House symbol type." }, { "name": "valoren", "value": "", "type": "query", "description": "Input identifiers for the Valoren (\"Valor\") symbol type." }, { "name": "wkn", "value": "", "type": "query", "description": "Input identifiers for the WKN - German Securities symbol type." } ] }, "docs": "Finds the best candidate entities matching the given entity name. Additional attributes can be supplied to narrow the search, such as State, URL, and Entity Types.

**Max of 1 Name permitted in a single GET request.** Use the POST method for /entity-match to fetch up to 25 names. Otherwise, use the \"Entity Match - Bulk\" workflow to submit larger universes of names to be concorded via a file.

\n" }, { "info": { "name": "Factset Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/entity-match", "body": { "type": "json", "data": "{}" } }, "docs": "Finds the best candidate entities matching the given entity name. If a `universeId` is provided, any match for an input including a `clientId` will be saved to that universe. Additional attributes can be supplied to narrow the search, such as State, URL, and Entity Types. Finds the best candidate entities matching the given company name. Additional attributes can be supplied to narrow the search.

**Max of 25 Names inputted.** Use the \"Entity Match - Bulk\" workflow to submit larger universes " }, { "info": { "name": "Factset Input a file with names and attributes, creating a taskId.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/entity-task", "body": { "type": "multipart-form", "data": [ { "name": "universeId", "type": "text", "value": "" }, { "name": "taskName", "type": "text", "value": "" }, { "name": "inputFile", "type": "text", "value": "" }, { "name": "clientIdColumn", "type": "text", "value": "" }, { "name": "nameColumn", "type": "text", "value": "" }, { "name": "countryColumn", "type": "text", "value": "" }, { "name": "urlColumn", "type": "text", "value": "" }, { "name": "stateColumn", "type": "text", "value": "" }, { "name": "priorityColumn", "type": "text", "value": "" }, { "name": "bbgFigiColumn", "type": "text", "value": "" }, { "name": "bbgTickerColumn", "type": "text", "value": "" }, { "name": "bicColumn", "type": "text", "value": "" }, { "name": "cikColumn", "type": "text", "value": "" }, { "name": "crdColumn", "type": "text", "value": "" }, { "name": "cusipColumn", "type": "text", "value": "" }, { "name": "dunsColumn", "type": "text", "value": "" }, { "name": "einColumn", "type": "text", "value": "" }, { "name": "factsetIdColumn", "type": "text", "value": "" }, { "name": "fitchColumn", "type": "text", "value": "" }, { "name": "gvkeyColumn", "type": "text", "value": "" }, { "name": "gvkeyIidColumn", "type": "text", "value": "" }, { "name": "isinColumn", "type": "text", "value": "" }, { "name": "jcnColumn", "type": "text", "value": "" }, { "name": "leiColumn", "type": "text", "value": "" }, { "name": "lxidColumn", "type": "text", "value": "" }, { "name": "mdColumn", "type": "text", "value": "" }, { "name": "redCodeColumn", "type": "text", "value": "" }, { "name": "rssdColumn", "type": "text", "value": "" }, { "name": "sedolColumn", "type": "text", "value": "" }, { "name": "sprColumn", "type": "text", "value": "" }, { "name": "tickerColumn", "type": "text", "value": "" }, { "name": "tickerExchangeColumn", "type": "text", "value": "" }, { "name": "tickerRegionColumn", "type": "text", "value": "" }, { "name": "ukchColumn", "type": "text", "value": "" }, { "name": "valorenColumn", "type": "text", "value": "" }, { "name": "wknColumn", "type": "text", "value": "" }, { "name": "includeEntityType", "type": "text", "value": "" }, { "name": "excludeEntityType", "type": "text", "value": "" }, { "name": "includeEntitySubType", "type": "text", "value": "" }, { "name": "excludeEntitySubType", "type": "text", "value": "" }, { "name": "additionalContextColumns", "type": "text", "value": "" } ] } }, "docs": "Upload a Comma-Separated List file (.csv / UTF-8 encoding) with a list of names and attributes and receive a `taskId`. The taskId is then used for reference in the */entity-task-status* and */entity-decisions* endpoints to receive results once the task is successful.

This is the first step in the overall \"Bulk\" workflow. Use the /entity-task-status endpoint to check the status.

A universeId must be included in request. If you do not have a universe created, reference the `/universe` en" }, { "info": { "name": "Factset Gets the status of the requested taskId or all tasks for a User", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/entity-task-status", "params": [ { "name": "taskId", "value": "31589", "type": "query", "description": "Name of the column for the type Concordance Task Identifier. The taskId is created in response from the /entity-task endpoint." }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." }, { "name": "status", "value": "", "type": "query", "description": "Filter on the status of the Concordance Tasks. Default is no filter.\n * PENDING - The task has not yet started\n * IN_PROGRESS - The task is submitted and decisions are in progress.\n * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.\n * FAILURE - The task failed. Reach out to FactSet Support for assistance.\n * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.\n * ABORTED - The task was aborted.\n" } ] }, "docs": "Pulls the **status** for ALL the Entity Tasks submitted by a client within the last 30 days, and related details such as task duration and decision rates. Specific Tasks can also be retrieved by using the _taskId_ parameter.

Status types include -\n * PENDING - The task has not yet started.\n * IN_PROGRESS - The task is submitted and decisions are in progress.\n * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.\n * FAILURE - The task failed. Rea" }, { "info": { "name": "Factset Get the decisions of matches for the requested taskId.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/entity-decisions", "params": [ { "name": "taskId", "value": "31589", "type": "query", "description": "Name of the column for the type Concordance Task Identifier. The taskId is created in response from the /entity-task endpoint." }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." } ] }, "docs": "Retrieves the `Decision` objects for an Entity Task (taskId). The decisions do not include all candidates, but rather the results of concording the requested list of names included in the input file. Mapped entities will include a FactSet Entity Identifier (-E). Results will be saved to the `universeId` specified in the input file.\n" }, { "info": { "name": "Factset Create a new universe", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/universe", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new universe that is distinct from any existing universe\n" }, { "info": { "name": "Factset Retrieve all saved mappings within a requested universe", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/entity-universe", "params": [ { "name": "universeId", "value": "1", "type": "query", "description": "Universe identifier. *To create a universe, use the `/universe' endpoint.*" }, { "name": "clientId", "value": "abc-123,def-456", "type": "query", "description": "Filter by the clientId(s) created by the user in a previous mapping.\n" }, { "name": "mapStatus", "value": "", "type": "query", "description": "Filter by the Entity Decisions that have the specified mapStatus, where -\n * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)\n * UNMAPPED - The requested Entity Name is unmapped by FactSet.\n * INDETERMINATE - The requested Entity Name was unable to make a mapping.\n" }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." }, { "name": "sort", "value": "clientId:asc,clientName:desc", "type": "query", "description": "Sort clientId, createdTime, updatedTime, clientName, entityId fields in ascending or descending order with asc and desc to indicate the order. Example (clientId:asc)" } ] }, "docs": "Retrieves all entity mappings within a requested universe.\n" }, { "info": { "name": "Factset Retrieve all saved mappings within a requested universe or large list of client ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/entity-universe", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves all entity mappings that were saved in a given universe. Supports filtering by a large number of `clientId`s\n" }, { "info": { "name": "Factset Retrieve all saved mappings within a requested universe", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/people-universe", "params": [ { "name": "universeId", "value": "1", "type": "query", "description": "Universe identifier. *To create a universe, use the `/universe' endpoint.*" }, { "name": "clientId", "value": "abc-123,def-456", "type": "query", "description": "Filter by the clientId(s) created by the user in a previous mapping.\n" }, { "name": "mapStatus", "value": "", "type": "query", "description": "Filter by the Entity Decisions that have the specified mapStatus, where -\n * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)\n * UNMAPPED - The requested Entity Name is unmapped by FactSet.\n * INDETERMINATE - The requested Entity Name was unable to make a mapping.\n" }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." }, { "name": "sort", "value": "clientId:asc,clientPersonName:desc", "type": "query", "description": "Sort clientId, createdTime, updatedTime, clientPersonName, personId fields in ascending or descending order with asc and desc to indicate the order. Example (clientId:asc)" } ] }, "docs": "Retrieves all people mappings within a requested universe.\n" }, { "info": { "name": "Factset Retrieve all saved mappings within a requested universe or large list of client ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/people-universe", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves all people mappings that were saved in a given universe. Supports filtering by a large number of `clientId`s\n" }, { "info": { "name": "Factset Update metadata for an existing universe", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/update-universe", "body": { "type": "json", "data": "{}" } }, "docs": "Update metadata for an existing universe\n" }, { "info": { "name": "Factset Fetch metadata for universes", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/universes", "params": [ { "name": "universeId", "value": "1", "type": "query", "description": "Universe identifier. *To create a universe, use the `/universe' endpoint.*" }, { "name": "universeType", "value": "ENTITY", "type": "query", "description": "Universe Type." } ] }, "docs": "Fetch information on active universes for the current user. Optionally filter for a specific universe given a `universeId`\n" }, { "info": { "name": "Factset Get statistics on a given universe", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/entity-universe-statistics", "params": [ { "name": "universeId", "value": "1", "type": "query", "description": "Universe identifier. *To create a universe, use the `/universe' endpoint.*" } ] }, "docs": "Get the total number of mappings in a universe, as well as the number of mapped, unmapped and indeterminate mappings\n" }, { "info": { "name": "Factset Get statistics on a given universe", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/universe-statistics", "params": [ { "name": "universeId", "value": "1", "type": "query", "description": "Universe identifier. *To create a universe, use the `/universe' endpoint.*" } ] }, "docs": "Get the total number of mappings in a universe, as well as the number of mapped, unmapped and indeterminate mappings\n" }, { "info": { "name": "Factset Saves a single-mapping specified by the client.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/entity-mapping", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a Concordance Mapping to the client universe. When making a post, all exiting values are overwritten in the database with the values passed in the request. clientId and clientName are required.\n" }, { "info": { "name": "Factset Saves a single-mapping specified by the client.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/people-mapping", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a single Concordance People Mapping to a given universe. When making a post, all exiting values are overwritten in the database with the values passed in the request. clientId and clientName are required.\n" }, { "info": { "name": "Factset Deletes mapping specified by the client.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/entity-mapping-delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a Concordance Mapping to the client universe. When making a post, all exiting values are overwritten in the database with the values passed in the request. clientId and universeId are required.\n" }, { "info": { "name": "Factset Deletes mapping specified by the client.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/people-mapping-delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a Concordance Mapping to the client universe. When making a post, all exiting values are overwritten in the database with the values passed in the request. clientId and universeId are required.\n" }, { "info": { "name": "Factset Perform an entity search and return a snowflake-friendly response. Up to 25 Names per request.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/snowflake-entity-match", "body": { "type": "json", "data": "{}" } }, "docs": "Finds the best candidate entities matching the given company name. Additional attributes can be supplied to narrow the search. *This endpoint is used natively within Snowflake and is not to be consumed directly by users. Reach out to your FactSet Account team to learn more about Concordance in Snowflake.*\n" }, { "info": { "name": "Factset Save entity mappings to a universe", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/snowflake-entity-mapping", "body": { "type": "json", "data": "{}" } }, "docs": "Manually save or update entity mappings with metadata" }, { "info": { "name": "Factset Find potential people matches given a person's name.People matches can be retrieved using person's name and other attributes like firstname, middlename and lastname.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/people-match", "params": [ { "name": "personName", "value": "Bill Gates", "type": "query", "description": "Name of Person to match." }, { "name": "salutation", "value": "Mr", "type": "query", "description": "Title in person's name. This parameter should not be provided when the person name is provided as the input." }, { "name": "firstName", "value": "Bill", "type": "query", "description": "First name of person. This parameter should not be provided when the person name is provided as the input." }, { "name": "middleName", "value": "Henry", "type": "query", "description": "Middle name of person.This parameter should not be provided when the person name is provided as the input." }, { "name": "lastName", "value": "Gates", "type": "query", "description": "Last name of person. This parameter should not be provided when the person name is provided as the input." }, { "name": "suffix", "value": "III", "type": "query", "description": "Suffix in person's name. This parameter should not be provided when the person name is provided as the input." }, { "name": "entity", "value": "Microsoft", "type": "query", "description": "Entity the person is associated with. It is used to filter the candidates before taking a match decision. Can be entity ID or name. The supported entity types match the what is supported via the /company match." } ] }, "docs": "Finds the best people candidates matching the given name.

**Max of 1 Name permitted in a single GET request.** Use the POST method for /people-match to fetch up to 25 names. Otherwise, use the \"People Match - Bulk\" workflow to submit larger universes of names to be concorded via a file.

\n" }, { "info": { "name": "Factset Find potential people matches given a person's name.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/people-match", "body": { "type": "json", "data": "{}" } }, "docs": "Finds the best candidate people matching the given people names. Additional attributes can be supplied to narrow the search. If a `universeId` is provided, any match for an input including a `clientId` will be saved to that universe.\n" }, { "info": { "name": "Factset Create a People Concordance Task.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-concordance/v2/people-task", "body": { "type": "multipart-form", "data": [ { "name": "universeId", "type": "text", "value": "" }, { "name": "taskName", "type": "text", "value": "" }, { "name": "inputFile", "type": "text", "value": "" }, { "name": "clientIdColumn", "type": "text", "value": "" }, { "name": "additionalContextColumns", "type": "text", "value": "" }, { "name": "entityColumn", "type": "text", "value": "" }, { "name": "firstNameColumn", "type": "text", "value": "" }, { "name": "lastNameColumn", "type": "text", "value": "" }, { "name": "middleNameColumn", "type": "text", "value": "" }, { "name": "personNameColumn", "type": "text", "value": "" }, { "name": "priorityColumn", "type": "text", "value": "" }, { "name": "salutationColumn", "type": "text", "value": "" }, { "name": "suffixColumn", "type": "text", "value": "" } ] } }, "docs": "The \"Bulk\" workflow allows the user to create a People Concordance Task. Uploading of a Comma-Separated List file (.csv / UTF-8 encoding) with a list of names and attributes and creation of a task id is mandatory to start the process.\n The taskId is then used for reference in the /people-task-status and /people-decisions endpoints to receive results once the task is successful.The /people-task-status endpoint is to check the status of the Tasks as per the ids.\n A universeId must be included" }, { "info": { "name": "Factset Get the Status of the People Tasks.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/people-task-status", "params": [ { "name": "taskId", "value": "31589", "type": "query", "description": "Concordance Task Identifier. The taskId is created in response from the /people-task endpoint." }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." }, { "name": "status", "value": "", "type": "query", "description": "Filter on the status of the Concordance Tasks. Default is no filter.\n * PENDING - The task has not yet started\n * IN_PROGRESS - The task is submitted and decisions are in progress.\n * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.\n * FAILURE - The task failed. Reach out to FactSet Support for assistance.\n * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.\n * ABORTED - The task was aborted.\n" } ] }, "docs": "Pulls the **status** for ALL the People Tasks submitted by a client within the last 30 days, and related details such as task duration and decision rates. Specific Tasks can also be retrieved by using the _taskId_ parameter.

Status types include -\n * PENDING - The task has not yet started.\n * IN_PROGRESS - The task is submitted and decisions are in progress.\n * SUCCESS - The task was successful! Move to the /people-decisions endpoint to retrieve decisions.\n * FAILURE - The task failed. Rea" }, { "info": { "name": "Factset Get the decisions of matches for the requested taskId.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-concordance/v2/people-decisions", "params": [ { "name": "taskId", "value": "31589", "type": "query", "description": "Concordance Task Identifier. The taskId is created in response from the /people-task endpoint." }, { "name": "offset", "value": "", "type": "query", "description": "Starting row for records to return or rows to skip." }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the number of records in the response." } ] }, "docs": "Retrieves the `Decision` objects for an People Task (taskId). The decisions do not include all candidates, but rather the results of concording the requested list of names included in the input file. Mapped entities will include a FactSet Entity Identifier (-E). Results will be saved to the `universeId` specified in the input file.\n" } ] } ], "bundled": true }