API Reference
šŸ“œ Knowledge BasešŸ™‹ā€ā™‚ļø Raise Support Ticket

Govt. ID

Ensure the authenticity of user identity by validating official government issued identification documents.

The Government ID Verification API suite provides robust tools for identity validation through advanced OCR technology and barcode analysis. With endpoints like Upload ID and Upload Document Enhanced, the system captures and verifies alphanumeric data from both sides of an ID, ensuring compliance with AAMVA standards.

Enhanced checks include a manual review for difficult-to-parse IDs due to wear, delivering results typically within five minutes. Webhook integration is available for real-time updates.

Developers must know variable processing times and higher costs for enhanced services. This comprehensive approach ensures thorough ID verification for subsequent background checks and identity confirmations.

This contains the following endpoints:

  1. Upload ID Captures data from both the front and back of an ID, utilizing OCR to extract alphanumeric text from the front and validating barcode data from the back against AAMVA standards. Required inputs include images in JPEG or PNG format, a country code, and a userAccessCode. Images must be submitted as two base64 encoded strings labeled idFront and idBack.
  2. Upload Document Enhanced: For IDs impacted by wear and tear, this endpoint automatically routes to a manual review if automated processes fail, where a forensic expert determines the validity of the ID. This endpoint notifies users when the review is complete, typically in less than five minutes, and requires a country code. It supports JPG, JPEG, and PNG formats only and incurs a higher usage cost.
  3. Check Upload ID: Allows users to check the status of document processing. It helps identify if an imageā€™s quality issues, such as blur or poor lighting, have hindered processing. This function is crucial for determining when re-submission is necessary.
  4. Verify Upload ID Confirms that the data retrieved from a scanned document matches an actual person. This step is crucial for completing ID verification before conducting further background checks. If verification fails due to mismatching data in public records, users are prompted to provide a previous address or, if necessary, use SSN tracing for identity verification. This endpoint also ensures that the name on the ID matches the user's registered full name, integrating data from scanned IDs with user profiles to facilitate verification.