Headers
Request Body Parameters
Parameters | Parameter description with validations and examples | Data type | Mandatory/Optional |
fileNumber | Passport Number E.g-NG1064964059420 |
String | Mandatory |
dob | Date of Birth of the passportholder E.g. - 02/07/1995 |
Date | Mandatory |
Sample Request Body
Encrypted Sample Request Body
Response Body Parameters
Parameters | Parameter description with examples | Data type |
statusCode | Status code of the response | Integer |
status | Status message of the response | String |
statusDesc | Description of the status | string |
data | Contains the main response data | String |
result | Result of the API response | String |
fileNumber | Passport file number | String |
givenName | Applicant’s given name | String |
surname | Applicant’s surname | String |
typeOfApplication | Type of passport application (e.g., NORMAL) | String |
applicationReceivedOnDate | Date when the application was received | String |
name | Full name of the applicant | string |
dob | Date of birth of the applicant | string |
error | Name of the error (Only for FAILED) | String |
message | Error message (Only for FAILED) | string |
reason | Reason for Error (Only for FAILED) | String |
type | Type of error (Only for FAILED) | String |
value | The actual value that caused the error (Only for FAILED) | String |
path | The field in the request body where the error occurred (Only for FAILED) | String |
location | Location in the request where the issue was found (e.g., body) (Only for FAILED) | String |
Sample Response Body
SUCCESS:
FAILED:
Error from Passport Verification API:
FileNumber not Provided:
DOB not provided:
Invalid DOB provided:
Encrypted Sample Response Body
Status Codes
Code | Significance | Description |
0 | SUCCESS | Passport Verified Successfully |
1 | FAILED | Error from Passport Verification API Response !!!! |
-1 | INVALID REQUEST |
|