API

This API is used to initiate verification requests for a candidate into the 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 is shared in a synchronous way

Initiate or add a Case

Request Format

API Environment URL
Test https://authbridge.info/client_api_demo/AuthApi/post_data
Production https://authbridge.info/rest/api/v1/case

Header Parameters

Param Value Example
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));
?>

                            
{
    "id":"551564b7865af96a28b13f36",
    "object":"candidate",
    "uri":"/v1/candidates/551564b7865af96a28b13f36",
    "created_at":"2018-08-17T01:08:18Z",
    "first_name":"Michael",
    "last_name":"Scott",
    "middle_name":"Gary",
    "mother_maiden_name":null,
    "dob":"1964-03-15",
    "ssn":"XXX-XX-2001",
    "email":"michael.scott@dundermifflin.com",
    "zipcode":"06831",
    "phone":"2035408926",
    "driver_license_state":"CT",
    "driver_license_number":"981736076",
    "copy_requested":true,
    "previous_driver_license_state":null,
    "previous_driver_license_number":null,
    "adjudication":null,
    "custom_id":null,
    "no_middle_name":false,
    "report_ids":[],
    "geo_ids":[]
}
{
    "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"
                }
            ]
        }
    }
}

                            

Body Parameters

Param M/O Comments
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
flex_fields O These are additional/ optional client-specific fields that can be mapped. While we receive personal information of the candidate like Name / DOB/ Mobile No. and these are the mandatory fields; there could be something that acts as a unique identifier like emp ID or anything that you would require to be published in reports/invoices to track the candidate
arn O ARN stands for Authorization Release Note which is basically a consent form from the candidate authorizing us to carry his verification
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 addressed 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-file content & fileType
checks : files: fileType O 1 – URL 2 – BINARY ENCODED
checks : files: file content O Value= URL OR BYTECODE
checks : files: document type O This is the list of documents that need to be sent for that particular check file. Please refer Annexure 4

Annexure 1

Location List

LOCATION_ID LOCATION
192840 Gurgaon

Example Sample Code

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

Technology Code Link
PHP Downlod PHP Example Code

Annexure 2

Process List

PROCESS_ID PROCESS_NAME
885 Tset

Annexure 3

Check Fields

CHECK_ID CHECK_NAME FIELD_ID FIELD_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 *
139 Previous Address 2608 Address
139 Previous Address 2609 Pin Code
139 Previous Address 2610 Landmark
234 Postal Address Verification 4628 Address *
234 Postal Address Verification 4629 Pin Code *
259 Digital Address Verification 5559 Address Provided *
259 Digital Address Verification 5562 GPS Coordinates *
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
47 Indian Database Verification 443 Address *
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. Aadhar Card (*Stopped as per Government Policy.)
  3. Passport
  4. Driving License
  5. 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
145 India Credit History 3154 Name
145 India Credit History 3155 Address
164 SAM 3281 Name of the Candidate
164 SAM 3282 DUNS (for business entities)
164 SAM 3283 CAGE Code
171 National Sex Offender Search 3345 First Name
171 National Sex Offender Search 3346 Last Name
257 Visual Document Validation 5448 Applicant Name *
257 Visual Document Validation 5449 Sports Category *
257 Visual Document Validation 5451 Certificate Issue Date
257 Visual Document Validation 5452 Certificate Expiry Date
258 Bank Account Verification 5543 Account Number
258 Bank Account Verification 5544 IFSC Code
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
75 Current Professional Reference check 4960 Reference details(Name, Designation, Email ID & Tel No.)
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
42 Gap Check 185 Period from *
42 Gap Check 186 Period to *
42 Gap Check 896 Stated Reason for Gap *
152 CIN Verification 3014 CIN
152 CIN Verification 3015 Company Name
153 DIN Verification 3022 Director’s/Designated Partner’s Name :
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
183 GSTIN 3847 State
183 GSTIN 5519 Registered/ Business Name of the Company
183 GSTIN 5542 Registration No.
208 Bank Statement Verification 4303 Name of the A/c Holder (As per the bank statement)
208 Bank Statement Verification 4304 Bank Name & Address
216 Verbal Address Verification 4455 Address
216 Verbal Address Verification 4456 Period of stay
216 Verbal Address Verification 4468 Referee Name and Contact Details

Annexure 4

Document Types

DOCUMENT_ID DOCUMENT_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

Severity Description
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 Code Description
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