{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"58d2e00d-2fc0-4594-89e3-3c6d43bf293d","name":"Cognism API","description":"The Cognism API is used to search, preview and enrich Contacts and Accounts. Cognism database provides extensive B2B contacts and sales intelligence data.\n\n**NOTE:** API responses may differ from the results retrieved via Prospector search (Web Application). We strive to ensure that the API is updated regularly to align as closely as possible with Prospector search results. However, discrepancies can occur due to various factors, including data updates and system enhancements. We appreciate your understanding and are committed to improving the accuracy and reliability of our API services.\n\n## Improvements\n\nThe new Cognism API reduces complexity when searching, and it simplifies data structure. Also, response time is greatly improved.\n\n**NOTE:** Pagination of results is possible from first to last result, but you cannot hop between pages.\n\n**Benefits include:**\n\n- Better accuracy on technology and event searches\n    \n- Ability to create more complex queries\n    \n- The new Cognism API also removes the limitation of 10,000 displayed results, making it now unlimited.\n    \n- Visibility for all open positions for each contact - with different emails and company phones.\n    \n- Ability to configure the response fields in line with the entitlements.\n    \n\n### Credits\n\nCredit burn remain as was, currently only on contacts, but not on account. This might change in the future.\n\n---\n\n# Authentication\n\nCognism uses API keys to allow access to the APIs. The API Key is assigned to you by Cognism and it is used to authenticate and authorize each request.\n\n**Your API key should be kept private, and should never be displayed publicly.**\n\nAPI keys have a time-to-live \\[TTL\\] of 6 months.\n\nYou can manually generate additional keys or remove existing ones using one of our tools:\n\n- Cognism Prospector, or\n    \n- Cognism Refresh.\n    \n\nYou can authenticate HTTP requests in one of two ways:\n\n1. Using header field \"**Authorization: Bearer {API KEY}**\"\n    \n2. Using query string \"**api_key={API KEY}**\"\n    \n\nKeep in mind that we recommend the use of the HTTP header field rather than the api_key query parameter as it provides an added level of security. The documentation uses HTTP header field in all examples.\n\n---\n\n# API structure\n\nAPI contains a set of HTTPS endpoints providing all necessary details to preview and redeem contacts of your choice.\n\nThe API is built using RESTful endpoints and standard HTTP verbs.\n\n---\n\n# Entitlements\n\nEntitlements are a defined set of Contact and Account data that is available for you. They are set by Cognism Support Team.\n\nEntitlement definition affects Search, Preview and Result. Entitlements are related to the API Key.\n\n**Cognism API cannot be used unless Entitlements are properly set up.**\n\n## Basic Info\n\nNo matter what entitlement you choose, basic info will always be present. This is minimum data defining Contact or Account entity.\n\nEntitlements are built on top of basic info.\n\n#### Basic Contact info\n\nBasic info for Contact entity\n\n``` json\n{\n  \"id\": \"String (UUID)\",\n  \"fullName\": \"String\",\n  \"firstName\": \"String\",\n  \"lastName\": \"String\",\n  \"jobTitle\": \"String\",\n  \"account\": \n  {\n    \"id\": \"String\",\n    \"name\": \"String\"\n  }\n}\n\n ```\n\n| Field name | Description |\n| --- | --- |\n| id | Contact Cognism Unique ID |\n| name | Contact Full Name |\n| first | Contact First Name |\n| last | Contact Last Name |\n| currentCompany.id | Contact Current Company ID |\n| currentCompany.name | Contact Current Company Name |\n| currentCompany.jobTitle | Contact Job Title within Current Company |\n\n#### Basic Account info\n\nBasic info for Account entity\n\n``` json\n{\n  \"id\": \"String\",\n  \"name\": \"String\"\n}\n\n ```\n\n| Field name | Description |\n| --- | --- |\n| id | Account Cognism Unique ID |\n| name | Account Name |\n\n## Contact Entitlement\n\nUse Predefined Contact Entitlements table to check full set of Contact supported fields. Entitlement affects Contact search and response data.\n\n#### Predefined Contact Entitlements\n\n| Contact Fields | Standard | Advanced |\n| --- | --- | --- |\n| id | Y | Y |\n| fullName | Y | Y |\n| firstName | Y | Y |\n| lastName | Y | Y |\n| jobTitle | Y | Y |\n| lastConfirmed | Y | Y |\n| managementLevel | Y | Y |\n| jobFunction | Y | Y |\n| seniority | Y | Y |\n| positionStartDate | Y | Y |\n| mobilePhoneNumbers |  | Y |\n| directPhoneNumbers |  | Y |\n| region | Y | Y |\n| country | Y | Y |\n| state | Y | Y |\n| city | Y | Y |\n| zip | Y | Y |\n| street | Y | Y |\n| education | Y | Y |\n| skills | Y | Y |\n| linkedinUrl | Y | Y |\n| email | Y | Y |\n| privacyNotificationSent | Y | Y |\n| locationMoveEvent |  | Y |\n| jobJoinEvent |  | Y |\n| jobLeaveEvent |  | Y |\n| previousAccount | Y | Y |\n| account.id | Y | Y |\n| account.name | Y | Y |\n| account.domain | Y | Y |\n| account.industry | Y | Y |\n| account.description | Y | Y |\n| account.shortDescription | Y | Y |\n| account.founded | Y | Y |\n| account.website | Y | Y |\n| account.linkedinUrl | Y | Y |\n| account.revenue | Y | Y |\n| account.sic | Y | Y |\n| account.isic | Y | Y |\n| account.naics | Y | Y |\n| account.size | Y | Y |\n| account.headcount | Y | Y |\n| account.technology | Y | Y |\n| account.type | Y | Y |\n| account.officePhoneNumbers |  | Y |\n| account.hqPhoneNumbers |  | Y |\n| account.location | Y | Y |\n| account.hiringEvent |  | Y |\n| account.fundingEvent |  | Y |\n| account.acquisitonEvent |  | Y |\n| account.ipoEvent |  | Y |\n\n## Account Entitlement\n\nUse Predefined Account Entitlements table to check full set of Account supported fields. Entitlement affects Contact search and response data.\n\n#### Predefined Account Entitlements\n\n| Contact Fields | Standard | Advanced |\n| --- | --- | --- |\n| id | Y | Y |\n| name | Y | Y |\n| domain | Y | Y |\n| industry | Y | Y |\n| description | Y | Y |\n| shortDescription | Y | Y |\n| founded | Y | Y |\n| website | Y | Y |\n| linkedinUrl | Y | Y |\n| revenue | Y | Y |\n| sic | Y | Y |\n| isic | Y | Y |\n| naics | Y | Y |\n| size | Y | Y |\n| headcount | Y | Y |\n| technology | Y | Y |\n| type | Y | Y |\n| officePhoneNumbers |  | Y |\n| hqPhoneNumbers |  | Y |\n| location | Y | Y |\n| hiringEvent |  | Y |\n| fundingEvent |  | Y |\n| acquisitonEvent |  | Y |\n| ipoEvent |  | Y |\n\n## My Entitlements\n\nTo check how your entitlements are defined use [MyEntitlementContact](#0c23e257-7198-4fd1-83f7-46632d3120a3) and [MyEntitlementAccount](#2dc967bf-c544-4896-889a-ff4583781450).\n\n---\n\n# Response schema\n\n> Actual returned object will contain fields based on user Entitlements \n  \n\n## Contact\n\nRedeemed contact response complete object\n\n``` json\n{\n  \"properties\": {\n    \"totalResults\": {\n      \"type\": \"integer\"\n    },\n    \"results\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"account\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"name\": {\n                  \"type\": \"string\"\n                },\n                \"id\": {\n                  \"type\": \"string\"\n                },\n                \"officePhoneNumbers\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"number\": {\n                          \"type\": \"string\"\n                        },\n                        \"numberType\": {\n                          \"type\": \"string\"\n                        },\n                        \"label\": {\n                          \"type\": \"string\"\n                        },\n                        \"score\": {\n                          \"type\": \"integer\"\n                        },\n                        \"addressType\": {\n                          \"type\": \"string\"\n                        },\n                        \"ext\": {\n                          \"type\": \"string\"\n                        },\n                        \"dnc\": {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"status\": {\n                              \"type\": \"boolean\"\n                            }\n                          }\n                        }\n                      }\n                    }\n                  ]\n                },\n                \"hqPhoneNumbers\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"number\": {\n                          \"type\": \"string\"\n                        },\n                        \"numberType\": {\n                          \"type\": \"string\"\n                        },\n                        \"label\": {\n                          \"type\": \"string\"\n                        },\n                        \"score\": {\n                          \"type\": \"integer\"\n                        },\n                        \"addressType\": {\n                          \"type\": \"string\"\n                        },\n                        \"ext\": {\n                          \"type\": \"string\"\n                        },\n                        \"dnc\": {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"status\": {\n                              \"type\": \"boolean\"\n                            }\n                          }\n                        }\n                      }\n                    }\n                  ]\n                },\n                \"hiringEvent\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"country\": {\n                          \"type\": \"string\"\n                        },\n                        \"state\": {\n                          \"type\": \"string\"\n                        },\n                        \"city\": {\n                          \"type\": \"string\"\n                        },\n                        \"jobTitle\": {\n                          \"type\": \"string\"\n                        },\n                        \"department\": {\n                          \"type\": \"string\"\n                        },\n                        \"jobType\": {\n                          \"type\": \"string\"\n                        },\n                        \"internship\": {\n                          \"type\": \"boolean\"\n                        },\n                        \"jobHours\": {\n                          \"type\": \"string\"\n                        },\n                        \"workFromHome\": {\n                          \"type\": \"boolean\"\n                        },\n                        \"employer\": {\n                          \"type\": \"string\"\n                        },\n                        \"url\": {\n                          \"type\": \"string\"\n                        },\n                        \"type\": {\n                          \"type\": \"string\"\n                        },\n                        \"jobDate\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  ]\n                },\n                \"fundingEvent\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                      \"announcedOn\": {\n                        \"type\": \"long\"\n                      },\n                      \"fundingType\": {\n                        \"type\": \"string\"\n                      },\n                      \"series\": {\n                        \"type\": \"string\"\n                      },\n                      \"moneyRaisedUsd\": {\n                        \"type\": \"long\"\n                      },\n                      \"postMoneyValuationUsd\": {\n                        \"type\": \"long\"\n                      },\n                      \"investors\": {\n                        \"type\": \"array\",\n                        \"description\": \"List of investor names\",\n                        \"items\": {\n                          \"type\": \"string\"\n                        }\n                      },\n                      \"type\": {\n                        \"type\": \"string\"\n                      }\n                    }\n                  }\n                },\n                \"ipoEvent\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                      \"wentPublicOn\": {\n                        \"type\": \"long\"\n                      },\n                      \"stockExchangeSymbol\": {\n                        \"type\": \"string\"\n                      },\n                      \"stockSymbol\": {\n                        \"type\": \"string\"\n                      },\n                      \"openingValuationUsd\": {\n                        \"type\": \"long\"\n                      },\n                      \"moneyRaisedUsd\": {\n                        \"type\": \"long\"\n                      },\n                      \"investors\": {\n                        \"type\": \"array\",\n                        \"items\": {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"name\": {\n                              \"type\": \"string\"\n                            }\n                          }\n                        }\n                      },\n                      \"type\": {\n                        \"type\": \"string\"\n                      }\n                    }\n                  }\n                },\n                \"acquisitionEvent\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                      \"acquiredOn\": {\n                        \"type\": \"string\"\n                      },\n                      \"acquisitionType\": {\n                        \"type\": \"string\"\n                      },\n                      \"acquirer\": {\n                        \"type\": \"string\"\n                      },\n                      \"acquiree\": {\n                        \"type\": \"string\"\n                      },\n                      \"type\": {\n                        \"type\": \"string\"\n                      }\n                    }\n                  }\n                },\n                \"headcount\": {\n                  \"type\": \"integer\"\n                },\n                \"sizeTo\": {\n                  \"type\": \"integer\"\n                },\n                \"sizeFrom\": {\n                  \"type\": \"integer\"\n                },\n                \"location\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"addressType\": {\n                          \"type\": \"string\"\n                        },\n                        \"country\": {\n                          \"type\": \"string\"\n                        },\n                        \"state\": {\n                          \"type\": \"string\"\n                        },\n                        \"city\": {\n                          \"type\": \"string\"\n                        },\n                        \"zip\": {\n                          \"type\": \"string\"\n                        },\n                        \"street\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  ]\n                },\n                \"technologies\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"type\": {\n                  \"type\": \"string\"\n                },\n                \"domain\": {\n                  \"type\": \"string\"\n                },\n                \"industry\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"revenue\": {\n                  \"type\": \"long\"\n                },\n                \"linkedinUrl\": {\n                  \"type\": \"string\"\n                },\n                \"website\": {\n                  \"type\": \"string\"\n                },\n                \"founded\": {\n                  \"type\": \"integer\"\n                },\n                \"lastConfirmed\": {\n                  \"type\": \"long\"\n                },\n                \"naics\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"sic\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"isic\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"shortDescription\": {\n                  \"type\": \"string\"\n                },\n                \"description\": {\n                  \"type\": \"string\"\n                }\n              }\n            },\n            \"jobTitle\": {\n              \"type\": \"string\"\n            },\n            \"lastName\": {\n              \"type\": \"string\"\n            },\n            \"firstName\": {\n              \"type\": \"string\"\n            },\n            \"fullName\": {\n              \"type\": \"string\"\n            },\n            \"id\": {\n              \"type\": \"string\"\n            },\n            \"privacyNotificationSent\": {\n              \"type\": \"boolean\"\n            },\n            \"previousAccounts\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"name\": {\n                      \"type\": \"string\"\n                    },\n                    \"location\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"addressType\": {\n                              \"type\": \"string\"\n                            },\n                            \"country\": {\n                              \"type\": \"string\"\n                            },\n                            \"state\": {\n                              \"type\": \"string\"\n                            },\n                            \"city\": {\n                              \"type\": \"string\"\n                            },\n                            \"zip\": {\n                              \"type\": \"string\"\n                            },\n                            \"street\": {\n                              \"type\": \"string\"\n                            }\n                          }\n                        }\n                      ]\n                    },\n                    \"title\": {\n                      \"type\": \"string\"\n                    },\n                    \"start\": {\n                      \"type\": \"string\"\n                    },\n                    \"end\": {\n                      \"type\": \"string\"\n                    },\n                    \"seniority\": {\n                      \"type\": \"string\"\n                    },\n                    \"jobFunction\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    },\n                    \"email\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"address\": {\n                          \"type\": \"string\"\n                        },\n                        \"quality\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    },\n                    \"managementLevel\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              ]\n            },\n            \"skills\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"linkedinUrl\": {\n              \"type\": \"string\"\n            },\n            \"email\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"address\": {\n                  \"type\": \"string\"\n                },\n                \"quality\": {\n                  \"type\": \"string\"\n                },\n                \"sha256\": {\n                  \"type\": \"string\"\n                }\n              }\n            },\n            \"mobilePhoneNumbers\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"number\": {\n                      \"type\": \"string\"\n                    },\n                    \"numberType\": {\n                      \"type\": \"string\"\n                    },\n                    \"label\": {\n                      \"type\": \"string\"\n                    },\n                    \"score\": {\n                      \"type\": \"integer\"\n                    },\n                    \"addressType\": {\n                      \"type\": \"string\"\n                    },\n                    \"ext\": {\n                      \"type\": \"string\"\n                    },\n                    \"dnc\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"status\": {\n                          \"type\": \"boolean\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"directPhoneNumbers\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"number\": {\n                      \"type\": \"string\"\n                    },\n                    \"numberType\": {\n                      \"type\": \"string\"\n                    },\n                    \"label\": {\n                      \"type\": \"string\"\n                    },\n                    \"score\": {\n                      \"type\": \"integer\"\n                    },\n                    \"addressType\": {\n                      \"type\": \"string\"\n                    },\n                    \"ext\": {\n                      \"type\": \"string\"\n                    },\n                    \"dnc\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"status\": {\n                          \"type\": \"boolean\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"education\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"start\": {\n                      \"type\": \"string\"\n                    },\n                    \"end\": {\n                      \"type\": \"string\"\n                    },\n                    \"school\": {\n                      \"type\": \"string\"\n                    },\n                    \"degree\": {\n                      \"type\": \"string\"\n                    },\n                    \"field\": {\n                      \"type\": \"string\"\n                    },\n                    \"description\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              ]\n            },\n            \"country\": {\n              \"type\": \"string\"\n            },\n            \"region\": {\n              \"type\": \"string\"\n            },\n            \"city\": {\n              \"type\": \"string\"\n            },\n            \"state\": {\n              \"type\": \"string\"\n            },\n            \"street\": {\n              \"type\": \"string\"\n            },\n            \"zip\": {\n              \"type\": \"string\"\n            },\n            \"positionStartDate\": {\n              \"type\": \"string\"\n            },\n            \"seniority\": {\n              \"type\": \"string\"\n            },\n            \"jobFunction\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"managementLevel\": {\n              \"type\": \"string\"\n            },\n            \"lastConfirmed\": {\n              \"type\": \"long\"\n            },\n            \"locationMoveEvent\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"date\": {\n                      \"type\": \"string\"\n                    },\n                    \"from\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"country\": {\n                          \"type\": \"string\"\n                        },\n                        \"city\": {\n                          \"type\": \"string\"\n                        },\n                        \"state\": {\n                          \"type\": \"string\"\n                        },\n                        \"region\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    },\n                    \"to\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"country\": {\n                          \"type\": \"string\"\n                        },\n                        \"city\": {\n                          \"type\": \"string\"\n                        },\n                        \"state\": {\n                          \"type\": \"string\"\n                        },\n                        \"region\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"jobLeaveEvent\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"date\": {\n                      \"type\": \"string\"\n                    },\n                    \"from\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"name\": {\n                          \"type\": \"string\"\n                        },\n                        \"sizeTo\": {\n                          \"type\": \"integer\"\n                        },\n                        \"sizeFrom\": {\n                          \"type\": \"integer\"\n                        },\n                        \"title\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    },\n                    \"to\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"industry\": {\n                          \"type\": \"string\"\n                        },\n                        \"name\": {\n                          \"type\": \"string\"\n                        },\n                        \"sizeTo\": {\n                          \"type\": \"integer\"\n                        },\n                        \"sizeFrom\": {\n                          \"type\": \"integer\"\n                        },\n                        \"title\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"jobJoinEvent\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"date\": {\n                      \"type\": \"string\"\n                    },\n                    \"from\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"industry\": {\n                          \"type\": \"string\"\n                        },\n                        \"name\": {\n                          \"type\": \"string\"\n                        },\n                        \"sizeTo\": {\n                          \"type\": \"integer\"\n                        },\n                        \"sizeFrom\": {\n                          \"type\": \"integer\"\n                        },\n                        \"title\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    },\n                    \"to\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"industry\": {\n                          \"type\": \"string\"\n                        },\n                        \"name\": {\n                          \"type\": \"string\"\n                        },\n                        \"sizeTo\": {\n                          \"type\": \"integer\"\n                        },\n                        \"sizeFrom\": {\n                          \"type\": \"integer\"\n                        },\n                        \"title\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"redeemId\": {\n              \"type\": \"string\"\n            }\n          }\n        }\n      ]\n    }\n  }\n}\n\n ```\n\n## Account\n\nRedeemed account response complete object\n\n``` json\n{\n  \"properties\": {\n    \"totalResults\": {\n      \"type\": \"integer\"\n    },\n    \"results\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"name\": {\n              \"type\": \"string\"\n            },\n            \"id\": {\n              \"type\": \"string\"\n            },\n            \"officePhoneNumbers\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"number\": {\n                      \"type\": \"string\"\n                    },\n                    \"numberType\": {\n                      \"type\": \"string\"\n                    },\n                    \"label\": {\n                      \"type\": \"string\"\n                    },\n                    \"score\": {\n                      \"type\": \"integer\"\n                    },\n                    \"addressType\": {\n                      \"type\": \"string\"\n                    },\n                    \"ext\": {\n                      \"type\": \"string\"\n                    },\n                    \"dnc\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"status\": {\n                          \"type\": \"boolean\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"hqPhoneNumbers\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"number\": {\n                      \"type\": \"string\"\n                    },\n                    \"numberType\": {\n                      \"type\": \"string\"\n                    },\n                    \"label\": {\n                      \"type\": \"string\"\n                    },\n                    \"score\": {\n                      \"type\": \"integer\"\n                    },\n                    \"addressType\": {\n                      \"type\": \"string\"\n                    },\n                    \"ext\": {\n                      \"type\": \"string\"\n                    },\n                    \"dnc\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"status\": {\n                          \"type\": \"boolean\"\n                        }\n                      }\n                    }\n                  }\n                }\n              ]\n            },\n            \"hiringEvent\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"country\": {\n                      \"type\": \"string\"\n                    },\n                    \"state\": {\n                      \"type\": \"string\"\n                    },\n                    \"city\": {\n                      \"type\": \"string\"\n                    },\n                    \"jobTitle\": {\n                      \"type\": \"string\"\n                    },\n                    \"department\": {\n                      \"type\": \"string\"\n                    },\n                    \"jobType\": {\n                      \"type\": \"string\"\n                    },\n                    \"internship\": {\n                      \"type\": \"boolean\"\n                    },\n                    \"jobHours\": {\n                      \"type\": \"string\"\n                    },\n                    \"workFromHome\": {\n                      \"type\": \"boolean\"\n                    },\n                    \"employer\": {\n                      \"type\": \"string\"\n                    },\n                    \"url\": {\n                      \"type\": \"string\"\n                    },\n                    \"type\": {\n                      \"type\": \"string\"\n                    },\n                    \"jobDate\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              ]\n            },\n            \"fundingEvent\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"announcedOn\": {\n                    \"type\": \"long\"\n                  },\n                  \"fundingType\": {\n                    \"type\": \"string\"\n                  },\n                  \"series\": {\n                    \"type\": \"string\"\n                  },\n                  \"moneyRaisedUsd\": {\n                    \"type\": \"long\"\n                  },\n                  \"postMoneyValuationUsd\": {\n                    \"type\": \"long\"\n                  },\n                  \"investors\": {\n                    \"type\": \"array\",\n                    \"description\": \"List of investor names\",\n                    \"items\": {\n                      \"type\": \"string\"\n                    }\n                  },\n                  \"type\": {\n                    \"type\": \"string\"\n                  }\n                }\n              }\n            },\n            \"ipoEvent\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"wentPublicOn\": {\n                    \"type\": \"integer\"\n                  },\n                  \"stockExchangeSymbol\": {\n                    \"type\": \"string\"\n                  },\n                  \"stockSymbol\": {\n                    \"type\": \"string\"\n                  },\n                  \"openingValuationUsd\": {\n                    \"type\": \"integer\"\n                  },\n                  \"moneyRaisedUsd\": {\n                    \"type\": \"integer\"\n                  },\n                  \"investors\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"name\": {\n                          \"type\": \"string\"\n                        }\n                      }\n                    }\n                  },\n                  \"type\": {\n                    \"type\": \"string\"\n                  }\n                }\n              }\n            },\n            \"acquisitionEvent\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"acquiredOn\": {\n                    \"type\": \"string\"\n                  },\n                  \"acquisitionType\": {\n                    \"type\": \"string\"\n                  },\n                  \"acquirer\": {\n                    \"type\": \"string\"\n                  },\n                  \"acquiree\": {\n                    \"type\": \"string\"\n                  },\n                  \"type\": {\n                    \"type\": \"string\"\n                  }\n                }\n              }\n            },\n            \"headcount\": {\n              \"type\": \"integer\"\n            },\n            \"sizeTo\": {\n              \"type\": \"integer\"\n            },\n            \"sizeFrom\": {\n              \"type\": \"integer\"\n            },\n            \"location\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"addressType\": {\n                      \"type\": \"string\"\n                    },\n                    \"country\": {\n                      \"type\": \"string\"\n                    },\n                    \"state\": {\n                      \"type\": \"string\"\n                    },\n                    \"city\": {\n                      \"type\": \"string\"\n                    },\n                    \"zip\": {\n                      \"type\": \"string\"\n                    },\n                    \"street\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              ]\n            },\n            \"technologies\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"type\": {\n              \"type\": \"string\"\n            },\n            \"domain\": {\n              \"type\": \"string\"\n            },\n            \"industry\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"revenue\": {\n              \"type\": \"long\"\n            },\n            \"linkedinUrl\": {\n              \"type\": \"string\"\n            },\n            \"website\": {\n              \"type\": \"string\"\n            },\n            \"founded\": {\n              \"type\": \"integer\"\n            },\n            \"lastConfirmed\": {\n              \"type\": \"long\"\n            },\n            \"naics\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"sic\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"isic\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"shortDescription\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            }\n          }\n        }\n      ]\n    }\n  }\n}\n\n ```\n\n---\n\n# Rate Limiting\n\nAll API requests are subject to rate limits that exist independently of your API key's monthly usage allowance. The maximum rate limit is **1,000 requests per minute**.\n\nNumber of previews available - Number of credits available, multiplied by 10.\n\n## HTTP Headers and Response Codes\n\nUse the HTTP headers in order to understand where the application is at for a given rate limit, on the method that was just utilized.\n\n### **x-rate-total-limit**\n\nThe rate limit ceiling for all endpoints for the 1 minute window.\n\n### **x-rate-total-limit-remaining**\n\nThe number of requests left remaining for the 1 minute window.\n\n### **x-rate-limit-reset**\n\nNumber of seconds before rate limits are reset.\n\n### **x-rate-limit-user**\n\nUser name.\n\n### **x-rate-endpoint-limit**\n\nThe rate limit ceiling for single endpoints for the 1 minute window.\n\n### **x-rate-endpoint-limit-remaining**\n\nThe number of requests left remaining for single endpoints for the 1 minute window.\n\n### **x-rate-result-limit**\n\nTotal number of preview profiles within API contract. Calculated as number of credits x 10.\n\n### **x-rate-result-limit-remaining**\n\nTotal number of remaining requests within API contract.\n\n### **x-rate-result-limit-reset**\n\nNumber of seconds before rate result limit is reset (until end of current contract).\n\n### **x-rate-result-limit**\n\nThe limit on preview profiles (contact or account). Limit is calculated as number of allocated credits x 10, e.g. 1 000 000 credits = 10 000 000 preview limit. Preview limit is decreased by the number of returned preview profiles on Search and Enrich endpoints. Usually single Search request decreases the preview limit by 20 (default index size) and Enrich by 1.\n\n**Redeem endpoint uses standard credits and does not decreases preview limit.**\n\n#### **HTTP 429 “Too Many Requests”**\n\nThis response code is returned when an application exceeds the rate limit for a given API endpoint, and the following error is returned in the response body:\n\n`{ \"errors\": [ { \"code\": 88, \"message\": \"Rate limit exceeded\" } ] }`.\n\n---\n\n# Matching strategies for Enrich endpoint\n\n### How Matching Works\n\nEach input parameter contributes to an overall match score, which represents the confidence level of a match.\n\nConstant fields such as firstName, lastName, and email have consistent scoring weight.\n\nDynamic fields such as jobTitle or accountName are weighted based on specificity and uniqueness:\n\n“Software Engineer” adds fewer points than “Senior Machine Learning Engineer” because it is more general.\n\n> **If no profile meets your minMatchScore threshold, the API returns no data.** \n  \n\n### Balancing Accuracy and Match Rate\n\nEvery enrichment result is scored. The default minMatchScore is 30, which provides a balanced level between accuracy and match rate.\n\nYou can adjust this value depending on your use case:\n\n| **Goal** | **Recommended minMatchScore** | **Description** |\n| --- | --- | --- |\n| High accuracy | 38-50 | Returns only high-confidence matches; fewer results but very reliable. |\n| Balanced mode (default) | 29-38 | Recommended for general use — good mix of accuracy and match rate. |\n| High match rate | 25-29 | Returns more results but may include lower-confidence or ambiguous matches. |\n\n> **It is not recommended to use minMatchScore above 45. Increase in accuracy is almost non existent above this threshold.** \n  \n\n### Example Requests\n\n#### Example 1 — High-Accuracy Lookup\n\n``` javascript\n{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"jobTitle\": \"Senior Product Designer\",\n  \"accountWebsite\": \"test.com\",\n  \"minMatchScore\": 45\n}\n\n ```\n\nBehavior:  \nTight score threshold (minMatchScore ≥ 45).  \nReturns a result only if contact data strongly matches all criteria, it will possibly miss on good match in case of data change.  \nBest for precise identity resolution and when input data is high quality\n\n#### Example 2 — Broader Matching\n\n``` javascript\n{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"jobTitle\": \"Software Engineer\",\n  \"accountName\": \"Acme Corp\",\n  \"minMatchScore\": 28\n}\n\n ```\n\nBehavior:  \nLooser threshold (minMatchScore ≥ 28).  \nMay return one of several potential contacts having same firstName and lastName with full or partial match on accountName or jobTitle. Suitable for wide data discovery or when inputs are uncertain.\n\n#### Example 3 — Using Unique Identifiers\n\n``` json\n{\n  \"email\": \"john.doe@test.com\"\n}\n\n ```\n\nBehavior:  \nDirect identifier match.  \nTypically scores between 40–49.  \nNot the best use case for Enrich endpoint\n\n> It is also recommended to use Search endpoint for cases like this. There is no benefit of scoring mechanism when input is single field, it will come down to **match** or **no match** \n  \n\n# Error response messages\n\nWith an unexpected response, usually, one of the below HTTP codes will be returned. Check the table for help with error messages and troubleshooting steps.\n\n| Error Code | Message | Troubleshooting |\n| --- | --- | --- |\n| 400 | Requested page number must be within allowed values | Check page query parameter. Make sure it is a number and within allowed range |\n| 400 | Requested page size must be within allowed values | Check pageSize query parameter. Make sure it is a number and within allowed range |\n| 400 | Request body invalid JSON | Make sure request contains valid JSON |\n| 400 | Search request not supported by subscribed entitlement | Check your Entitlement definition for allowed search fields. Contact Cognism for Entitlement expansion |\n| 400 | Unrecognized fields in the request | Make sure all fields in the request are supported, check for typos |\n| 401 | Unauthorised | Make sure API KEY is valid and included in the request. Check [Authentication](#authentication) for more details |\n| 402 | You've exceeded your credits limit. Please contact CSM | Not enough credits for the action |\n| 429 | Rate limit exceeded | Check [Rate limiting](#rate-limiting) for more details. |\n| 500 | Internal server error | The server encountered an unexpected condition which prevented it from fulfilling the request. Please contact support if this continues. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14862827","team":2497575,"collectionId":"58d2e00d-2fc0-4594-89e3-3c6d43bf293d","publishedId":"UVJhBu4C","public":true,"publicUrl":"https://developers.cognism.com","privateUrl":"https://go.postman.co/documentation/14862827-58d2e00d-2fc0-4594-89e3-3c6d43bf293d","customColor":{"top-bar":"FFFFFF","right-sidebar":"282850","highlight":"4e3cbb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"282850","highlight":"4e3cbb"}}]}},"version":"8.10.1","publishDate":"2023-10-25T12:27:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"08dcd644-af65-49c5-92fe-b784c057ffac","owner":"17507808","values":[{"key":"baseUrl","value":"https://app.cognism.com","enabled":true},{"key":"My-Api-Key","value":"<My-Api-Key>","enabled":true},{"key":"email","value":"test@test.com","enabled":false,"type":"default"},{"key":"id","value":"7351d07c-9118-403b-a7c1-d6510cc0c378","enabled":false,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/aa4c3ab795b147a7e84e8f366804bf8c6e430d96b750ad9071a519e147ecdeb4","favicon":"https://cognism.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"17507808-08dcd644-af65-49c5-92fe-b784c057ffac"}],"canonicalUrl":"https://developers.cognism.com/view/metadata/UVJhBu4C"}