HomeAPI Documentation

API Documentation

API DOCUMENTATION

Table of Contents

Getting Started

General Introduction

CredCheck Pro API suite can be used as a single plug & play API for verification requirements of your employees.

This page will help you understand:

  1. How to set up your account.
  2. The range of CredCheck Pro API solutions.
  3. Authentication of your APIs.
  4. Some key terms related to each of the APIs.
  5. Documentation of each API

Setting Up Your Account

To run our APIs, you need an api-key and api-secret. If you don’t have these yet, please get in touch with us at admin@credcheck.pro for us to create an account for you.

Key Terms You Should Know

  1. Entry ID

    A unique identifier assigned to each task received from you. It is recommended to store this Entry ID for future reference.

  2. Form ID

    Identifiers that can be assigned to your tasks for easy recognition. These IDs are pre-configured, and it’s advisable not to alter them.

  3. Webhooks

    Webhooks are used to transmit API outputs to a specified endpoint on your server. Each webhook corresponds to a single task and triggers upon task completion, whether successful or with an error. To configure webhooks, contact us at dev@credcheck.pro.

  4. Subscription ID

    This ID can be found on the subscription tab of your account page, following the # symbol. Example: #1234. It is a mandatory field. It is generated post subscription of our plans.

  5. Company Name

    This name is pre-configured during the client onboarding process.

Authentication

  1. Basic Authentication

    Basic authentication involves sending a verified api_key as username and api_secret as password with your request but only on requests that are sent using HTTPS. HTTP requests. 

Modes of Operations:

There are 2 modes of operation – synchronous and asynchronous. Most tasks can be called using either APIs. Synchronous APIs return the response right away:

Asynchronous APIs return a “id” and use a webhook mechanism to return the response back to your servers.

You can then use this “id” and feed this into our GET API to consume the response.

Creating An Entry

  1. POST METHOD

 
SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/forms/{form_id}/entries/
HEADERS: 
Content-Type: application/json
BODY: 
{
    "form_id": {form_id},
    "1": "{your_input}"
}
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“success”:true,
“message”:”Payload processed successfully”,
“id”:{entry_id},
“api_requests_count”:{your_api_request_count}
}

  1. cURL METHOD

 
Sample Request SAMPLE REQUEST 
    curl --location --request POST 'https://credcheck.pro/wp-json/gf/v2/forms/{form_id}/entries/' \
    --user '{api_key}:{api_secret}' \
    --header 'Content-Type: application/json' \
    --data $'{
    "1": "{your_input}",
    "form_id": {form_id}
    }'
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{“success”:true,”message”:”Payload processed successfully”,”id”:{entry_id},”api_requests_count”:{your_api_request_count}

Getting An Entry

  1. GET METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
NONE
Note: This is a sample request. Remember to replace entry_id with the actual entry id and required inputs.
RESPONSE
Return field values of responses in JSON.

  1. cURL METHOD

 
SAMPLE REQUEST 
curl --location --request GET 'https://credcheck.pro/wp-json/gf/v2/entries/{field_id}' \
    --user '{api_key}:{api_secret}' \
    --header 'Content-Type: application/json'
Note: This is a sample request. Ensure that the user credentials and entry ID are correct.
Sample Response
RESPONSE
Return field values of responses in JSON.

Aadhaar Verification

  1. POST & GET METHOD

Aadhaar Verification is completed in four steps in asynchronous mode.

    1. POST REQUEST is sent to our server, OTP is triggered to the customer and entry id “id” is sent back in response.
    2. GET REQUEST is sent to our server and Ref_id is sent back in response.
    3. POST REQUEST is sent to our server, with Ref_id & OTP and entry id “id” is sent back in response. 
    4. GET REQUEST is sent to our server and verification data is sent back in response.

Step 1

  1. POST METHOD

SAMPLE REQUEST URL:
https://credcheck.pro/wp-json/gf/v2/forms/17/entries/
HEADERS: 
Content-Type: application/json
BODY: (raw) 
{
    "form_id": "17",
    "3": "{Aadhaar_number}"
}
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“success”:true,
“message”:”Payload processed successfully”,
“id”:{entry_id},
“api_requests_count”:{your_api_request_count}
}

Step 2

  1. GET METHOD

SAMPLE REQUEST URL:
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
None
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“3”: “{Aadhaar_number}”,
“6”: “SUCCESS”,
“7”: “{ref_id}”,
“8”: “OTP sent successfully”
}
Note: We recommend to store {ref_id}.

Step 3

  1. POST METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/forms/19/entries/
HEADERS: 
Content-Type: application/json
BODY: (raw) 
{
    "form_id": "19",
    "1": "{OTP}",
    "3": "{ref_id}"
}
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“success”:true,
“message”:”Payload processed successfully”,
“id”:{entry_id},
“api_requests_count”:{your_api_request_count}
}

Step 4

  1. GET METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
None
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“1”: “{otp}”,
“3”: “{ref_id}”,
“6”: “{status}”,
“5”: “{ref_id}”,
“4”: “{message}”,
“10”: “{C/O}”,
“11”: “{base64-encoded_image}”,
“12”: “{dob}”,
“7”: “{address}”,
“8”: “{name}”,
“9”: “{gender}”
}

PAN Verification

  1. POST & GET METHOD

PAN Verification is completed in two steps in asynchronous mode.

    1. POST REQUEST is sent to our server and entry id “id” is sent back in response. 
    2. GET REQUEST is sent to our server and verification data is sent back in response.

Step 1

  1. POST METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/forms/2/entries/
HEADERS: 
Content-Type: application/json
BODY: (raw) 
{
    "form_id": "2",
    "1": "{pan_number}"
}
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“success”:true,
“message”:”Payload processed successfully”,
“id”:{entry_id},
“api_requests_count”:{your_api_request_count}
}

Step 2

  1. GET METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
None
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“1”: “{pan_no}”,
“3”: “{pan_checked}”,
“5”: “{pan_type}”,
“6”: “{name}”,
“8”: “{message}”
}

Bank Account Number Verification

  1. POST & GET METHOD

BAN Verification is completed in two steps in asynchronous mode.

    1. POST REQUEST is sent to our server and entry id “id” is sent back in response. 
    2. GET REQUEST is sent to our server and verification data is sent back in response.

Step 1

  1. POST METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/forms/16/entries/
HEADERS: 
Content-Type: application/json
BODY: (raw) 
{
    "form_id": "16",
    "11": "{bank_account_no}",
    "12": "{ifs_code}"
}
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“success”:true,
“message”:”Payload processed successfully”,
“id”:{entry_id},
“api_requests_count”:{your_api_request_count}
}

Step 2

  1. GET METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
None
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
RESPONSE
{
“11”: “{bank_account_no}”,
“12”: “{ifsc_code}”,
“4”: “{token}”,
“5”: “{status}”,
“1”: “{status_code}”,
“3”: “{message}”,
“7”: “{name}”,
“6”: “{bank_name}”,
“9”: “{bank_branch}”,
“8”: “{bank_city}”
}

CredCheck Verification Suite (Starter)

  1. POST & GET METHOD

CredCheck Verification is completed in two steps in asynchronous mode.

    1. POST REQUEST is sent to our server with subscription id mandatory and entry id “id” is sent back in response. 
    2. GET REQUEST is sent to our server and verification data is sent back in response. You can also mail at admin@credcheck.pro to get web hook configured to your server.

Step 1

  1. POST METHOD

SAMPLE REQUEST URL: 
    https://credcheck.pro/wp-json/gf/v2/forms/25/entries/
HEADERS: 
    Content-Type: application/json
BODY: (raw) 
    {
        "form_id": "25",  
        "1": "{candidate_name}",  
        "77": "{email}",  
        "3": "{phone}",  
        "64": "{subscription_id}"  
    }
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.
 
RESPONSE
{
“success”: true,
“message”: “Payload processed successfully”,
“id”: {entry_id},
“api_requests_count”: {your_api_request_count}
}

Step 2

  1. GET METHOD

SAMPLE REQUEST URL: 
https://credcheck.pro/wp-json/gf/v2/entries/{entry_id}
HEADERS: 
Content-Type: application/json
BODY: 
None
Note: This is a sample request. Remember to replace form_id with the actual form and required inputs.

Our new API Documentation for the Growth & Enterprise Plan is now available on Request! Need help understanding our APIs? Reach out to our support team at dev@credcheck.pro for a copy and assistance.

© 2024 CredCheck Pro. All Rights Reserved.

Contact Us