Public
Documentation Settings
Production
Double Column
cURL - cURL
CREDCHECK.PRO - APIs
Introduction
GET
Fetch Candidate Report
POST
Add Candidate

CREDCHECK.PRO - APIs

Welcome to the CredCheck.Pro API Documentation. The endpoints outlined here allow you to initiate background verification for candidates and retrieve their verification reports.

The CredCheck.Pro API is built around REST principles. It features predictable resource-oriented URLs, accepts JSON-formatted request bodies, returns JSON responses, and adheres to standard HTTP authentication, response codes, and methods.

Getting started guide

Pre-requisites

  • The user must be registered with CredCheck.Pro. If you are not registered, please contact sales@credcheck.pro. or purchase a plan from https://credcheck.pro/#pricing

  • The user should have generated an API KEY from the CredCheck.Pro dashboard. Steps to create the API token from the dashboard are provided below.

  • The API has rate and usage limits.

  • The API only responds to HTTP communications. Any requests sent via HTTPS return an Error 500.

  • The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

Steps to Generate API Key :

  • Sign in to CredCheck.Pro.

  • From the "My Account" button in the top-right corner, go to CredCheck.Pro/Dashboard.

  • Navigate to the Account tab.

  • Under the Developer Information tab, click on the Generate API Key.

  • Copy the generated API Key and Client ID and use it to call the APIs listed below.

Authentication

CredCheck.Pro uses API key & Client ID for authentication. You can generate a CredCheck.Pro API key as described above. Client ID is auto generated and unique to each individual account.

You must include an API key & Client ID in each request to the CredCheck.Pro with the "apikey" header for API Key and "clientid" header for Client ID.

Authentication error response

If an API key or Client ID is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 15 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

HeaderDescription
X-RateLimit-LimitThe maximum number of requests that the consumer is permitted to make per minute.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, on mail at support@credcheck.pro

Need some help?

In case you have questions, you can contact us at dev@credcheck.pro. Remember to include your client id in email.

AUTHORIZATIONAPI Key
Key

X-API-Key

Value
Loading