Passport

Extract passport details

Good to know: This API method allows you to extract the details from an international passport as JSON.

Extract passport details

POST https://api.usetani.com/api/v0/passport_analyze

Creates a new person.

Headers

Name	Type	Description
x-api-key*	string	Your API key
x-group-id*	string	Your group ID from the dashboard.

Request Body

Name	Type	Description
image*	string	Form-data image of the passport

200 Passport analyzed successfully

{
    "message":"Data extracted successfully",
    "result": {
        "passport_number": "string",
        "date_of_birth": "string",
        "date_of_expiry": "string",
        "surname": "string",
        "given_names": "string",
    }
}

401 Unauthorized

{
    "detail": "API key/Group Id is missing"
}

500: Internal Server Error Server error

{
    // Response
}

400: Bad Request No passport recognized

{
    detail: "Could not extract data from image, please confirm that the image is a passport."
}