Passport

Our API supports asynchronous processes for scanning and parsing passport data, including an optional manual review for documents that are worn or unclear. Please upload clear images with minimal glare and sufficient lighting to ensure accurate data extraction.

Endpoints Overview:

1. Upload Passport This endpoint is designed to upload a clear passport image for scanning and parsing the user’s information page. The image must be clear, well-lit, and glare-free to facilitate accurate data extraction. This is an asynchronous call, and the data will be returned upon triggering the Get Test Result. The Check Upload Passport endpoint should be utilized to monitor the progress and completeness of the upload.

2. Upload Passport Enhanced (Review Passport) Similar to the Upload Passport endpoint, this function allows for the upload of a passport or visa image for scanning and parsing. Additionally, if the document is worn and cannot be parsed, it is automatically sent for manual review by a forensic expert, with completion notifications typically sent within 5 minutes. This endpoint requires the countryCode parameter in ISO 3166-1 alpha-2 format. Like the basic upload, this is also an asynchronous call with results available via Get Test Result, and progress can be tracked using Check Upload Passport.

3. Check Upload Passport: This endpoint verifies whether the asynchronous upload process of the passport has been completed. It is particularly useful for developers who require immediate updates on the processing status, especially if image quality issues might necessitate a re-upload.

4. Verify Upload Passport: This endpoint ensures that the data extracted from the scanned passport matches an actual person identifiable across multiple authoritative databases, including US government, credit, and DMV records. For this verification to proceed, ID verification must be fully completed. This call also verifies data consistency by ensuring that the name on the passport matches the full name in the User Object. If discrepancies are found, they must be addressed using the Update User method before proceeding. Only JPG, JPEG, and PNG image formats are accepted; PDFs and other image formats are not supported.

📘

Before you begin

Before integrating the Upload ID and Upload Passport APIs, consider whether your application can guide users in taking high-quality document photos. Poor image capture can significantly impact verification accuracy and lead to higher failure rates.

In most cases, we strongly recommend using Medallion™, our fully hosted identity verification solution, instead of directly integrating the APIs. Medallion™ provides built-in auto-image capture with real-time quality checks, ensuring that document images meet verification standards before submission. Additionally, Medallion™ includes advanced forensic analysis, barcode validation, biometric facial comparison, passive liveness detection, and fallback verification methods—capabilities that may require complex implementation when using raw API endpoints.

If you’re unsure whether to use Medallion™ or direct API uploads, please contact support for assistance in selecting the best verification flow for your use case.