KwikID DocumentationAPI SuitePassport Verification
V3
Performs Passport validity and details verification via KwikID.
Passport Verification (V3)
API reference
Try itLoading playground…
Loading…
AuthorizationBearer <token>
JWT Bearer token authentication. Obtain a token from the KwikID dashboard.
In: header
fileNumberstring
Passport application file number.
dobstring
Date of birth (DD/MM/YYYY).
clientData?object
Custom metadata to associate with the request.
Empty Object
Response Body
curl -X POST "https://__playground__/verification/v3/passport_verification/verify" \ -H "Content-Type: application/json" \ -d '{ "fileNumber": "MU1234567890123", "dob": "15/01/1990" }'{
"success": true,
"status_code": 200,
"provider": "KwikID",
"api_name": "Passport Verification",
"data": {
"requestId": "b091841e-c6f3-48b2-9c10-9c62f43f3f45",
"result": {
"name": {
"nameFromPassport": "OMKAR MILIND",
"surnameFromPassport": "SHIRHATTI",
"nameMatch": true,
"nameScore": 1
},
"passportNumber": {
"passportNumberFromSource": "S373XXXX",
"passportNumberMatch": true
},
"dateOfIssue": {
"dispatchedOnFromSource": "14/05/2018",
"dateOfIssueMatch": true
},
"typeOfApplication": "Tatkaal",
"applicationDate": "14/05/2018"
},
"statusCode": 101
}
}{
"detail": {},
"message": "string"
}{
"error": "string"
}Overview
Call POST /verification/v3/passport_verification/verify from your backend to verify Passport application status and holder name details using the file number.
Key features
- Verification details: Confirms match status for passport number, name, and dispatch/issue dates.
- Support fields: Displays application types (e.g. Normal or Tatkaal) and date of application.
Implementation
Step 1: Call from your backend
POST /verification/v3/passport_verification/verify HTTP/1.1
Host: <verification-api-base-url>
Authorization: Bearer <token>
Content-Type: application/json
{
"fileNumber": "MU1234567890123",
"dob": "15/01/1990"
}Step 2: Use the response
On success (200 OK), the response returns verification details:
{
"success": true,
"status_code": 200,
"provider": "KwikID",
"api_name": "Passport Verification",
"data": {
"requestId": "b091841e-c6f3-48b2-9c10-9c62f43f3f45",
"result": {
"name": {
"nameFromPassport": "OMKAR MILIND",
"surnameFromPassport": "SHIRHATTI",
"nameMatch": true,
"nameScore": 1
},
"passportNumber": {
"passportNumberFromSource": "S373XXXX",
"passportNumberMatch": true
},
"dateOfIssue": {
"dispatchedOnFromSource": "14/05/2018",
"dateOfIssueMatch": true
},
"typeOfApplication": "Tatkaal",
"applicationDate": "14/05/2018"
},
"statusCode": 101
}
}