API reference / KYC / Identity

Verify passport

Passport file number and date of birth checked against the passport record.

POST/v1/verify/passport
Authentication
Bearer token
Scope
kyc:verify

Request body

FieldTypeRequiredDescription
file_numberstringYesPassport file number, 10 to 20 letters and digits; spaces and hyphens are ignored.
dobstringYesDate of birth, a past date as YYYY-MM-DD, DD/MM/YYYY or DD-MM-YYYY.

Sample code

Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.

curl -sS -X POST 'https://grappi.ai/v1/verify/passport' \
  -H "Authorization: Bearer $GRAPPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file_number": "BO1065000012345",
  "dob": "1990-08-17"
}'

Sample response

{
  "request_id": "req_01HZY3K8M2",
  "result": {
    "file_number": "BO1065000012345",
    "name": "ASHA RAO",
    "given_name": "ASHA",
    "surname": "RAO",
    "dob": "17/08/1990",
    "type_of_application": "Fresh",
    "application_received_on_date": "02/01/2019"
  }
}

Response fields

FieldTypeDescription
file_numberstringThe file number that was checked.
namestringFull name on the passport record.
given_namestringGiven name on the passport record.
surnamestringSurname on the passport record.
dobstringDate of birth on the passport record.
type_of_applicationstringType of the passport application.
application_received_on_datestringDate the application was received.

Errors

Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.