Check Upload Passport V2

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint returns the result of the last Upload Passport V2 scan for the user.

After the upload returns a 202, call this endpoint every few seconds until result is no longer in_progress. You can also wait for the GOVT_ID_SCAN_STATUS_UPDATE webhook instead, which has the same fields as this response. Details on the webhook can be checked here.

🚧

Rate limit

This endpoint can be called up to 20 times a minute for a user, which is one call every 3 seconds. Any more calls will get a 429.

Responses

StatusResponseMeaning
200result: "in_progress"The scan is still running. Call again after a few seconds.
200verified: trueThe passport passed. result is complete.
200verified: falseThe passport did not pass. result and errorCode tell you why. The user can upload a new photo and try again.
400-No document has been uploaded for this user, or userAccessCode is missing or doesn't match any user from your company.
401-The API key is invalid, or consent is not recorded for the user.
403-The user is marked as deceased.
429-Too many calls for this user. Wait and try again.
503result: "error"The scan could not be completed (USER_DOCUMENT_SCAN_UNAVAILABLE). This is not a failed passport, so there is no verified field. Upload the passport again.

Not Verified Results

When verified is false, result and errorCode will have one of the following values. errorMessage can be shown to the user as it is.

resulterrorCodeerrorMessage
failedUSER_GOVT_ID_VERIFICATION_FAILEDDocument verification failed. Please try again.
restricted_doc_typeUSER_RESTRICTED_DOC_TYPEThis document type is not accepted for verification. Please upload an allowed document type.
id_expiredUSER_GOVT_ID_DOCUMENT_EXPIREDThe document provided has expired.
authenticity_check_failedUSER_GOVT_ID_AUTHENTICITY_CHECK_FAILEDWe couldn't confirm the security features on your ID. Please photograph the original document in good light.
document_liveness_failedUSER_GOVT_ID_DOCUMENT_LIVENESS_FAILEDWe couldn't verify this ID. Please photograph the original document directly, in even light without glare or reflections.
capture_quality_failedUSER_GOVT_ID_CAPTURE_QUALITY_FAILEDWe couldn't clearly read part of your document. Please retake the photo with better lighting and try again.
document_front_not_readableUSER_GOVT_ID_DOCUMENT_FRONT_NOT_READABLEWe couldn't read the front of your ID. Please capture the front of the card with the whole card in frame, in focus, and free of glare — then flip it over for the back.
document_data_mismatchUSER_GOVT_ID_DOCUMENT_DATA_MISMATCHThe details printed on the front of your ID don't match the barcode on the back. Please retake both sides of the same card, making sure each photo is sharp and fully in frame.
invalid_dobUSER_GOVT_ID_INVALID_DOBThe date of birth on the document could not be read correctly.
invalid_nameUSER_GOVT_ID_INVALID_NAMEThe name on the document could not be read correctly.
parsing_failedIDENTITY_DOCUMENT_NOT_PARSEDThe Passport could not be parsed. Please make sure all four sides are visible and the Passport is in front of a dark background.

Document Type

documentType is the type of document that was read. It is sent with both verified: true and verified: false results, but not when the document could not be read. Possible values are DRIVERS_LICENSE, IDENTIFICATION_CARD, RESIDENCE_DOCUMENT, MILITARY, VOTER_IDENTIFICATION, PERMIT, PASSPORT, VISA, or UNKNOWN when the type could not be identified.

Body Params
string
required
Responses

Language
Credentials
Bearer
API KEY
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json