US Passport Extraction

7 min

Introduction

The passport extraction API utilizes OCR technology to extract information from scanned or photographed passport. It analyzes the image, recognizes the text, and retrieves relevant data such as name, date of birth, date of issue etc. The API returns the extracted data in a structured format, enabling automated processes like identity verification and form population.

API Input Guidelines

You need to pass the URL of the document you need to scan in the input. To do this, you can use Signzy's File exchanger APIs and create a link.

Sample Curl

curl --location 'https://api.signzy.app/api/v3/us/extraction/passport' \
--header 'Authorization: <Auth Token>' \
--header 'Content-type: application/json' \
--data-raw '{   
    "url": "https://preproduction-persist.signzy.tech/api/files/38025413/download/e27d59a574a5440e9c08d68a3a7296a6171a7ea240ec44edb81a454aa8dab349.jpg"
}'

Input Parameters

Parameter	Type	REQUIRED/OPTIONAL
url	string	The URL of the passport whose information needs to be extracted

Sample Response

[
    {
        "type": "MRZ Code",
        "value": "P<USADoe<<Jhhn<<<<<<<<<<<<<<<<<<<<<<<<<<<\n670122536USA2104153F261004753123124717<424858",
        "confidence": 0.9900000095367432
    },
    {
        "type": "Portrait",
        "value": "",
        "confidence": 0.8359375
    },
    {
        "type": "Date Of Birth",
        "value": "15 Apr 1982",
        "confidence": 0.997175931930542
    },
    {
        "type": "Document Id",
        "value": "670012243",
        "confidence": 0.9996330142021179
    },
    {
        "type": "Expiration Date",
        "value": "04 Oct 2029",
        "confidence": 0.9989709854125977
    },
    {
        "type": "Family Name",
        "value": "Doe",
        "confidence": 0.9996419548988342
    },
    {
        "type": "Given Names",
        "value": "John",
        "confidence": 0.9998021125793457
    },
    {
        "type": "Issue Date",
        "value": "05 Oct 2018",
        "confidence": 0.998504638671875
    }
]

Response Parameters

Parameter Name	Description
type	It can be the following types - 1. MRZ Code 2. Portrait 3. Date of Birth 4. Document ID 5. Expiration Date 6. Family Name 7. Given Name 8. Issue Date
value	The value corresponding to Name, Address, DOB, etc.
confidence	The numerical value between 0 and 1, which indicates the level of certainty.

Stat Codes

CODE	MESSAGE
200	Success
401	Kindly check authorization
422	File url is not valid
500	Internal error at Signzy, contact Signzy support

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].