Bridge Platform Developers API


Introduction

API - Version 1.7 | 24th May 2019

AuthBridge Platform provides set of APIs using which external applications can interact with AuthBridge Platform. The purpose of this page is to provide details of these APIs and their sample usage.
Integrating with AuthBridge Platform is a 2 step procedure:
Step 1 - Perform integration procedure utilizing given test credentials with AuthBridge test APIs
Step 2 - On successful completion of Step 1, perform integration procedure utilizing given live credentials with AuthBridge production APIs.

APIs

1. Initiate or add a Case

This Api is used to initiate verification request for a candidate into AuthBridge Platform.
Following points need to be noted:
  • Location ID and Process ID to be selected separately for each candidate.
  • Multiple checks can be raised in the same request for a single candidate. Different check fields to be selected for their corresponding checks.
  • The response of the instantaneous checks sent in the request are shared in a synchronous way.

Request Format:

Request TypePOST
API EnvironmentURL
Test https://authbridge.info/client_api_demo/AuthApi/post_data
Production https://authbridge.info/rest/api/v1/case

Header Parameters:

ParamValueExample
username (Provided username) admin
timestamp yyyymmddhhmmss 20161109132401
nonsense Any string DFGESFRV
signature
Signature Generation Process:
PHP code to generate the signature:
  1. Concatenate given password timestamp and a nonsense characters
  2. Encrypt the generated string with hash sha512 encoding
PHP code to generate the signature:
<?php
$hashData 
$password '|' $timeStamp '|' $nonSense;
$secureHash strtoupper(hash('sha512'$hashData));
?>

Body Parameters:

ParamM/OComments
uniqueID M This is the unique id (Transaction id) that has been provided by the client for that transaction
firstName M First name of the candidate
middleName O Middle name of the candidate
lastName M Last name of the candidate
fatherName M Father’s name of the candidate
contactNumber M Contact number of the candidate
DOB M Date of Birth of the candidate
locationID M This is the location id for which the candidate’s case belong. Please refer Annexure 1* for its value
processID M This is process id under which the case needs to be initiated. Please refer Annexure 2* for its value
checks M This contains the array of checks that need to be raised for a candidate. It must contain at least one array.
checks :checkUID M This is a subset of “checks”. Check specific unique id for each check to be provided by the client
checks : type M This is the unique value provided by AuthBridge for that type of check. Please refer Annexure 3
checks : sourceVerification M This is the source from where the check has been raised. It will be a string value.
Note:
It can be city name for address check, institute name for education check, company name for employment check or reference details(name, number) for reference.
checks : sourceAddress M This is the source address from where the check has been raised. It will be a string value.
Note:
It can be address for address check, institute address for education check, company address for employment check
checks : checkFields M This is the list of fields which needs to be sent for that particular check type. Please refer Annexure 3
checks : files O This parameter to be sent if any image/file is being shared. It further has two subsets-fileContent & fileType
checks : files: fileType O 1 - URL 2 - BINARY ENCODED
checks : files: fileContent O Value= URL OR BYTECODE
checks : files: documentType O This is the list of documents which needs to be sent for that particular check file. Please refer Annexure 4

Sample Request:

The sample request given below indicates 3 checks in a single request
URL: https://authbridge.info/client_api_demo/AuthApi/post_data

Post Headers:

                                        
signature:  5DA87BC78F02091F8DC79C85D0C9448EF4B94E0324B871A1F9C18F
            D09D3767D578145F241E1931CA233539F468691343E9E04B5B6C0F5AD592
            840FC99959ABEF

nonsense:   TY78H5UI

timestamp:  20160624130625

username:   demo
                                    

Post Body:

                                        
{
    "uniqueID": "8426",
    "firstName": "ABHIXXXX",
    "middleName": "",
    "lastName": "AGAXXX",
    "fatherName": "AJAXXX AGAXXX",
    "contactNumber": "9999999999",
    "DOB": "1987-01-01",
    "locationID": "192840",
    "processID": "2500",
    "flex_fields": {
        "1": "Test Use",
        "2": "User Name"
    },
    "arn": [
        {
            "fileContent": "https://www.google.com/images/googlelogo_color_120x44dp.png",
            "fileType": "1",
            "documentType": "27"
        },
        {
            "fileContent": "BINARY ENCODED",
            "fileType": "2",
            "documentType": "26"
        }
    ],
    "checks": [{
            "checkUID": 1,
            "type": 45,
            "sourceVerification": "Pan Verification",
            "sourceAddress": "",
            "checkFields": {
                "215": "BDYPA64XXX",
                "1438": "BDYPA64XXX",
                "1580": "ABHIXXXX AGAXXX",
                "1581": "09/06/1992"
            },
            "files": [{
                    "fileContent": "URL",
                    "fileType": "1",
                    "documentType": "Valid Doc Type"
                },
                {
                    "fileContent": "BYTECODE",
                    "fileType": "2",
                    "documentType": "Valid Doc Type"
                }]
        },
        {
            "checkUID": 2,
            "type": 72,
            "sourceVerification": "Aadhar Verifications",
            "sourceAddress": "",
            "checkFields": {
                "935": "44332100XXXX",
                "1434": "2",
                "1480": "",
                "1483": "",
                "2792": "ABHIXXXX AGAXXX",
                "2851": "",
                "2852": "",
                "2853": "",
                "2854": "",
                "2855": "",
                "2856": "",
                "2857": ""
            }
        },
        {
            "checkUID": 3,
            "type": 72,
            "sourceVerification": "Voter Verifications",
            "sourceAddress": "",
            "checkFields": {
                "935": "SNE/0453XXX",
                "1434": "5",
                "1480": "",
                "1483": "",
                "2792": "ABHIXXXX AGAXXX",
                "2851": "",
                "2852": "",
                "2853": "",
                "2854": "",
                "2855": "",
                "2856": "",
                "2857": ""
            }
        }
    ]
}
                                    

Response:

StatusResponse
200
                                                        
{
    "status": "success",
    "code": "200",
    "uniqueId": "8426",
    "requestId": "266",
    "msg": "Data Uploaded Successfully",
    "instantResponse":
            {
                "status": "success",
                "code": "200",
                "response":
                        {
                            "checks":
                                    [
                                        {
                                            "checkUID": "1",
                                            "severity": "Clear",
                                            "disposition": "Exact match found",
                                            "status": "Completed",
                                            "comments": "Exact match found"
                                        },
                                        {
                                            "checkUID": "2",
                                            "severity": "Clear",
                                            "disposition": "Exact match found",
                                            "status": "Completed",
                                            "comments": "Exact match found"
                                        },
                                        {
                                            "checkUID": "3",
                                            "severity": "Discrepant",
                                            "disposition": "No match found",
                                            "status": "Completed",
                                            "Comments": "No match found. Name as per 
                                                         Voter Id - : LAKHAN"
                                        }
                                    ]
                        }
            }
}                                                    
Note- For other status codes please refer the Error codes-Annexure 6

2. Fetch or Get Verification Response

This Api is used to fetch the verification response for a candidate from AuthBridge Platform.

Request Format:

Request TypeGET
API EnvironmentURL
Test https://authbridge.info/client_api_demo/AuthApi/get_details/<request ID>
Production https://authbridge.info/rest/api/v1/case/<request ID>

Header Parameters:

ParamValueExample
username (Provided username) admin
timestamp yyyymmddhhmmss 20161109132401
nonsense Any string DFGESFRV
signature
Signature Generation Process:
PHP code to generate the signature:
  1. Concatenate given password timestamp and a nonsense characters
  2. Encrypt the generated string with hash sha512 encoding
PHP code to generate the signature:
<?php
$hashData 
$password '|' $timeStamp '|' $nonSense;
$secureHash strtoupper(hash('sha512'$hashData));
?>

Response:

ParamValues
status Provides the final status of the case
code It provides the error/ success code. Please refer the list of Error Codes (Annexure 6)
response This has a list of check wise responses
response: uniqueID The uniqueID for which the response was requested
response: requestId The transaction id returned by AuthBridge at the time of request
response: caseStatus Status for that Case
response: caseSeverity The severity given to this Case after verification. Please refer the list of severities (Annexure 5)
checks This has details of checkwise response
checks: checkUID Check specific unique id for each check provided by the client
checks: status Status for that check
checks: severity The severity given to this check after verification. Please refer the list of severities (Annexure 5)
checks: disposition The disposition given to this check after verification
checks: comments Comments for that check ( If any)

Sample Request:

URL: https://authbridge.info/client_api_demo/AuthApi/get_details/129

Post Headers:

                                        
signature:  5DA87BC78F02091F8DC79C85D0C9448EF4B94E0324B871A1F9C18F
            D09D3767D578145F241E1931CA233539F468691343E9E04B5B6C0F5AD592
            840FC99959ABEF

nonsense:   TY78H5UI

timestamp:  20160624130625

username:   demo
                                    

Response Body:

                                        
{
    "status": "success",
    "code": "200",
    "response":
            {
                "uniqueID": "123453456789125",
                "requestId": "129",
                "caseStatus": "Completed",
                "caseSeverity": "Clear",
                "checks":
                        [
                            {
                                "checkUID": "2",
                                "severity": "Clear",
                                "disposition": "Exact match found",
                                "status": "Completed",
                                "comments": "Exact match found"
                            }
                        ]
            }
}                                    
                                        
{
    "status": "success",
    "code": "200",
    "response": {
        "uniqueID": "123456789130",
        "requestId": "88",
        "caseStatus": "Work In Progress",
        "caseSeverity": "Clear",
        "checks": [{
                "checkUID": "1",
                "type": "45",
                "severity": "",
                "disposition": "",
                "status": "",
                "comments": "Work in progress."
            }, {
                "checkUID": "2",
                "type": "72",
                "severity": "",
                "disposition": "",
                "status": "",
                "comments": "Work in progress."
            }]
    }
}                                    
                                        
{
    "status": "success",
    "code": "200",
    "response": {
        "uniqueID": "123456789130",
        "requestId": "88",
        "caseStatus": "Insufficient",
        "caseSeverity": "Clear",
        "checks": [{
                "checkUID": "1",
                "type": "45",
                "severity": "",
                "disposition": "",
                "status": "Insufficient",
                "comments": "Check Insufficiency"
            }, {
                "checkUID": "2",
                "type": "72",
                "severity": "",
                "disposition": "",
                "status": "WorkInProgress",
                "comments": "Work in progress"
            }, {
                "checkUID": "3",
                "type": "72",
                "severity": "",
                "disposition": "",
                "status": "Completed",
                "comments": "Completed"
            }]
    }
}                                    

3. Get Reports

This method is used to fetch the reports for an existing case from AuthBridge Platform.

Request Format:

Request TypeGET
API EnvironmentURL
Test https://authbridge.info/client_api_demo/AuthApi/get_reports/<request-id>
Production https://authbridge.info/rest/api/v1/report/<request-id>

Header Parameters:

ParamValueExample
username (Provided username) admin
timestamp yyyymmddhhmmss 20161109132401
nonsense Any string DFGESFRV
signature
Signature Generation Process:
PHP code to generate the signature:
  1. Concatenate given password timestamp and a nonsense characters
  2. Encrypt the generated string with hash sha512 encoding
PHP code to generate the signature:
<?php
$hashData 
$password '|' $timeStamp '|' $nonSense;
$secureHash strtoupper(hash('sha512'$hashData));
?>

Sample Request:

URL:https://authbridge.info/client_api_demo/AuthApi/get_reports/111

Post Headers:

                                        
signature:  5DA87BC78F02091F8DC79C85D0C9448EF4B94E0324B871A1F9C18F
            D09D3767D578145F241E1931CA233539F468691343E9E04B5B6C0F5AD592
            840FC99959ABEF

nonsense:   TY78H5UI

timestamp:  20160624130625

username:   demo
                                    

Response:

StatusResponse
200 (Report found)
Report Type-
Final Stands for the final report of the candidate
Report Type-
Additional stands in case any changes have been made to the final report (Both have been the sample response)
                                                        
{
    "status": "success",
    "code": "200",
    "response":
        {
            "uniqueID": "13343456789125",
            "requestId": "1",
            "reports":[
                {
                    "reportType": "Intrim",
                    "reportDate": "19-08-26 14:08:37",
                    "reportSeverity": "clear",
                    "byteCode":"VBORw0KGgoAAAANSUhEUgAAABAAAA
                        AQCAYAAAAf8/9hAAADJ0lEQVR42nXSa0iTURgH8P95
                        33du07m9XpqZ6aLUUltpSiB0+RAYRUEfumkRQUWkQR
                        +CEPtSSVmBRWESRReILoQfCsouakYFXSCabY7UKc61n
                        GXT3S/tfU9nswtBnm/n8vzOeZ7zEEwzkva/1R/dnm9x
                        eKO0tSo7a1Ztt3FOOlljH/M5nZfX3/x9jvwvWFVvMjR
                        vNpgyC0RxJAK0PbAPzXS6/PcaZi86c8OKgzuqyLRA2lF
                        r3vEN2VZlnpjS/6oHKsgw55ahMOhFUyVw5sbb6YGs0z
                        yptypjZgorhpxCzZkEmFKlyBK10KZ74M1AjDMu32kYWo
                        2Oz5Q9Qct2Vu6dU/fFjLFWMDJixlbMiIHNwOEcRkyRUl
                        i+GTq1ArUWH1y49hOCoW9HTWxp6vMNBajomTi5I5+veT
                        Qga/ksf9qn7kZ0/HyZLHwYHBhgQw7IVKzAvVw+1FMIui
                        xYdjlSQMYef/+K6QLZ3uT9/8iInZ8KOA3o7ZuQYEKU8e
                        J4DpRTgCDQpyQiHIkjmKTRKYFePEg/MEuCddCZSKL45T
                        tuK7SCCAhEiQKkQ0GvuRfRHFBwDBLa+ZEkZm8egVfJQc
                        hIydn8I4smmlASQf+0rfVTphswulMFBJ+pQt68OZrMJh
                        PAwGstw5epFeDweKBiuYKi+5rkb3TUZU8D1r7RzuQ+U
                        BcuEg5imRdOJUxi0DYAXeOQXFOJwQz28Xh+ShHh6BOk
                        bu8bRvXVGAph3dYy+rIqwnBnA/l2n1aG5+SwGh4bg9U
                        yiuNiIxsYj7AWTUAgCQ1ld1j8cx7Pqv8CbdfFPJYk04s
                        C5863ot9kQCgZQUlKEhvpD8Pn8EBQc1Co1yMrb43ixbQ
                        oovOaifZtUia6gcSdZi0stLYlC8pyARaVG7Ny7l+1Iv1
                        qHY8Ctf4HOLWmQY5TVgIBTJ6H7fjtstmFIVEZB4VyUV6
                        1FMCSDsogwu2VV9d3v6KzOTAC738eXAE9UCkQCMRpmkJ
                        oXEP5B4A9LGj/rgaFvPvgCUSAiJV7AxjccK9L/BBJjUt
                        jf1ysbAAAAAElFTkSuQmCC"
                },
				{
                    "reportType": "Final",
                    "reportDate": "19-08-26 14:08:37",
                    "reportSeverity": "clear",
                    "byteCode":"VBORw0KGgoAAAANSUhEUgAAABAAAA
                        AQCAYAAAAf8/9hAAADJ0lEQVR42nXSa0iTURgH8P95
                        33du07m9XpqZ6aLUUltpSiB0+RAYRUEfumkRQUWkQR
                        +CEPtSSVmBRWESRReILoQfCsouakYFXSCabY7UKc61n
                        GXT3S/tfU9nswtBnm/n8vzOeZ7zEEwzkva/1R/dnm9x
                        eKO0tSo7a1Ztt3FOOlljH/M5nZfX3/x9jvwvWFVvMjR
                        vNpgyC0RxJAK0PbAPzXS6/PcaZi86c8OKgzuqyLRA2lF
                        r3vEN2VZlnpjS/6oHKsgw55ahMOhFUyVw5sbb6YGs0z
                        yptypjZgorhpxCzZkEmFKlyBK10KZ74M1AjDMu32kYWo
                        2Oz5Q9Qct2Vu6dU/fFjLFWMDJixlbMiIHNwOEcRkyRUl
                        i+GTq1ArUWH1y49hOCoW9HTWxp6vMNBajomTi5I5+veT
                        Qga/ksf9qn7kZ0/HyZLHwYHBhgQw7IVKzAvVw+1FMIui
                        xYdjlSQMYef/+K6QLZ3uT9/8iInZ8KOA3o7ZuQYEKU8e
                        J4DpRTgCDQpyQiHIkjmKTRKYFePEg/MEuCddCZSKL45T
                        tuK7SCCAhEiQKkQ0GvuRfRHFBwDBLa+ZEkZm8egVfJQc
                        hIydn8I4smmlASQf+0rfVTphswulMFBJ+pQt68OZrMJh
                        PAwGstw5epFeDweKBiuYKi+5rkb3TUZU8D1r7RzuQ+U
                        BcuEg5imRdOJUxi0DYAXeOQXFOJwQz28Xh+ShHh6BOk
                        bu8bRvXVGAph3dYy+rIqwnBnA/l2n1aG5+SwGh4bg9U
                        yiuNiIxsYj7AWTUAgCQ1ld1j8cx7Pqv8CbdfFPJYk04s
                        C5863ot9kQCgZQUlKEhvpD8Pn8EBQc1Co1yMrb43ixbQ
                        oovOaifZtUia6gcSdZi0stLYlC8pyARaVG7Ny7l+1Iv1
                        qHY8Ctf4HOLWmQY5TVgIBTJ6H7fjtstmFIVEZB4VyUV6
                        1FMCSDsogwu2VV9d3v6KzOTAC738eXAE9UCkQCMRpmkJ
                        oXEP5B4A9LGj/rgaFvPvgCUSAiJV7AxjccK9L/BBJjUt
                        jf1ysbAAAAAElFTkSuQmCC"
                },
                {
                    "reportType": "Additional",
					"reportDate": "19-08-26 14:08:37",
                    "reportSeverity": "clear",
                    "byteCode":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9h
                        AAADJ0lEQVR42nXSa0iTURgH8P9533du07m9XpqZ6aLUU
                        ltpSiB0+RAYRUEfumkRQUWkQR+CEPtSSVmBRWESRReILo
                        QfCsouakYFXSCabY7UKc61nGXT3S/tfU9nswtBnm/n8vz
                        OeZ7zEEwzkva/1R/dnm9xeKO0tSo7a1Ztt3FOOlljH/M5
                        nZfX3/x9jvwvWFVvMjRvNpgyC0RxJAK0PbAPzXS6/PcaZ
                        i86c8OKgzuqyLRA2lFr3vEN2VZlnpjS/6oHKsgw55ahMO
                        hFUyVw5sbb6YGs0zbDkdWZJr9eJ9rf9aJi9CUEDujQLIV
                        JuxB3ytxo7zL/HzC02PMOLhetoyptypjZgorhpxCzZkEm
                        FKlyBK10KZ74M1AjDMu32kYWo2Oz5Q9Qct2Vu6dU/fFjL
                        FWMDJixlbMiIHNwOEcRkyRUli+GTq1ArUWH1y49hOCoW9
                        HTWxp6vMNBajomTi5I5+veTQga/ksf9qn7kZ0/HyZLHwY
                        HBhgQw7IVKzAvVw+1FMIuixYdjlSQMYef/+K6QLZ3uT9/
                        8iInZ8KOA3o7ZuQYEKU8eJ4DpRTgCDQpyQiHIkjmKTRKY
                        FePEg/MEuCddCZSKL45TtuK7SCCAhEiQKkQ0GvuRfRHFB
                        wDBLa+ZEkZm8egVfJQchIydn8I4smmlASQf+0rfVTphsw
                        ulMFBJ+pQt68OZrMJhPAwGstw5epFeDweKBiuYKi+5rkb
                        3TUZU8D1r7RzuQ+UBcuEg5imRdOJUxi0DYAXeOQXFOJwQz
                        28Xh+ShHh6BOkbu8bRvXVGAph3dYy+rIqwnBnA/l2n1aG5
                        +SwGh4bg9UyiuNiIxsYj7AWTUAgCQ1ld1j8cx7Pqv8Cbdf
                        FPJYk04sC5863ot9kQCgZQUlKEhvpD8Pn8EBQc1Co1yMr
                        b43ixbQoovOaifZtUia6gcSdZi0stLYlC8pyARaVG7Ny7
                        l+1Iv1qHY8Ctf4HOLWmQY5TVgIBTJ6H7fjtstmFIVEZB4
                        VyUV61FMCSDsogwu2VV9d3v6KzOTAC738eXAE9UCkQCMR
                        pmkJoXEP5B4A9LGj/rgaFvPvgCUSAiJV7AxjccK9L/BBJj
                        Utjf1ysbAAAAAElFTkSuQmCC"
                }
                ]
        }
}                                                    
200 (Report not found)
                                                        
{
    "status": "success",
    "code": "200",
    "msg": "No Report Found"
}                                                    
Note- For other status codes please refer Annexure 6

4. Upload Insufficiency

This Api is used to upload insufficiency for a candidate into AuthBridge Platform.

Request Format:

Request TypePOST
API EnvironmentURL
Test https://authbridge.info/client_api_demo/AuthApi/uploadInsuff
Production https://authbridge.info/rest/api/v1/insuff

Header Parameters:

ParamValueExample
username (Provided username) admin
timestamp yyyymmddhhmmss 20161109132401
nonsense Any string DFGESFRV
signature
Signature Generation Process:
PHP code to generate the signature:
  1. Concatenate given password timestamp and a nonsense characters
  2. Encrypt the generated string with hash sha512 encoding
PHP code to generate the signature:
<?php
$hashData 
$password '|' $timeStamp '|' $nonSense;
$secureHash strtoupper(hash('sha512'$hashData));
?>

Body Parameters:

ParamM/OComments
requestID M The transaction id returned by AuthBridge at the time of request
checkUID O This is Check specific unique id for each check was provided by the client while case initiation
comments M Insufficiency fulfill remarks
docs 0 This parameter to be sent if any image/file is being shared. It further has two subsets-fileContent & fileType
docs: fileType M 1 - URL 2 - BINARY ENCODED
docs: fileContent M Value= URL OR BYTECODE
docs: documentType M This is the list of documents which needs to be sent for that particular check file. Please refer Annexure 4

Sample Request:

URL: https://authbridge.info/client_api_demo/AuthApi/uploadInsuff

Post Headers:

                                        
signature:  5DA87BC78F02091F8DC79C85D0C9448EF4B94E0324B871A1F9C18F
            D09D3767D578145F241E1931CA233539F468691343E9E04B5B6C0F5AD592
            840FC99959ABEF

nonsense:   TY78H5UI

timestamp:  20160624130625

username:   demo
                                    

Post Body:

                                        {
    "requestID": "8426",
    "comments": "Insufficiency fulfill remarks",    
    "checkUID": "1",    
    "docs": [
        {
            "fileContent": "https://www.google.com/images/googlelogo_color_120x44dp.png",
            "fileType": "1",
            "documentType": "27"
        },
        {
            "fileContent": "BINARY ENCODED",
            "fileType": "2",
            "documentType": "26"
        }
    ]
}
                                    

Response:

StatusResponse
200
                                                        
{
    "status": "success",
    "code": "200",
    "msg": "Insuff documents uploaded successfully."
}                                                    
Note- For other status codes please refer the Error codes-Annexure 6

Example Sample Structure

Choose the relevant check(s) and click "Generate Sample POST Body" below to generate sample post body structure(JSON format). A user can fill the relevant values in the generated structure and the same can be used for developing the API.
Choose check field(s):
Permanent Address Verification [1]
Current Address Verification [57]
Address Verification [60]
Postal Address Verification [234]
Passport Verification [44]
PAN No Verification [45]
India Criminal Litigation Database Check [50]
India Reputational Risk Database Check [53]
India Advanced Web and Media Searches [54]
Global Database Check [55]
India Credit Default Database Check [63]
India Crime Watch List Database Check [67]
National Identity Check [72]
India Civil Litigation Database Check [78]
India Court Record Check through Law Firm [90]
India Court Record Database Check [132]
Global Regulatory Compliance and Debarment Database Verification [133]
Voter ID Verification [142]
SAM [164]
GSA [165]
OIG Database Check [166]
National Sex Offender Search [171]
India Court Record DB Check [179]
Travel Insurance policy Verification [203]
Education Verification [25]
Education Verification W [83]
Education Institution Validation [141]
Education Verification Written [144]
Professional Reference Check [34]
Personal Reference Check [38]
Previous Employment Verification [41]
Current Employment Verification [58]
Company Check [71]
Immediate previous employment [163]
Police Verification Verbal [46]
India Police Record Verification [61]
India Police Record Verification through Law Firm [84]
CIN Verification [152]
DIN Verification [153]
TIN or VAT Verification [154]
Service Tax Verification [155]
TAN Verification [156]
CST [172]
Excise and Service Tax [173]
Document Verification [119]
Driving License Verification [101]
Pre Employment Verification [207]
Bank Statement Verification [208]


Created Api's Json format will be displayed below:
                                                
{
    "uniqueID": "8426",
    "firstName": "ABHIXXXX",
    "middleName": "",
    "lastName": "AGAXXX",
    "fatherName": "AJAXXX AGXXX",
    "contactNumber": "9999999999",
    "DOB": "1987-01-01",
    "locationID": "192840",
    "processID": "2500",
    "flex_fields": {
        "1": "Test Use",
        "2": "User Name"
    },
    "arn": [
        {
            "fileContent": "URL OR BYTECODE",
            "fileType": "1 => URL , 2 => BINARY ENCODED",
            "documentType": "OPTIONAL key,Defualt is 26(ARN) otherwise 27(Others)"
        },
        {
            "fileContent": "URL OR BYTECODE",
            "fileType": "1 => URL , 2 => BINARY ENCODED",
            "documentType": "OPTIONAL key,Defualt is 26(ARN) otherwise 27(Others)"
        }],
    "checks": [
        {
            "checkUID": 1,
            "type": 45,
            "sourceVerification": "Pan Verification",
            "sourceAddress": "",
            "checkFields": {
                "215": "BDYPA64XXX",
                "1438": "BDYPA64XXX",
                "1580": "Lakhan Agarwal",
                "1581": "09/06/1992"
            },
            "files": [{
                    "fileContent": "URL OR BYTECODE",
                    "fileType": "1 => URL , 2 => BINARY ENCODED",
                    "documentType": "Valid Doc Type"
                }]
        }
    ]
}
                                            

Example Sample Code

Download PHP Example Code that helps how to integrate the API.
Technology Code Link
PHP Downlod PHP Example Code

Annexures

Annexure 1*- Location List

LOCATION_IDLOCATION
192840 Gurgaon
*- Please use this location id for testing purpose. A separate list will be shared with you later as per your actual locations.

Annexure 2*- Process List

PROCESS_IDPROCESS_NAME
885 Tset
*- Please use this process id for testing purpose. A separate list will be shared with you later as per your actual processes.

Annexure 3- Check Fields

CHECK_IDCHECK_NAMEFIELD_IDFIELD_NAME
1 Permanent Address Verification 153 Pin Code
1 Permanent Address Verification 347 Address *
57 Current Address Verification 442 Pin Code
57 Current Address Verification 686 Address *
60 Address Verification 566 Pin Code
60 Address Verification 594 Address *
234 Postal Address Verification 4628 Address *
234 Postal Address Verification 4629 Pin Code *
44 Passport Verification 1435 Type of ID Card
44 Passport Verification 1584 DOB
44 Passport Verification 1604 Expiry Date
44 Passport Verification 2843 Passport Type
44 Passport Verification 2844 Country Code(Issuing state or organisation)
44 Passport Verification 2845 Surname(Last Name)
44 Passport Verification 2846 Given Names(First Name)
44 Passport Verification 2847 Gender
44 Passport Verification 2848 Optional Data
44 Passport Verification 2849 MRZ code (Line 1)
44 Passport Verification 2850 MRZ code (Line 2)
45 PAN No Verification 1438 PAN Card No
45 PAN No Verification 1580 Person to whom it relates
45 PAN No Verification 1581 DOB
50 India Criminal Litigation Database Check 3130 Address
53 India Reputational Risk Database Check 2704 Name of the Key person
53 India Reputational Risk Database Check 2717 DOB
53 India Reputational Risk Database Check 2718 Father's Name
54 India Advanced Web and Media Searches 2708 Name of the Key person
54 India Advanced Web and Media Searches 2709 DOB
54 India Advanced Web and Media Searches 2710 Father's Name
55 Global Database Check 550 Address *
63 India Credit Default Database Check 727 Address *
63 India Credit Default Database Check 2705 Name of the Key person
63 India Credit Default Database Check 2715 DOB
63 India Credit Default Database Check 2716 Father's Name
67 India Crime Watch List Database Check 3159 Address
72 National Identity Check 935 ID Card No. *
72 National Identity Check 1434
Type of ID Card *
Values are as follows:
  1. Pan Card
  2. Passport
  3. Driving License
  4. Voter Id
72 National Identity Check 1480 Gender
72 National Identity Check 1483 Country Code(Issuing state or organisation)
72 National Identity Check 2792 Candidate Name as per Document *
72 National Identity Check 2851 Passport Type
72 National Identity Check 2852 Surname(Last Name)
72 National Identity Check 2853 Given Names(First Name)
72 National Identity Check 2854 Date of Expiration
72 National Identity Check 2855 Optional Data
72 National Identity Check 2856 MRZ code (Line 1)
72 National Identity Check 2857 MRZ code (Line 2)
78 India Civil Litigation Database Check 3232 Address. *
90 India Court Record Check through Law Firm 1421 Address
90 India Court Record Check through Law Firm 1674 Period of Stay
132 India Court Record Database Check 2719 Name of the Key person
132 India Court Record Database Check 2952 Address
133 Global Regulatory Compliance and Debarment Database Verification 2707 Name of the Key person
133 Global Regulatory Compliance and Debarment Database Verification 2711 DOB
133 Global Regulatory Compliance and Debarment Database Verification 2712 Father's Name
133 Global Regulatory Compliance and Debarment Database Verification 2950 Address
142 Voter ID Verification 2680 Voter ID card No.
142 Voter ID Verification 2681 Candidate name as per document
164 SAM 3281 Name of the Candidate
164 SAM 3282 DUNS (for business entities)
164 SAM 3283 CAGE Code
165 GSA 3287 Name of the Candidate
165 GSA 3288 DUNS (for business entities)
165 GSA 3289 CAGE Code
166 OIG Database Check 3293 Address
166 OIG Database Check 3299 SSN
171 National Sex Offender Search 3345 First Name
171 National Sex Offender Search 3346 Last Name
179 India Court Record DB Check 3680 Address
203 Travel Insurance policy Verification 4215 Policy Number
203 Travel Insurance policy Verification 4216 Candidate name as per Document
25 Education Verification 91 College/ Institute/ University, Location *
25 Education Verification 92 Roll No/ Registration No/Enrollment No. *
25 Education Verification 336 Course Name / Qualification *
25 Education Verification 1095 Year of Passing *
83 Education Verification W 1216 College/ Institute/ University, Location *
83 Education Verification W 1218 Course Name / Qualification *
83 Education Verification W 1219 Roll No/ Registration No/Enrollment No. *
83 Education Verification W 1225 Year of Passing *
141 Education Institution Validation 2664 Name of Institution *
141 Education Institution Validation 2665 Address
141 Education Institution Validation 2666 Course
141 Education Institution Validation 2667 Mode of Education
144 Education Verification Written 2732 College/ Institute/ University, Location *
144 Education Verification Written 2734 Course Name / Qualification *
144 Education Verification Written 2735 Roll No/ Registration No/Enrollment No. *
144 Education Verification Written 2741 Year of Passing *
34 Professional Reference Check 3471 Professional Reference details (Name, Designation, Email ID & Tel No.) *
38 Personal Reference Check 3574 Personal Reference details (Name\, Designation\, Email ID & Tel No.)
41 Previous Employment Verification 129 Designation *
41 Previous Employment Verification 130 Tenure *
41 Previous Employment Verification 131 Cost to Company *
41 Previous Employment Verification 132 Employee Code *
41 Previous Employment Verification 134 Reason for leaving
41 Previous Employment Verification 3469 Reporting Manager contact details (Designation, Email ID & Tel No.) *
58 Current Employment Verification 528 Tenure *
58 Current Employment Verification 529 Designation *
58 Current Employment Verification 530 Cost to Company *
58 Current Employment Verification 531 Employee Code *
58 Current Employment Verification 534 Reason for leaving
58 Current Employment Verification 3470 Reporting Manager contact details (Designation, Email ID & Tel No.) *
71 Company Check 927 Company Name *
71 Company Check 1344 Company Address
163 Immediate previous employment 3252 Designation
163 Immediate previous employment 3257 Tenure
163 Immediate previous employment 3258 Cost to Company
163 Immediate previous employment 3259 Employee Code
163 Immediate previous employment 3261 Reason for leaving
46 Police Verification Verbal 282 Address *
61 India Police Record Verification 1343 Address *
61 India Police Record Verification 3707 Caste
61 India Police Record Verification 3708 Police Station
61 India Police Record Verification 3709 Current Locality
61 India Police Record Verification 3710 Residing From
61 India Police Record Verification 3711 Reference 1
61 India Police Record Verification 3712 Reference 1 Mobile Number
61 India Police Record Verification 3713 Reference 2
61 India Police Record Verification 3714 Reference 2 Mobile Number
61 India Police Record Verification 3719 Reference 1 relationship with candidate
61 India Police Record Verification 3720 Reference 2 relationship with candidate
84 India Police Record Verification through Law Firm 2586 Address
84 India Police Record Verification through Law Firm 2596 Period of Stay
152 CIN Verification 3014 CIN 
152 CIN Verification 3015 Company Name
153 DIN Verification 3022 Director's/Designated Partner's Name :
154 TIN or VAT Verification 3025 TIN
154 TIN or VAT Verification 3026 Dealer Name
155 Service Tax Verification 3031 Service Tax Code/Assessee Code
155 Service Tax Verification 3032 Name of Assessee
156 TAN Verification 3035 TAN
156 TAN Verification 3036 State
156 TAN Verification 3037 Category of deductor
156 TAN Verification 3038 Name
172 CST 3362 TIN *
173 Excise and Service Tax 3370 Assessee Code *
119 Document Verification 3213 Company name
119 Document Verification 3214 Bank Name
119 Document Verification 3215 Bank Account Number
101 Driving License Verification 1578 Person to whoom it relates
101 Driving License Verification 1579 Driving License Number
207 Pre Employment Verification 4271 Designation *
207 Pre Employment Verification 4272 Tenure *
207 Pre Employment Verification 4273 Cost to Company *
207 Pre Employment Verification 4274 Employee Code *
207 Pre Employment Verification 4276 Reason for leaving
208 Bank Statement Verification 4303 Name of the A/c Holder (As per the bank statement)
208 Bank Statement Verification 4304 Bank Name & Address

Annexure 4- Document Types

DOCUMENT_IDDOCUMENT_NAME
70 Aadhar Card
18 Address Proof
26 Authorization Release Note
57 CV Document
11 Degree
68 Driving License
14 Experience Letter
22 Final year marksheet
17 PAN Number
16 Passport
9 Photograph
10 Resignation Letter
6 Salary Slip containing Employee ID
71 Voter ID

Annexure 5- Types of Severity

SeverityDescription
Discrepant Where either the verification source [viz., previous employer or education institution] is fake or suspect OR the verification response reports a mismatch with the stated antecedents
Minor Discrepant Where the verification response reports a mismatch and mismatch is of a lesser degree/lower impact than discrepant.
Attention Required Where verification source [viz., previous employer or education institution] is unable to share a response due to lack of data/ data accessibility OR refuses to give complete response
Insufficient Where verification could not be completed due to absence of mandatory data or document
No Response Received Where verification could not be completed as the response from the verification source [viz., previous employer or education institution] has not been received till the date of report generation.
Clear Where there is no disparity between stated and verified antecedents OR the difference is considered non-significant and treated as Clear.

Annexure 6- Error Codes

2XX- Success of some kind
4XX - Error occurred in client’s part
5XX - Error occurred in server’s part
Status CodeDescription
200 Data Uploaded Successfully
400 Invalid json format
401 Invalid uniqueID or requestID
405 Method Not Allowed
500 Some technical issue, Please try after some time