Upload ID

Upload front and back of the government issued photo ID for verification.

This is used to capture data from an ID and, if determined to be a valid ID, auto-fill forms. The alphanumeric text in the image of the front of the Photo ID is captured through an OCR scan which is then compared to and corrected with the data extracted from a scan of the barcode in the image of the back of the Photo ID. This includes a barcode template check to ensure it meets AAMVA standards.

Note that the endpoint receives two base64 encoded Strings as the images and the country code integer along with the userAccessCode. The images should be of the format JPEG or PNG only.

The correct implementation is to capture an image of the front of the photo ID (generally the front of the photo ID contains the userā€™s photo and personally identifying information) and submit the captured image taken as the 'idFrontā€™ key and capturing an image of the back of the photo ID (generally the back of the photo ID contains a barcode, i.e. a PDF 417 barcode) and submitting it as the 'idBack' key.

The country param is required and has to be an integer. Country codes can be checked here.We support government issued IDs including driver's licenses, state IDs, national IDs, military IDs, voter cards, resident cards, visas, passports, border crossing cards, and government Personal Identity Verification (PIV), DoD Common Access Card and Transportation Worker Identification Credentials from this list of countries and territories. And we are always expanding our areas of service. If you dont see a region listed and are interested in learning more about how we can work with you, in that area, please let us know.For Android:- please note that this is a Post call and will likely be a lengthy one. There are multiple overloaded methods if you want to utilize your own progress or thread management, however it is recommended that you use the method that runs everything within an async task and manages the bitmap to base 64 string conversion on its own background thread. If you want to encode them yourself and send the Strings, the overloaded method will handle this.

Important Notes:

  1. This call does not return an indicator as to whether or not they actually passed the ID verification, this endpoint returns a success if the two images sent were successfully uploaded and saved to the database; the image processing runs asynchronously.
  2. You must ensure that the photos being uploaded are what the user intends to submit, as they will not be told of their success upon upload. We recommend creating a confirm popup with both images to ensure users understand the photos they are uploading.
  3. The maximum allowed size of the image uploaded (per image) is capped at 2MB. Please do not send in photos larger than 2MB, as an exception will be thrown. We recommend using the standard compression techniques to compress the photo before sending it to us, if needed.
  4. Capturing a clear, non-blurry image with the mobile device is extremely important so that the ID can be processed accurately.
  5. Make sure to use a minimum 5 5-megapixel camera to capture the images for UploadID.
  6. Make sure images are not blurry, well-focused and there is no glare, shadow, or holographic reflection on the images.
  7. Make sure that the ID and the background are contrasted and that the background is solid-colored.
  8. Make sure all the edges of the ID are visible and no edge is getting cut off. To see a sample ID image that needs to be submitted, please see here.
Click Try It! to start a request and see the response here!