Use the Redeem API to retrieve the complete contact or company profile after identifying a matching record using the Search API or Enrich API.
The Redeem API uses the Redeem ID returned by the Search or Enrich API to return all data included within your organisation's API Entitlements.
Before you begin
Before using the Redeem API, ensure that:
- You have authenticated your API requests using a valid API token.
- You have obtained a Redeem ID from either the Search API or Enrich API.
- Your organisation has sufficient Bulk Credits available for contact redemptions.
- The data you require is included within your API Entitlements.
When to use the Redeem API
Use the Redeem API when you want to:
- Retrieve the complete profile for a contact.
- Retrieve the complete profile for a company.
- Access data that is not included in the Search or Enrich preview.
- Enrich your CRM or internal systems with complete Cognism data.
The Redeem API should always be used after the Search API or Enrich API.
How the Redeem API works
The Search API and Enrich API return preview information together with a Redeem ID.
The Redeem API uses this Redeem ID to return the complete record.
Depending on your API Entitlements, the response may include:
Contact information
- Name
- Job title
- Email address
- Mobile phone numbers
- Direct dial numbers
- LinkedIn profile
- Seniority
- Management level
- Job functions
- Skills
- Education
- Previous employment
- Location
Company information
- Company name
- Website
- Domain
- Industry
- Revenue
- Company size
- Technologies
- Company type
- Locations
- Hiring information
- Phone numbers
Only fields included in your organisation's API Entitlements are returned.
Redeeming multiple records
The Redeem API supports redeeming multiple records in a single request.
You can redeem:
- 1 to 20 Redeem IDs per request.
If you need to process larger volumes, submit multiple requests while remaining within the applicable API rate limits.
Bulk Credits
Bulk Credits are consumed when redeeming contact records.
Bulk Credits are not consumed when:
- Redeeming company records.
- Redeeming a contact that has already been redeemed previously.
This allows you to access previously redeemed contacts again without consuming additional Bulk Credits.
API Entitlements
The Redeem API only returns data included within your organisation's configured API Entitlements.
If a field is not included in your entitlement, it will not be returned in the API response, even if Cognism holds that information.
If you require access to additional data fields, contact your Account Manager to discuss updating your API Entitlements.
Best practice
To optimise your API usage:
- Use the Search or Enrich API to identify the correct record before redeeming it.
- Redeem only the records you need.
- Avoid redeeming contacts unnecessarily, as each new contact redemption consumes Bulk Credits.
- Reuse previously redeemed contacts whenever possible.