Skip to main content

​
Request

[GET]
{{baseURL}}/api/v1/kyc/passport
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>
​
AppId
string
required
Application ID from dashboard

​
Query parameter

ParameterTypeDescriptionRequired
passport_number*stringThe Passport Numberrequired
surname*stringSurname associated with the Passportrequired

​
Sample response

Response
{
    "entity": {
        "passport_number": "A00123456",
        "date_of_issue": "01/02/2000",
        "expiry_date": "01/02/2000",
        "document_type": "Standard Passport",
        "issue_place": "LAGOS",
        "surname": "JOHN",
        "first_name": "DOE",
        "other_names": "MOSES",
        "date_of_birth": "10/06/1993",
        "gender": "Undecided",
        "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBA..."
    }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the passport verification response data
entity.passport_numberstringPassport number that was verified
entity.date_of_issuestringDate the passport was issued (DD/MM/YYYY)
entity.expiry_datestringExpiry date of the passport (DD/MM/YYYY)
entity.document_typestringType of passport document (e.g., Standard Passport)
entity.issue_placestringLocation where the passport was issued
entity.surnamestringSurname of the passport holder
entity.first_namestringFirst name of the passport holder
entity.other_namesstringOther names (middle names) of the passport holder
entity.date_of_birthstringDate of birth of the passport holder (DD/MM/YYYY)
entity.genderstringGender of the passport holder
entity.photostringBase64-encoded photo of the passport holder

​
Test Credentials for Sandbox

Kindly use this Test Passport Number in sandbox Environment Passport Number = A00123456