📘
Deprecation Notice
The current version of this API will be deprecated and will no longer be supported after 01-01-2026.
All users and integrations should migrate to Verify Identity, which offers enhanced functionality, improved performance, and better security.

This is used to determine if the user data that has been retrieved from the document scanned (Upload ID matches an actual person).

This call is necessary to make sure that the ID verification is complete for that particular user. If this call is not completed, calls like Generate Criminal Background Report will throw an error indicating the ID verification has to be completed first.

If Check Upload ID is successful but Verify ID fails, you should provide a pop up to the user that says, "We were able to successfully scan your ID, however we cannot locate you in public record databases with the address on the ID. Please enter a previous address for identification only.

If Verify ID fails again after updating the User Object with the previous address, you should return a response stating, "You could not be verified with this address either. The only remaining option to automatically verify the identity on the document provided would be to trace an SSN. This data is used for identification only."

There is a data consistency check built into the Verify Upload ID that ensures the name on the ID matches the full name in the User Object. In instances where a user provides a different name than the name on the ID, you will not be able to Verify Upload ID. In instances where you wish to use the name on the ID instead of the name manually entered by the user, you should call the Get Test Result after Check Upload ID was successful and map the full name from the scannedUser parameters to the User Object using the Update User method. Then make the Verify Upload ID call before running any tests.