General Introduction

Credits

4min

Overview
The API Key issued for you has a set amount of search and collect credits. Credits are deducted for one successful (200) request while using search or collect endpoints.
A successful request deducts a certain number of credits per request.
Two search or collection credits are deducted for one successful (200) request while using endpoints from:
Multi-source Company API
Multi-source Employee API
One search or collection credit is deducted for one successful (200) request while using endpoints from:
Clean Company API
Base Company API
Clean Employee API
Base Employee API
﻿Base Job Posting API﻿
Credits in Bulk Collect requests
For Bulk Collect requests, the number of credits deducted from your account depends on the data records you download. For instance, collecting 100 profiles will consume 100 credits.
Discuss your credit needs with your account manager or explore available plans in the self-service platform.
FAQ
Every search and collect response contains an x-credits-remaining header that shows the number of credits left in your account.
﻿
Example of remaining credits header:
JSON
x-credits-remaining: 9973
x-credits-remaining: 9973
﻿
﻿
If you don't have enough credits, the request in the /v1/bulk_collect/{data_request_id}/files endpoint will return the error 402 and the following response:
Insufficient credits
{
    "detail": "Insufficient credits"
}
{
    "detail": "Insufficient credits"
}
﻿
We validate your search and Elasticsearch POST requests in Bulk Collect to prevent the submission of duplicate requests. 

If you happen to submit duplicate POST requests using search or Elasticsearch filters, you will see the following error message:
409
{
    "detail": "Identical data request is already in progress."
}
{
    "detail": "Identical data request is already in progress."
}
﻿
﻿

Authorization

Response Codes

Credits

Overview

Credits in Bulk Collect requests

FAQ

Where can I see my credit balance?

What happens if I don't have enough credits?

What happens if I submit duplicate requests?