Scribd
Upload
76 views

Aadhaar Masking API Documentation

Uploaded by

abhishek.kumar
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
76 views

Aadhaar Masking API Documentation

Uploaded by

abhishek.kumar
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

AADHAAR MASKING API

DOCUMENTATION
Copyright Notice:
The present document or drawing is property of Khosla Labs, and shall not, under any circumstances, be totally or partially,
directly or indirectly, transferred, reproduced, copied, disclosed or used, without its prior written consent, for any purpose
and in any way other than that for which it is specifically furnished or outside the extent of the agreed upon right of use.
INTRODUCTION:

The Aadhaar Masking solution has been developed by Khosla Labs and it can be consumed by partners to mask
their customer’s Aadhaar numbers.

API:

● AadhaarInfoExtract

AadhaarInfoExtract:

This API would allow the Partners to send the Aadhaar Front and Back image of the customer and receives a
Masked Aadhaar Image.

METHOD:

Method URL

POST https://sandbox.veri5digital.com/video-id-kyc/api/1.0/v4AadhaarInfoExtract

REQUEST PAYLOAD DATA:

HEADERS:

PARAMETERS TYPE VALUE LENGTH M/NM

client_code Alphanumeri Unique code assigned by KL 32 M


c

sub_client_code Alphanumeri Unique code assigned by KL 32 M


c
channel_code ENUM Identifies the Channel Used 64 M
by the Client

channel_version Alphanumeri Specifies Android/WEB SDK 64 M


c version

stan String Unique ID provided by 128 M


client & should not exceed
more than 64 CHAR

client_ip Alphanumeri IP Address of the client 64 M


c device

transmission_datetime Alphanumeri Request initiated time 64 M


c

operation_mode Enum Specifies the operation 64 M


mode of the request.

run_mode Enum Specifies the run mode of 64 M


the request.

actor_type Alphanumeri Specifies the type of actor 64 M


c

user_handle_type Alphanumeri Indicates the type of the 64 M


c user identifier, who has
initiated the request.

user_handle_value Alphanumeri Actual value of 64 M


c user_handle_type.

location Alphanumeri Specifies the geo location 64 M


c of the device that initiated
the service request.

function_code Enum Specifies the flavour of the 64 M


api request.

function_sub_code Enum Specifies the flavour of the 64 M


api request specified by the
flavour specified by
function_code.

REQUEST DATA:
PARAMETERS TYPE VALUE LENGTH M/NM

request_id String Unique ID assigned by the 64 M


Partner.

hash String SHA256 Hash of 255 M


client_code|request_id|api
_key|salt

api_key String Unique API Key assigned by 64 M


KL

purpose String Purpose of Masking 64 M

document_type String Always pass as “AADHAAR 32 M


“

document_side String Always pass as “BOTH” 32 M

extraction_type String Always pass as “NO” 32 M

mask_aadhaar String Always pass as “YES” 32 M

document_front_image String Base64 of Front side – M


Aadhaar

document_back_image String Base64 of Back side – M


Aadhaar

SAMPLE REQUEST DATA:

{
"headers": {
"client_code": "UNIQUE CODE ASSIGNED BY KL",
"sub_client_code": "UNIQUE CODE ASSIGNED BY KL",
"channel_code": "ANDROID_SDK",
"channel_version": "1.0.0",
"stan": "UNIQUE STAN FOR EACH REQ",
"client_ip": "CLIENT IP",
"transmission_datetime": "1637844654015",
"operation_mode": "SELF",
"run_mode": "TRIAL",
"actor_type": "OTHER",
"user_handle_type": "EMAIL",
"user_handle_value": "[email protected]",
"location": "NA",
"function_code": "DEFAULT",
"function_sub_code": "DEFAULT"
},
"request": {
"request_id": "7070701111134",
"hash": "894920c6c10b9167cb33eaaf65af0dfd9d7a5bad680932ab404acf04d9f5b844",
"api_key": "kjc6svt44",
"purpose": "testing in Khosla",
"document_type": "AADHAAR",
"document_side": "BOTH",
"extraction_type": "NO",
"mask_aadhaar": "YES",
"document_front_image": "BASE64 FRONT",
"document_back_image": "BASE64 BACK"
}
}

SAMPLE RESPONSE:

"response_data": {
"encrypted": "NO",
"document_data": "BASE64 OF MASKED DATA AND ORIGINAL DATA”
"hash": "01ab7947fb6f67af11b515a9e7961641971251bd6199d456716d0b45277a3bc0"
},
"response_status": {
"code": "000",
"message": "",
"status": "SUCCESS"
}

You might also like