Sign in

v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB
Identity Verification

Verify International Passport

Verify an international passport and retrieve the identity details attached to the passport number.

post/api/v1/merchant/documents/international-passport

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

passport_numberstring required

International passport number

Example request

{
  "passport_number": "A12345678"
}

Response

International passport verification response

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "International passport verification completed successfully",
  "data": {
    "first_name": "John",
    "middle_name": "Adebayo",
    "last_name": "Doe",
    "gender": "MALE",
    "birth_date": "1992-08-14",
    "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "passport_number": "A12345678",
    "issue_date": "2021-03-10",
    "expiry_date": "2031-03-09",
    "nationality": "Nigerian"
  },
  "charges": {
    "charged_amount": "0.00"
  }
}