0% found this document useful (0 votes)

122 views70 pages

Documentation _ TotalKYC API Dashboard - Perfios Software Solutions

The document provides API documentation for the TotalKYC OCR (Plus) service, detailing how to extract data from various identification documents such as PAN, Aadhaar, and Driving License. It includes information on request schemas, required parameters, response formats, and quality checks for the uploaded files. Additionally, it outlines the expected response structure and attributes for successful data extraction and validation.

Uploaded by

pehajo2593

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

122 views70 pages

Documentation _ TotalKYC API Dashboard - Perfios Software Solutions

Uploaded by

pehajo2593

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 70

21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions

API/SDK Documentation Test Prod

KYC OCR (Plus)  2024-08-02

POST https://api.karza.in/v3/ocr-plus/kyc  Sync  30s

API to extract data from Permanent Account Number (PAN), Aadhaar, E-Aadhaar, Voter ID, Passport and DL (Driving
License)

Note: If the document type is DL, please make sure to select Driving License option in the Tryout section.

Request
Schema

Attribute Type Description Validations Required

file string File to be uploaded Supported document Yes, if url & fileB64 is
types: JPEG, JPG, PNG, not given
PDF, TIFF
Image file size: 4MB
PDF file size: 2MB
Image size (min:max):
350x240 : 32000x32000
pixels

fileBase64 string Base64 value of the file Supported document Yes, if file & url is not
to be uploaded types: JPEG, JPG, PNG, selected
PDF, TIFF
Image file size: 4MB
PDF file size: 2MB
Image size (min:max):
350x240 : 32000x32000
pixels

url string The URL for the file to Supported document Yes, if file & fileBase64
be uploaded types: JPEG, JPG, PNG, is not selected
PDF, TIFF
Image file size: 10MB
PDF file size: 10MB
Image size (min:max):
350x240 : 32000x32000
pixels

pdfPassword string Password of the PDF - Yes, if the input PDF file
file uploaded is password protected

requiredConfidence boolean If OCR Confidence % is Allowed values: true, No

required against each false. True if you need
value extracted the OCR confidence
percentage against
each value extracted
from the document

requiredOcr boolean If OCR has to be Allowed values: true, Yes, if OCR has to be
conducted on the input false skipped and only
file AADHAAR masking is
required

© 2025 PERFIOS SOFTWARE SOLUTIONS PRIVATE LIMITED

Attribute Type Description Validations Required

returnQualityChecks Array If quality checks to be Allowed values: BLUR, Yes, if quality checks
performed for the CUT_CARD, need to be performed
input file BLACK_AND_WHITE,
BRIGHTNESS, ALL

maskAadhaarImage string If the input is Aadhaar Allowed values: No

and masked Aadhaar COMPLETE,
image is required in EIGHT_DIGITS
the output

maskAadhaarText string If the input is Aadhaar Allowed values: No

and masked Aadhaar COMPLETE,
number is required in EIGHT_DIGITS
the output

responseFormat string Format in which the Allowed Values: No

masked Aadhaar image Select "File Level
response is expected Masking" to receive the
entire input file with
only the Aadhaar card
details masked.
Select "Document
Type" to receive only
the Aadhaar card with
masked details,
discarding all other
parts of the file.

responseType string Type in which the Allowed values: URL, No

masked Aadhaar image Base64
response is expected

docTypes Array The document type Allowed values: DL Yes, if input is DL

being captured for OCR

rejectionCriteria Array If the cards need to be Allowed Values: Yes, If the rejection
rejected on the basis of BRIGHTNESS, BLUR, needs to be done.
quality CUT_CARD,
BLACK_AND_WHITE

parseQrData boolean If the QR Code needs Allowed values: True, No

to be parsed and False
information needs to
be extracted

maskQrImage boolean If the QR Code and the Allowed values: True, No

extracted information False
needs to be masked

tamperDetection boolean True, if the card needs Allowed values: True, No

to be checked for any False
tampering.

clientData Object Data of the user - No

sharing consent

caseId string Unique case id/lead id Max-length 200 No

of the user sharing
consent

Body


multipart/form-data:
formParameters:
file:
description: The file to be uploaded
required: true
type: file
pdfPassword:
description: Password of the PDF file uploaded
required: true, if the input PDF file is password protected
type: text
requiredConfidence:
description: true, if you need the OCR Confidence % against each value extracted
required: false
type: text
docType:
description: The document type being captured for OCR. Allowed value: dl
required: false
type: text
requiredOcr:
description: If OCR has to be conducted on the input file
required: true, if OCR has to be skipped and only AADHAAR masking is required
type: text
returnQualityChecks:
description: true, if quality checks to be performed for the input file
required: false
type: text
responseFormat:
description: Format in which the masked Aadhaar image response is expected
required: false
type: text
responseType:
description: Type in which the masked Aadhaar image response is expected
required: false
type: text
maskAadhaarImage:
description: If the input is Aadhaar and masked Aadhaar image is required in the ou
required: false
type: text
maskAadhaarText:
description: If the input is Aadhaar and masked Aadhaar number is required in the o
required:false
type: text
rejectionCriteria:
description: True, if the card needs to be rejected on the basis of quality. Allowe
required: false
type: text
parseQRdata:
description: True, if the QR code needs to be extracted and parsed for the informat
required: false
type: text
maskQRdata:
description: True, if the QR code and the information extracted needs to be masked.
required: false

{
"url": "",
"pdfPassword": "",
"requiredConfidence": true,
"requiredOcr": true,
"returnQualityChecks": [
"ALL"
],
"maskAadhaarImage": "EIGHT_DIGITS",
"maskAadhaarText": "EIGHT_DIGITS",
"responseFormat": "DOCUMENT",
"responseType": "URL",
"docTypes": [
"DL"
],
"parseQRdata": true,
"maskQRdata": true,
"tamperDetection": true,
"clientData": {
"caseId": "123456"
}
}

{
"fileBase64": "",
"pdfPassword": "",
"requiredConfidence": true,
"requiredOcr": true,
"returnQualityChecks": [
"ALL"
],
"maskAadhaarImage": "EIGHT_DIGITS",
"maskAadhaarText": "EIGHT_DIGITS",
"responseFormat": "DOCUMENT",
"responseType": "URL",
"docTypes": [
"DL"
],
"parseQRdata": true,
"maskQRdata": true,
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 4/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
"tamperDetection": true,
"clientData": {
"caseId": "123456"
}
}

Headers


Content-Type : "application/json"
x-karza-key: "<<YOUR KEY HERE>>"

Response (E-Aadhaar)
Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

aadhaar Object 12 digit Aadhaar Card No

Number as per the Card

value string Value of Aadhaar Card No

Number

confidence number Confidence Score of No

Aadhaar Card Number

address Object Address registered with No

UIDAI

value string Value of Address No

confidence number Confidence Score of No

Address

name Object Name of the Aadhaar No

Holder as per the Card

value string Value of Aadhaar Holder No

Name

Attribute Type Description Required

confidence number Confidence Score of No

Aadhaar Holder Name

pin Object PIN code of the registered No

address

value string Value of Pincode No

confidence number Confidence Score of No

Pincode

additionalDetails Object Additional details No

inputMaskStatus Object Masking status of the input No

file

isMasked boolean Whether value of Aadhaar No

Card Number read from
input image is in masked
form or not

maskedBy string Masked by details No

confidence string Confidence Score of No

masking detection

outputMaskStatus boolean Whether the value of No

Aadhar Card Number in
the output is masked or
not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

qr string Data extracted from QR No

code on the document

barcode string Data extracted from No

barcode on the document

parsedQrData string Data extracted from QR on No

the Aadhaar document

aadhaar string 12 digit Aadhaar Card No

Number as per the Card

name string Name of the Aadhaar No

Holder as per the Card

dob string Date Of Birth of the Aadhar No

Holder as per the card

yob string Year of birth for the No

Aadhar Holder as per the
card

gender string Gender of the Aadhar No

Holder as per the card

emailHash string Email address associated No

with the Aadhar card
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 6/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions

Attribute Type Description Required

mobileHash string Mobile Number associated No

with the Aadhar card

image string Image from the Aadhar No

address string Address of the aadhar card No

holder

version string Version of the QR Code of No

Aadhar Card

mobile string Mobile number registered No

of the Aadhar card holder

additionalDetails Object Additional details No

addressSplit Object Address Split of the No

Address provided

careOf string Care of Aadhaar Holder No

district string District of Aadhaar Holder No

landmark string Landmark of Aadhaar No

Holder

house string House Number of Aadhaar No

Holder

location string Location of Aadhaar No

Holder

pincode string Pincode of Aadhaar Holder No

postOffice string Post Office of Aadhaar No

Holder

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

subDistrict string Sub District of Aadhaar No

Holder

vtc string Village/Town/City of No

Aadhaar Holder

isSigned boolean If Aadhar is digitally signed No

or not

signatureVerified boolean If signature is digitally No

verified or not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

addressSplit Object Detailed Address No

registered with UIDAI

building string Building of Aadhaar Holder No

Attribute Type Description Required

city string City of Aadhaar Holder No

district string District of Aadhaar Holder No

pin string Pincode of Aadhaar Holder No

floor string Floor of Aadhaar Holder No

house string House of Aadhaar Holder No

locality string Locality of Aadhaar Holder No

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

complex string Complex of Aadhaar No

Holder

landmark string Landmark of Aadhaar No

Holder

untagged string Untagged information of No

Aadhaar Holder

careOfDetails Object Care of details of Aadhaar No

Holder

relation string Relation with Aadhaar No

Holder

name string Name of Relative No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 8/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions

Attribute Type Description Required

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "549a1ebe-8a7a-4650-8b39-6b3c89453265",
"result": {
"documents": [
{
"documentType": "AADHAAR",
"subType": "E_AADHAAR",
"pageNo": 1,
"ocrData": {
"aadhaar": {
"value": "********2500",
"confidence": 1
},
"address": {
"value": "",
"confidence": 0.82
},
"name": {
"value": "",
"confidence": 0.82
},
"pin": {
"value": "",
"confidence": 0.96
}
},
"additionalDetails": {
"inputMaskStatus": {
"isMasked": false,
"maskedBy": null,
"confidence": null
},
"outputMaskStatus": true,
"verhoeffCheck": true,
"qr": null,
"barcode": null,
"parsedQrData": {
"aadhaar": "********8855",
"name": "",
"dob": "",
"yob": "",
"gender": "",
"emailHash": null,
"mobileHash": "b3987028141ed0d5613d3ac7dc4e1c39ff910004001080ff910004001180ffd9
"image": "Base64",
"address": "",
"version": "SECURE_V2",
"mobile": "******6853",
"additionalDetails": {
"addressSplit": {
"careOf": "D/O: ",
"district": "",
"landmark": "",

https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 10/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
"house": "",
"location": "",
"pincode": "",
"postOffice": "",
"state": "",
"street": "",
"subDistrict": "",
"vtc": ""
},
"isSigned": true,
"signatureVerified": true,
"verhoeffCheck": null
}
},
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",
"street": "",
"complex": "",
"landmark": "",
"untagged": ""
},
"careOfDetails": {
"relation": "",
"name": ""
}
},
"qualityChecks": [
{
"score": 0.78,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0,
"flag": false,
"type": "BLUR"
},
{
"score": 0.04,
"flag": false,
"type": "CUT_CARD"
}
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 11/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
],
"tamperCheck": {
"score": 0.9,
"tamperRisk": "HIGH",
"status": "SUCCESS"
},
"documentLink": ""
}
]
},
"statusCode": 101,
"clientData": {
"caseId": "123456"
}
}

Headers


Content-Type : "application/json"

Response (Aadhaar Front Top)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

aadhaar Object 12 digit Aadhaar Card No

Number as per the Card

value string Value of Aadhaar Card No

Number

confidence number Confidence Score of No

Aadhaar Card Number

address Object Address registered with No

UIDAI

Attribute Type Description Required

value string Value of Address No

confidence number Confidence Score of No

Address

name Object Name of the Aadhaar No

Holder as per the Card

value string Value of Aadhaar Holder No

Name

confidence number Confidence Score of No

Aadhaar Holder Name

phone Object Registered Mobile Number No

with UIDAI

value string Value of Phone Number No

confidence number Confidence Score of Phone No

Number

pin Object PIN code of the registered No

address

value string Value of Pincode No

confidence number Confidence Score of No

Pincode

vid Object VID detected as per the No

card

value string Value of VID No

confidence number Confidence Score of VID No

additionalDetails Object Additional details No

inputMaskStatus Object Masking status of the input No

file

isMasked boolean Whether value of Aadhaar No

Card Number read from
input image is in masked
form or not

maskedBy string Masked by details No

confidence string Confidence Score of No

masking detection

outputMaskStatus boolean Whether the value of No

Aadhar Card Number in
the output is masked or
not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

Attribute Type Description Required

qr string Data extracted from QR No

code on the document

barcode string Data extracted from No

barcode on the document

parsedQrData string Data extracted from QR on No

the Aadhaar document

aadhaar string 12 digit Aadhaar Card No

Number as per the Card

name string Name of the Aadhaar No

Holder as per the Card

dob string Date Of Birth of the Aadhar No

Holder as per the card

yob string Year of birth for the No

Aadhar Holder as per the
card

gender string Gender of the Aadhar No

Holder as per the card

emailHash string Email address associated No

with the Aadhar card

mobileHash string Mobile Number associated No

with the Aadhar card

image string Image from the Aadhar No

address string Address of the aadhar card No

holder

version string Version of the QR Code of No

Aadhar Card

mobile string Mobile number registered No

of the Aadhar card holder

additionalDetails Object Additional details No

addressSplit Object Address Split of the No

Address provided

careOf string Care of Aadhaar Holder No

district string District of Aadhaar Holder No

landmark string Landmark of Aadhaar No

Holder

house string House Number of Aadhaar No

Holder

location string Location of Aadhaar No

Holder

pincode string Pincode of Aadhaar Holder No

Attribute Type Description Required

postOffice string Post Office of Aadhaar No

Holder

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

subDistrict string Sub District of Aadhaar No

Holder

vtc string Village/Town/City of No

Aadhaar Holder

isSigned boolean If Aadhar is digitally signed No

or not

signatureVerified boolean If signature is digitally No

verified or not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

addressSplit Object Detailed Address No

registered with UIDAI

building string Building of Aadhaar holder No

city string City of Aadhaar Holder No

district string District of Aadhaar Holder No

pin string Pincode of Aadhaar Holder No

floor string Floor of Aadhaar Holder No

house string House Number of Aadhaar No

Holder

locality string Locality of Aadhaar Holder No

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

complex string Complex of Aadhaar No

Holder

landmark string Landmark of Aadhaar No

Holder

untagged string Untagged information of No

Aadhaar Holder

careOfDetails Object Care of details of Aadhaar No

Holder

relation string Relation with the Aadhaar No

Holder. Example :
FATHER|HUSBAND

name string Name of Relative No

Attribute Type Description Required

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not.

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "0926686d-04af-4495-bcb2-76f6cdf17c24",
"result": {
"documents": [
{
"documentType": "AADHAAR",
"subType": "FRONT_TOP",
"pageNo": 1,
"ocrData": {
"aadhaar": {
"value": "****",
"confidence": 0.78
},
"address": {
"value": "",
"confidence": 0.92
},
"name": {
"value": "",
"confidence": 0.88
},
"phone": {
"value": "",
"confidence": 0.97
},
"pin": {
"value": "491001",
"confidence": 0.7
},
"vid": {
"value": "",
"confidence": 0.8
}
},
"additionalDetails": {
"inputMaskStatus": {
"isMasked": null,
"maskedBy": null,
"confidence": null
},
"outputMaskStatus": false,
"verhoeffCheck": null,
"qr": null,
"barcode": null,
"parsedQrData": {
"aadhaar": "********8855",
"name": "",
"dob": "1997-04-19",
"yob": "1997",
"gender": "F",
"emailHash": null,
"mobileHash": "b3987028141ed0d5613d3ac7dc4e1c39ff910004001080ff910004001180ffd9
"image": "",

https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 17/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
"address": "",
"version": "SECURE_V2",
"mobile": "******6853",
"additionalDetails": {
"addressSplit": {
"careOf": "",
"district": "",
"landmark": "",
"house": "",
"location": "",
"pincode": "",
"postOffice": "",
"state": "",
"street": "",
"subDistrict": "",
"vtc": ""
},
"isSigned": true,
"signatureVerified": true,
"verhoeffCheck": null
}
},
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",
"street": "",
"complex": "",
"landmark": "",
"untagged": ""
},
"careOfDetails": {
"relation": "",
"name": ""
}
},
"qualityChecks": [
{
"score": 0.89,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0.33,
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 18/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
"flag": false,
"type": "BLUR"
},
{
"score": 0.1,
"flag": false,
"type": "CUT_CARD"
}
],
"tamperCheck": {
"score": 0.9,
"tamperRisk": "HIGH",
"status": "SUCCESS"
},
"documentLink": ""
}
]
},
"statusCode": 101,
"clientData": {
"caseId": "123456"
}
}

Headers


Content-Type : "application/json"

Response (Aadhaar Front Bottom)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

aadhaar Object 12 digit Aadhaar Card No

Number as per the Card

Attribute Type Description Required

value string Value of Aadhaar Card No

Number

confidence number Confidence Score of No

Aadhaar Card Number

dob Object Date of Birth of the No

Aadhaar holder as per the
card

value string Value of Date of Birth No

confidence number Confidence Score of Date No

of Birth

father Object Father's Name of the No

Aadhaar Holder as per the
Card

value string Value of Father's Name No

confidence number Confidence Score of No

Father's Name

gender Object Gender of the Aadhaar No

holder as per the card

value string Value of Gender No

confidence number Confidence Score of No

Gender

husband Object Husband's Name of the No

Aadhaar Holder as per the
Card

value string Value of Husband's Name No

confidence number Confidence Score of No

Husband's Name

mother Object Mother's name of the No

Aadhaar holder as per the
card

value string Value of Mother's Name No

confidence number Confidence Score of No

Mother's Name

name Object Name of the Aadhaar No

Holder as per the Card

value string Value of Aadhaar Holder No

Name

confidence number Confidence Score of No

Aadhaar Holder Name

vid Object VID detected as per the No

card
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 20/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions

Attribute Type Description Required

value string Value of VID No

confidence number Confidence Score of VID No

yob Object Year of Birth of the No

Aadhaar holder as per the
card.

value string Value of Year of Birth. No

confidence number Confidence Score of Year No

of Birth.

additionalDetails Object Additional details No

inputMaskStatus Object Masking status of the input No

file

isMasked boolean Whether value of Aadhaar No

Card Number read from
input image is in masked
form or not

maskedBy string Masked by details No

confidence string Confidence Score of No

masking detection

outputMaskStatus boolean Whether the value of No

Aadhar Card Number in
the output is masked or
not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

qr string Data extracted from QR No

code on the document

barcode string Data extracted from No

barcode on the document

parsedQrData string Data extracted from QR on No

the Aadhaar document

aadhaar string 12 digit Aadhaar Card No

Number as per the Card

name string Name of the Aadhaar No

Holder as per the Card

dob string Date Of Birth of the Aadhar No

Holder as per the card

yob string Year of birth for the No

Aadhar Holder as per the
card

gender string Gender of the Aadhar No

Holder as per the card

Attribute Type Description Required

emailHash string Email address associated No

with the Aadhar card

mobileHash string Mobile Number associated No

with the Aadhar card

image string Image from the Aadhar No

address string Address of the aadhar card No

holder

version string Version of the QR Code of No

Aadhar Card

mobile string Mobile number registered No

of the Aadhar card holder

additionalDetails Object Additional details No

addressSplit Object Address Split of the No

Address provided

careOf string Care of Aadhaar Holder No

district string District of Aadhaar Holder No

landmark string Landmark of Aadhaar No

Holder

house string House Number of Aadhaar No

Holder

location string Location of Aadhaar No

Holder

pincode string Pincode of Aadhaar Holder No

postOffice string Post Office of Aadhaar No

Holder

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

subDistrict string Sub District of Aadhaar No

Holder

vtc string Village/Town/City of No

Aadhaar Holder

isSigned boolean If Aadhar is digitally signed No

or not

signatureVerified boolean If signature is digitally No

verified or not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

qualityChecks Array Quality attributes for the No

input file
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 22/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions

Attribute Type Description Required

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "378d4b46-5e30-4107-9a6d-368b120013ab",
"result": {
"documents": [
{
"documentType": "AADHAAR",
"subType": "FRONT_BOTTOM",
"pageNo": 1,
"ocrData": {
"aadhaar": {
"value": "********8855",
"confidence": 1
},
"dob": {
"value": "",
"confidence": 1
},
"father": {
"value": "",
"confidence": 0
},
"gender": {
"value": "",
"confidence": 1
},
"husband": {
"value": "",
"confidence": 0
},
"mother": {
"value": "",
"confidence": 0
},
"name": {
"value": "",
"confidence": 1
},
"vid": {
"value": "",
"confidence": 0.8
},
"yob": {
"value": "",
"confidence": 0
}
},
"additionalDetails": {
"inputMaskStatus": {
"isMasked": false,
"maskedBy": null,
"confidence": null
},
"outputMaskStatus": true,

Headers

Content-Type : "application/json"


Response (Aadhaar Back)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

Attribute Type Description Required

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

aadhaar Object 12 digit Aadhaar Card No

Number as per the Card

value string Value of Aadhaar Card No

Number

confidence number Confidence Score of No

Aadhaar Card Number

address Object Address registered with No

UIDAI

value string Value of Address No

confidence number Confidence Score of No

Address

pin Object PIN code of the registered No

address

value string Value of Pincode No

confidence number Confidence Score of No

Pincode

vid Object VID detected as per the No

card

value string Value of VID No

confidence number Confidence Score of VID No

additionalDetails Object Additional details No

inputMaskStatus Object Masking status of the input No

file

isMasked boolean Whether value of Aadhaar No

Card Number read from
input image is in masked
form or not

maskedBy string Masked by details No

Attribute Type Description Required

confidence string Confidence Score of No

masking detection

outputMaskStatus boolean Whether the value of No

Aadhar Card Number in
the output is masked or
not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

qr string Data extracted from QR No

code on the document

barcode string Data extracted from No

barcode on the document

parsedQrData string Data extracted from QR on No

the Aadhaar document

aadhaar string 12 digit Aadhaar Card No

Number as per the Card

name string Name of the Aadhaar No

Holder as per the Card

dob string Date Of Birth of the Aadhar No

Holder as per the card

yob string Year of birth for the No

Aadhar Holder as per the
card

gender string Gender of the Aadhar No

Holder as per the card

emailHash string Email address associated No

with the Aadhar card

mobileHash string Mobile Number associated No

with the Aadhar card

image string Image from the Aadhar No

address string Address of the aadhar card No

holder

version string Version of the QR Code of No

Aadhar Card

mobile string Mobile number registered No

of the Aadhar card holder

additionalDetails Object Additional details No

addressSplit Object Address Split of the No

Address provided

careOf string Care of Aadhaar Holder No

district string District of Aadhaar Holder No

Attribute Type Description Required

landmark string Landmark of Aadhaar No

Holder

house string House Number of Aadhaar No

Holder

location string Location of Aadhaar No

Holder

pincode string Pincode of Aadhaar Holder No

postOffice string Post Office of Aadhaar No

Holder

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

subDistrict string Sub District of Aadhaar No

Holder

vtc string Village/Town/City of No

Aadhaar Holder

isSigned boolean If Aadhar is digitally signed No

or not

signatureVerified boolean If signature is digitally No

verified or not

verhoeffCheck boolean Whether the verhoeff No

check is valid or not

addressSplit Object Detailed Address No

registered with UIDAI

building string Building of Aadhaar Holder No

city string City of Aadhaar Holder No

district string District of Aadhaar Holder No

pin string Pincode of Aadhaar Holder No

floor string Floor of Aadhaar Holder No

house string House of Aadhaar Holder No

locality string Locality of Aadhaar Holder No

state string State of Aadhaar Holder No

street string Street of Aadhaar Holder No

complex string Complex of Aadhaar No

Holder

landmark string Landmark of Aadhaar No

Holder

Attribute Type Description Required

untagged string Untagged information of No

Aadhaar Holder

careOfDetails Object Care of details of Aadhaar No

Holder

relation string Relation with Aadhaar No

Holder

name string Name of Relative No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "bdc2f6a0-0c40-43ae-b63c-821b87713558",
"result": {
"documents": [
{
"documentType": "AADHAAR",
"subType": "BACK",
"pageNo": 1,
"ocrData": {
"aadhaar": {
"value": "********9318",
"confidence": 1
},
"address": {
"value": "",
"confidence": 1
},
"pin": {
"value": "",
"confidence": 0.95
},
"vid": {
"value": "",
"confidence": 0
}
},
"additionalDetails": {
"inputMaskStatus": {
"isMasked": false,
"maskedBy": null,
"confidence": null
},
"outputMaskStatus": true,
"verhoeffCheck": true,
"qr": null,
"barcode": null,
"parsedQrData": {
"aadhaar": "********8855",
"name": "",
"dob": "",
"yob": "",
"gender": "",
"emailHash": null,
"mobileHash": "b3987028141ed0d5613d3ac7dc4e1c39ff910004001080ff910004001180ffd9
"image": "Base64",
"address": "",
"version": "SECURE_V2",
"mobile": "******6853",
"additionalDetails": {
"addressSplit": {
"careOf": "D/O: ",
"district": "",
"landmark": "",

https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 30/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
"house": "",
"location": "",
"pincode": "",
"postOffice": "",
"state": "",
"street": "",
"subDistrict": "",
"vtc": ""
},
"isSigned": true,
"signatureVerified": true,
"verhoeffCheck": null
}
},
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",
"street": "",
"complex": "",
"landmark": "",
"untagged": ""
},
"careOfDetails": {
"relation": "",
"name": ""
}
},
"qualityChecks": [
{
"score": 0.73,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0,
"flag": false,
"type": "BLUR"
},
{
"score": 0.62,
"flag": true,
"type": "CUT_CARD"
}
https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 31/70
21/01/2025, 19:06 Documentation | TotalKYC API Dashboard - Perfios Software Solutions
],
"tamperCheck": {
"score": 0.9,
"tamperRisk": "HIGH",
"status": "SUCCESS"
},
"documentLink": ""
}
]
},
"statusCode": 101,
"clientData": {
"caseId": "123456"
}
}

Headers

Content-Type : "application/json"


Response (PAN)
Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

dob Object Date of Birth of PAN No

Holder

value string Value of Date of Birth No

confidence number Confidence Score of Date No

of Birth

doi Object Date of Issue No

value string Value of Date of Issue No

Attribute Type Description Required

confidence number Confidence Score of Date No

of Issue

father Object Father's Name of PAN No

Holder as per the card

value string Value of Father's Name No

confidence number Confidence Score of No

Father's Name

name Object Name of the PAN Holder No

as per the Card

value string Value of PAN Holder's No

Name

confidence number Confidence Score of PAN No

Holder's Name

pan Object Permanent Account No

Number (PAN) on the card

value string PAN Number No

confidence number Confidence Score of PAN No

additionalDetails Object Additional details No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

Attribute Type Description Required

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body

{

"requestId": "67989ed2-8a6a-42a6-922a-7fec3e644990",
"result": {
"documents": [
{
"documentType": "PAN",
"subType": "",
"pageNo": 1,
"ocrData": {
"dob": {
"value": "29/10/1982",
"confidence": 1
},
"doi": {
"value": "",
"confidence": 0
},
"father": {
"value": "",
"confidence": 0.84
},
"name": {
"value": "",
"confidence": 1
},
"pan": {
"value": "",
"confidence": 1
}
},
"additionalDetails": {},
"qualityChecks": [
{
"score": 0.59,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0,
"flag": false,
"type": "BLUR"
},
{
"score": 0,
"flag": false,
"type": "CUT_CARD"
}
],

Headers

Content-Type : "application/json"


Response (PAN Old)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

dob Object Date of Birth of PAN No

Holder

value string Value of Date of Birth No

confidence number Confidence Score of Date No

of Birth

doi Object Date of Issue No

value string Value of Date of Issue No

Attribute Type Description Required

confidence number Confidence Score of Date No

of Issue

father Object Father's Name of PAN No

Holder as per the card

value string Value of Father's Name No

confidence number Confidence Score of No

Father's Name

name Object Name of the PAN Holder No

as per the Card

value string Value of PAN Holder's No

Name

confidence number Confidence Score of PAN No

Holder's Name

pan Object Permanent Account No

Number (PAN) on the card

value string PAN Number No

confidence number Confidence Score of PAN No

additionalDetails Object Additional details No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

Attribute Type Description Required

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body

{

"requestId": "33afb3e5-7dc4-4ae3-8ef6-85c7dc0568c4",
"result": {
"documents": [
{
"documentType": "PAN",
"subType": "OLD",
"pageNo": 1,
"ocrData": {
"dob": {
"value": "30-06-1962",
"confidence": 1
},
"doi": {
"value": "",
"confidence": 0
},
"father": {
"value": "",
"confidence": 0.97
},
"name": {
"value": "",
"confidence": 1
},
"pan": {
"value": "",
"confidence": 1
}
},
"additionalDetails": {},
"qualityChecks": [
{
"score": 0.68,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 1,
"flag": true,
"type": "BLACK_AND_WHITE"
},
{
"score": 0,
"flag": false,
"type": "BLUR"
},
{
"score": 0.22,
"flag": false,
"type": "CUT_CARD"
}
],

Headers

Content-Type : "application/json"


Response (Voter ID Front)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

voterId Object Voter ID number No

value string Value of Voter ID Number No

confidence number Confidence Score of Voter No

name Object Name of the Voter ID No

holder in English

value string Value of Name of Voter ID No

holder

Attribute Type Description Required

confidence number Confidence Score of Voter No

ID holder

dob Object Date of Birth of the Voter No

Card holder as per EPIC
records

value string Value of Date Of Birth No

confidence number Confidence Score of Date No

of Birth

gender Object Gender of the card holder No

value string Value of Gender No

confidence number Confidence Score of No

Gender

ageAsPerDate Object Age of the card holder as No

per date

value string Value of Age No

confidence number Confidence Score of Age No

relationName Object Name of Relative Name of No

holder

value string Value of Relative Name No

confidence number Confidence Score No

age Object Age of the card holder in No

Years

value string Value of Age No

confidence number Confidence Score of Age No

additionalDetails Object Additional details No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

Attribute Type Description Required

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body

{

"requestId": "b8ba7821-217b-476f-9102-5c2579ab5dde",
"result": {
"documents": [
{
"documentType": "VOTER",
"subType": "FRONT",
"pageNo": 1,
"ocrData": {
"voterId": {
"value": "",
"confidence": 1
},
"name": {
"value": "",
"confidence": 1
},
"dob": {
"value": "XX/XX/1982",
"confidence": 0.96
},
"gender": {
"value": "",
"confidence": 0.93
},
"ageAsPerDate": {
"value": "",
"confidence": 0
},
"relationName": {
"value": "",
"confidence": 1
},
"age": {
"value": "",
"confidence": 0
}
},
"additionalDetails": {},
"qualityChecks": [
{
"score": 0.81,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 1,
"flag": true,
"type": "BLACK_AND_WHITE"
},
{
"score": 0.02,
"flag": false,

Headers


Content-Type : "application/json"

Response (Voter ID Front New)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

voterId Object Voter ID number No

value string Value of Voter ID Number No

Attribute Type Description Required

confidence number Confidence Score of Voter No

name Object Name of the Voter ID No

holder in English

value string Value of Name of Voter ID No

holder

confidence number Confidence Score of Voter No

ID holder

relationName Object Name of Relative Name of No

holder

value string Value of Relative Name No

confidence number Confidence Score No

additionalDetails Object Additional details No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "9060072d-947b-4df7-9a85-5f5bbcd499b3",
"result": {
"documents": [
{
"documentType": "VOTER",
"subType": "FRONT_NEW",
"pageNo": 1,
"ocrData": {
"voterId": {
"value": "",
"confidence": 0.1
},
"name": {
"value": "",
"confidence": 0.87
},
"relationName": {
"value": "",
"confidence": 0.78
}
},
"additionalDetails": {},
"qualityChecks": [
{
"score": 0.66,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0.36,
"flag": false,
"type": "BLUR"
},
{
"score": 0.22,
"flag": false,
"type": "CUT_CARD"
}
],
"tamperCheck": {
"score": 0.9,
"tamperRisk": "HIGH",
"status": "SUCCESS"
},
"documentLink": null
}
]

Headers


Content-Type : "application/json"

Response (Voter ID Back)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

voterId Object Voter ID number No

value string Value of Voter ID Number No

confidence number Confidence Score of Voter No

lastUpdateDate Object Last updated on No

value string Value of Last Update Date No

confidence number Confidence Score of Last No

Update Date

address Object Address No

value string Value of Address No

confidence number Confidence Score of No

Address

additionalDetails Object Additional details No

Attribute Type Description Required

addressSplit Object Detailed Address No

building string Building of Voter holder No

city string City of Voter Holder No

district string District of Voter Holder No

pin string Pincode of Voter Holder No

floor string Floor of Voter Holder No

house string House Number of Voter No

Holder

locality string Locality of Voter Holder No

state string State of Voter Holder No

street string Street of Voter Holder No

complex string Complex of Voter Holder No

landmark string Landmark of Voter Holder No

untagged string Untagged information of No

Voter Holder

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

Attribute Type Description Required

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "a721b3da-d074-429b-8f23-5ffbbe968e4c",
"result": {
"documents": [
{
"documentType": "VOTER",
"subType": "BACK",
"pageNo": 1,
"ocrData": {
"voterId": {
"value": "",
"confidence": 1
},
"lastUpdateDate": {
"value": "",
"confidence": 0
},
"address": {
"value": "",
"confidence": 0.56
}
},
"additionalDetails": {
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",
"street": "",
"complex": "",
"landmark": "",
"untagged": ""
}
},
"qualityChecks": [
{
"score": 0.65,
"flag": false,
"type": "BRIGHTNESS"
},
{
"score": 0,
"flag": false,
"type": "BLACK_AND_WHITE"
},
{
"score": 0.34,
"flag": false,
"type": "BLUR"

Headers


Content-Type : "application/json"

Response (Voter ID Back New)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

voterId Object Voter ID number No

value string Value of Voter ID Number No

Attribute Type Description Required

confidence number Confidence Score of Voter No

gender Object Gender of the card holder No

value string Value of Gender No

confidence number Confidence Score of No

Gender

lastUpdatedDate Object Last Updated on No

value string Value of Last Updated Date No

confidence number Confidence Score of Last No

Update Date

dob Object Date of Birth of the Voter No

Card holder as per EPIC
records

value string Value of Date Of Birth No

confidence number Confidence Score of Date No

of Birth

age Object Age of the card holder in No

Years

value string Value of Age No

confidence number Confidence Score of Age No

address Object Address No

value string Value of Address No

confidence number Confidence Score of No

Address

additionalDetails Object Additional details No

addressSplit Object Detailed Address No

building string Building of Voter holder No

city string City of Voter Holder No

district string District of Voter Holder No

pin string Pincode of Voter Holder No

floor string Floor of Voter Holder No

house string House Number of Voter No

Holder

locality string Locality of Voter Holder No

state string State of Voter Holder No

Attribute Type Description Required

street string Street of Voter Holder No

complex string Complex of Voter Holder No

landmark string Landmark of Voter Holder No

untagged string Untagged information of No

Voter Holder

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

tamperChecks Object To check whether the KYC No

card shared is tampered or
not

score number Displays the score against No

the tamper check
performed

tamperRisk string Risk Category [High, No

Medium, Low, Not
Detected]

status string Status of the check No

performed [SUCCESS,
FAILURE]

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "8c49e926-1f4d-4465-93e3-df0af9137337",
"result": {
"documents": [
{
"documentType": "VOTER",
"subType": "BACK_NEW",
"pageNo": 1,
"ocrData": {
"voterId": {
"value": "",
"confidence": 0
},
"gender": {
"value": "",
"confidence": 0.59
},
"lastUpdatedDate": {
"value": "",
"confidence": 0
},
"dob": {
"value": "",
"confidence": 0
},
"age": {
"value": "33",
"confidence": 1
},
"address": {
"value": "",
"confidence": 0.71
}
},
"additionalDetails": {
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",
"street": "",
"complex": "",
"landmark": "",
"untagged": ""
}
},
"qualityChecks": [
{
"score": 0.71,

Headers

Content-Type : "application/json"


Response (Passport Back)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

Attribute Type Description Required

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

father Object Name of Father of the No

passport holder

value string Value of Father's Name No

confidence number Confidence Score of No

Father's Name

fileNumber Object File Number No

value string Value of File Number No

confidence number Confidence Score of File No

Number

mother Object Name of Mother of the No

passport holder

value string Value of Mother's Name No

confidence number Confidence Score of No

Mother's Name

oldDoi Object Old Passport Date of Issue No

value string Value of Old Passport Date No

Of Issue

confidence number Confidence Score of Old No

Passport Date Of Issue

oldPassportNumber Object Old Passport Number No

value string Value of Old Passport No

Number

confidence number Confidence Score of Old No

Passport Number

oldPlaceOfIssue Object Old Passport Place of Issue No

value string Value of Old Passport Place No

of Issue

confidence number Confidence Score of Old No

Passport Place of Issue

passportNumber Object Passport Number No

value string Value of Passport Number No

Attribute Type Description Required

confidence number Confidence Score of No

Passport Number

pin Object PIN code of the registered No

address

value string Value of Pincode No

confidence number Confidence Score of No

Pincode

spouse Object Name of Spouse of the No

passport holder

value string Value of Spouse Name No

confidence number Confidence Score of No

Spouse Name

address Object Address No

value string Value of Address No

confidence number Confidence Score of No

Address

additionalDetails Object Additional details No

addressSplit Object Detailed Address No

building string Building of Passport holder No

city string City of Passport Holder No

district string District of Passport Holder No

pin string Pincode of Passport Holder No

floor string Floor of Passport Holder No

house string House Number of Passport No

Holder

locality string Locality of Passport Holder No

state string State of Passport Holder No

street string Street of Passport Holder No

complex string Complex of Passport No

Holder

landmark string Landmark of Passport No

Holder

untagged string Untagged information of No

Passport Holder

qualityChecks Array Quality attributes for the No

input file

Attribute Type Description Required

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "d0075247-8668-4867-aee0-6a89b2e5a988",
"result": {
"documents": [
{
"documentType": "PASSPORT",
"subType": "BACK",
"pageNo": 1,
"ocrData": {
"father": {
"value": "",
"confidence": 0.99
},
"fileNumber": {
"value": "",
"confidence": 1
},
"mother": {
"value": "",
"confidence": 0.95
},
"oldDoi": {
"value": "",
"confidence": 0
},
"oldPassportNumber": {
"value": "",
"confidence": 0
},
"oldPlaceOfIssue": {
"value": "",
"confidence": 0
},
"passportNumber": {
"value": "",
"confidence": 0.95
},
"pin": {
"value": "",
"confidence": 0.8
},
"spouse": {
"value": "",
"confidence": 0
},
"address": {
"value": "",
"confidence": 0.95
}
},
"additionalDetails": {
"addressSplit": {
"building": "",

Headers


Content-Type : "application/json"

Response (Passport Front)

Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details No

documentType string Document type No

subType string Document subtype No

pageNo number Page number on which the No

document is detected

ocrData Object OCR data No

countryCode Object Country of Issue of the No

passport

value string Value of Country of Issue No

confidence number Confidence Score of No

Country of Issue

dob Object Date of Birth of Passport No

Holder

value string Value of Date of Birth No

confidence number Confidence Score of Date No

of Birth

doe Object Date of Expiry of the No

passport

value string Value of Date of Expiry No

confidence number Confidence Score of Date No

of Expiry

doi Object Date of Issue No

value string Value of Date of Issue No

confidence number Confidence Score of Date No

of Issue

gender Object Gender of the passport No

holder

value string Value of Gender No

confidence number Confidence Score of No

Gender

Attribute Type Description Required

givenName Object First and Middle Name of No

the passport holder

value string Value of First and Middle No

Name

confidence number Confidence Score of First No

and Middle Name

nationality Object Nationality of the passport No

holder

value string Value of Nationality No

confidence number Confidence Score of No

Nationality

passportNumber Object Passport Number No

value string Value of Passport Number No

confidence number Confidence Score of No

Passport Number

placeOfBirth Object Place of Birth of the No

passport holder

value string Value of Place of Birth No

confidence number Confidence Score of Place No

of Birth

placeOfIssue Object Place of issue of the No

passport

value string Value of Place of Issue No

confidence number Confidence Score of Place No

of Issue

surname Object Surname of the passport No

holder

value string Value of Surname No

confidence number Confidence Score of No

Surname

type Object Passport Type No

value string Value of Passport Type No

confidence number Confidence Score of No

Passport Type

mrzLine1 Object Line 1 of MRZ Code No

value string Value of Line 1 of MRZ No

Code

Attribute Type Description Required

confidence number Confidence Score of MRZ No

Line 1

mrzLine2 Object Line 2 of MRZ Code No

value string Value of Line 2 of MRZ No

Code

confidence number Confidence Score of MRZ No

Line 2

additionalDetails Object Additional details No

qualityChecks Array Quality attributes for the No

input file

score number Displays the score against No

the quality check
performed

flag boolean Displays the response of No

the quality check
performed

type string Quality check type No

documentLink string URL to the masked No

Aadhaar image

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "4f51e788-9cf6-467d-9280-e63832b99e4d",
"result": {
"documents": [
{
"documentType": "PASSPORT",
"subType": "FRONT",
"pageNo": 1,
"ocrData": {
"countryCode": {
"value": "IND",
"confidence": 0.98
},
"dob": {
"value": "",
"confidence": 0.9
},
"doe": {
"value": "",
"confidence": 0.9
},
"doi": {
"value": "",
"confidence": 0.9
},
"gender": {
"value": "",
"confidence": 0.92
},
"givenName": {
"value": "",
"confidence": 0.98
},
"nationality": {
"value": "INDIAN",
"confidence": 0.8
},
"passportNumber": {
"value": "",
"confidence": 0.99
},
"placeOfBirth": {
"value": "",
"confidence": 0.96
},
"placeOfIssue": {
"value": "",
"confidence": 0.61
},
"surname": {
"value": "",
"confidence": 0.98
},

Headers


Content-Type : "application/json"

Response (DL)
Schema

Attribute Type Description Required

statusCode integer Internal Status Code that Yes

denotes the status of the
request

requestId string Unique id of the API Yes

request

result Object Response object for the Yes

given inputs

documents Array Document details Yes

documentType string Document type No

subType string Document subtype No

pageNo string Page number on which the No

document is detected

ocrData Object OCR Data No

dlNo Object Driving License Number No

value string Value of Driving License No

Number

confidence float Confidence Score of No

Driving License Number

name Object Name of the Driving No

License Holder as per the
Card

value string Value of License Holder No

Name

confidence float Confidence Score of No

License Holder Name

dob Object Date of Birth of the Driving No

License holder as per the
card

value string Value of Date of Birth No

confidence float Confidence Score of Date No

of Birth

doi Object Date of Issue No

value string Value of Date of Issue No

confidence float Confidence Score of Date No

of Issue

doe Object Date of Expiry No

value string Value of Date of Expiry No

Attribute Type Description Required

confidence float Confidence Score of Date No

of Expiry

relationName Object Care of details of Driving No

License holder

value string Value of Relation Name No

confidence float Confidence Score of No

Relation Name

address Object Address printed on Driving No

License

value string Value of Address No

confidence float Confidence Score of No

Address

pin Object Pin code of Driving License No

holder

value string Value of Pin Code No

confidence float Confidence Score of Pin No

Code

additionalDetails Object Additional details No

faceDetected boolean Whether the face was No

detected in the input file

addressSplit Object Detailed Address No

building string Building of License holder No

city string City of License holder No

district string District of License holder No

pin string Pin of License holder No

floor string Floor of License holder No

house string House Number of License No

holder

locality string Locality of License holder No

state string State of License holder No

street string Street of License holder No

complex string Complex of License holder No

landmark string Landmark of License No

holder

untagged string Untagged information of No

License holder

Attribute Type Description Required

clientData Object Data of the user sharing Yes

consent

caseId string Unique case id/lead id of Yes

the user sharing consent

Body


{
"requestId": "014b9c92-2388-4c6b-88b9-b7895db039a4",
"result": {
"documents": [
{
"documentType": "DL",
"subType": "",
"pageNo": null,
"ocrData": {
"dlNo": {
"value": "",
"confidence": 0.79
},
"name": {
"value": "",
"confidence": 0.91
},
"dob": {
"value": "05-01-1995",
"confidence": 0.68
},
"doi": {
"value": "13-01-2015",
"confidence": 0.66
},
"doe": {
"value": "12-01-2035",
"confidence": 0.88
},
"relationName": {
"value": "",
"confidence": 0.91
},
"address": {
"value": "",
"confidence": 0.91
},
"pin": {
"value": "",
"confidence": 0.77
}
},
"additionalDetails": {
"faceDetected": true,
"addressSplit": {
"building": "",
"city": "",
"district": "",
"pin": "",
"floor": "",
"house": "",
"locality": "",
"state": "",

Headers

Content-Type : "application/json"


https://api.totalkyc.com/documentation?printEnable=true&api=kocrPlus_kocr_kycocr&selectedDropdownVersion=kocrPlus 70/70

EFRIS API Documentation
75% (4)
EFRIS API Documentation
111 pages
EFRIS API Documentation
100% (3)
EFRIS API Documentation
124 pages
CSEC Information Technology June 2017 P02 Solution
No ratings yet
CSEC Information Technology June 2017 P02 Solution
19 pages
Mastering Databricks Lakehouse Platform: Perform Data Warehousing, Data Engineering, Machine Learning, DevOps, and BI into a Single Platform (English Edition)
From Everand
Mastering Databricks Lakehouse Platform: Perform Data Warehousing, Data Engineering, Machine Learning, DevOps, and BI into a Single Platform (English Edition)
Sagar Lad
1/5 (1)
CAMS KRA Web Services v3 - 8
No ratings yet
CAMS KRA Web Services v3 - 8
46 pages
Aadhaar Masking API Documentation
No ratings yet
Aadhaar Masking API Documentation
6 pages
Aadhaar Ekyc Api 2 5
No ratings yet
Aadhaar Ekyc Api 2 5
16 pages
Aadhaar Ekyc Api 2 0
No ratings yet
Aadhaar Ekyc Api 2 0
16 pages
Digitap CKYC API Suite - API
No ratings yet
Digitap CKYC API Suite - API
20 pages
ZLD Makes Fool
No ratings yet
ZLD Makes Fool
16 pages
Requester-MeriPehchaan-APISpecification-V2_3
No ratings yet
Requester-MeriPehchaan-APISpecification-V2_3
40 pages
Digital Locker Authorized Partner API Specification v1.11
No ratings yet
Digital Locker Authorized Partner API Specification v1.11
44 pages
SubAUA Portal Application - Web based Integration document V1.1.
No ratings yet
SubAUA Portal Application - Web based Integration document V1.1.
7 pages
Digital Locker Authorized Partner API Specification v2.0
No ratings yet
Digital Locker Authorized Partner API Specification v2.0
40 pages
Interface Design
No ratings yet
Interface Design
220 pages
Aadhaar Kyc API 1 0 Final
No ratings yet
Aadhaar Kyc API 1 0 Final
16 pages
User_manulal_QR_Code_15032019
No ratings yet
User_manulal_QR_Code_15032019
8 pages
Ocr Datasheet 01
No ratings yet
Ocr Datasheet 01
4 pages
API Study
No ratings yet
API Study
7 pages
API Ac017 Ekyc Service v1.2
No ratings yet
API Ac017 Ekyc Service v1.2
10 pages
3
No ratings yet
3
3 pages
Odoo FastAPI Tutorial
No ratings yet
Odoo FastAPI Tutorial
2 pages
Aadhaar Authentication Api 2 5
No ratings yet
Aadhaar Authentication Api 2 5
33 pages
Aadhaar Authentication Api 2 5
No ratings yet
Aadhaar Authentication Api 2 5
33 pages
You Said:: Advanced Automation Certification - 2024
No ratings yet
You Said:: Advanced Automation Certification - 2024
40 pages
API Prefill
No ratings yet
API Prefill
13 pages
graph
No ratings yet
graph
2 pages
Digitap KYC & Asset Validation API Suite - API Doc - v1.73 - 29feb2024
No ratings yet
Digitap KYC & Asset Validation API Suite - API Doc - v1.73 - 29feb2024
78 pages
Uidai: Aadhaar Authentication
No ratings yet
Uidai: Aadhaar Authentication
33 pages
Automate The Scanning and Processing: of Your Documents and Data
No ratings yet
Automate The Scanning and Processing: of Your Documents and Data
6 pages
Annexure II Linkage Status of Acc No API Specification V 1 0
No ratings yet
Annexure II Linkage Status of Acc No API Specification V 1 0
27 pages
Assessment 5
No ratings yet
Assessment 5
12 pages
SmartOfficeAPIDocumentation
No ratings yet
SmartOfficeAPIDocumentation
16 pages
Aadhaar E-KYC Basics
No ratings yet
Aadhaar E-KYC Basics
9 pages
upload
No ratings yet
upload
6 pages
E SDC To TaxCore - Api
No ratings yet
E SDC To TaxCore - Api
8 pages
API_AddClientFlow_v1.1
No ratings yet
API_AddClientFlow_v1.1
31 pages
Mastering MongoDB 4.x - Second Edition: Expert techniques to run high-volume and fault-tolerant database solutions using MongoDB 4.x, 2nd Edition
From Everand
Mastering MongoDB 4.x - Second Edition: Expert techniques to run high-volume and fault-tolerant database solutions using MongoDB 4.x, 2nd Edition
Alex Giamas
No ratings yet
FlexiCapture Product Brochure en
No ratings yet
FlexiCapture Product Brochure en
5 pages
Aadhar Compliance Checklist
100% (1)
Aadhar Compliance Checklist
8 pages
SWQTestReport ManageKey DKS
No ratings yet
SWQTestReport ManageKey DKS
45 pages
API Doc XeroxBot STAAR
No ratings yet
API Doc XeroxBot STAAR
9 pages
Technical Design Document TD - PO039I - OCR Contract and PO Interface
No ratings yet
Technical Design Document TD - PO039I - OCR Contract and PO Interface
22 pages
Patient Records API
No ratings yet
Patient Records API
15 pages
V2 - Understanding Document - KYC and ECS Details
No ratings yet
V2 - Understanding Document - KYC and ECS Details
2 pages
API_Signing_Steps_V1.3_Aug 2023
No ratings yet
API_Signing_Steps_V1.3_Aug 2023
5 pages
LNP
No ratings yet
LNP
60 pages
KYX Guide
No ratings yet
KYX Guide
53 pages
Ocr Api
No ratings yet
Ocr Api
10 pages
Veri5 APIs Brochure - Veri5Digital (Khosla Labs)
No ratings yet
Veri5 APIs Brochure - Veri5Digital (Khosla Labs)
1 page
Data Processing and Modeling with Hadoop: Mastering Hadoop Ecosystem Including ETL, Data Vault, DMBok, GDPR, and Various Data-Centric Tools
From Everand
Data Processing and Modeling with Hadoop: Mastering Hadoop Ecosystem Including ETL, Data Vault, DMBok, GDPR, and Various Data-Centric Tools
Vinicius Aquino do Vale
No ratings yet
Updated Code
No ratings yet
Updated Code
7 pages
Heisenberg
No ratings yet
Heisenberg
6 pages
KB CertificateManagementandCashDepositAPI 071124 1539
No ratings yet
KB CertificateManagementandCashDepositAPI 071124 1539
8 pages
Python In - Depth: Use Python Programming Features, Techniques, and Modules to Solve Everyday Problems
From Everand
Python In - Depth: Use Python Programming Features, Techniques, and Modules to Solve Everyday Problems
Ahidjo Ayeva
No ratings yet
Get Status 27112021
No ratings yet
Get Status 27112021
14 pages
Pig Design Patterns
From Everand
Pig Design Patterns
Pradeep Pasupuleti
No ratings yet
1698
No ratings yet
1698
6 pages
Data Extraction From Hand Filled Forms Using Ocr
No ratings yet
Data Extraction From Hand Filled Forms Using Ocr
18 pages
SandBox NoteBook.ipynb
No ratings yet
SandBox NoteBook.ipynb
11 pages
CC NEW FULL.anom
100% (2)
CC NEW FULL.anom
4 pages
Chapter 6. Order Picking Methods
No ratings yet
Chapter 6. Order Picking Methods
16 pages
2d and 3d Scanner
No ratings yet
2d and 3d Scanner
18 pages
Pe6300vet Manual
No ratings yet
Pe6300vet Manual
87 pages
Wasp Labeler User Manual
No ratings yet
Wasp Labeler User Manual
209 pages
Haramaya University: College of Computing and Informatics Department of Computer Science
No ratings yet
Haramaya University: College of Computing and Informatics Department of Computer Science
54 pages
Ntuc
No ratings yet
Ntuc
28 pages
Capstone Title With Objectives
No ratings yet
Capstone Title With Objectives
3 pages
Cm100 User Manual June 19
No ratings yet
Cm100 User Manual June 19
96 pages
Andi's Snack Break Payroll System SRS
No ratings yet
Andi's Snack Break Payroll System SRS
12 pages
RM XPR Microbalances en Reference Manual
No ratings yet
RM XPR Microbalances en Reference Manual
158 pages
ZPL Zbi2 PM en 28 394
No ratings yet
ZPL Zbi2 PM en 28 394
367 pages
RLS Series-User Manual (RT V1.0) - US
No ratings yet
RLS Series-User Manual (RT V1.0) - US
26 pages
PDFCatalogEn GOT2000
No ratings yet
PDFCatalogEn GOT2000
136 pages
IT4600 User Guide (Rev A)
No ratings yet
IT4600 User Guide (Rev A)
224 pages
Ink-Jet Printer TEC2702ZAC CCS-R Manual
0% (1)
Ink-Jet Printer TEC2702ZAC CCS-R Manual
251 pages
CI Barcode
No ratings yet
CI Barcode
22 pages
Store Manager - User Manual - v3 Impresora Adhesivos Pequeños Bodega
No ratings yet
Store Manager - User Manual - v3 Impresora Adhesivos Pequeños Bodega
17 pages
rs6100 PRG en
No ratings yet
rs6100 PRG en
317 pages
C72 Datasheet (Malaysia)
No ratings yet
C72 Datasheet (Malaysia)
2 pages
Code Guideline
No ratings yet
Code Guideline
2 pages
QR Documentation
100% (3)
QR Documentation
26 pages
QR Code
No ratings yet
QR Code
9 pages
Connecting To Zebra Scanners
No ratings yet
Connecting To Zebra Scanners
9 pages
Datasheet LG710 BT
No ratings yet
Datasheet LG710 BT
2 pages
1.1.2-Hexadecimal ANSWERS
No ratings yet
1.1.2-Hexadecimal ANSWERS
25 pages
Final Paper
No ratings yet
Final Paper
7 pages
Reader - Configuration - Codes For DATAMAN Cognex
No ratings yet
Reader - Configuration - Codes For DATAMAN Cognex
56 pages
RFID Whitepaper-Updated OBoyle
No ratings yet
RFID Whitepaper-Updated OBoyle
5 pages
HK Disneyland
No ratings yet
HK Disneyland
6 pages