vSure Visa Checks API v2

vSure visa check API

Brand banner

Visa Check Lifecycle

Visa checks happen asynchronously to your API calls, which means you'll need to check the status of a check before acting on any data returned from the API.

Simple Sequence

The following sequence diagram shows the overall steps involved in performing a visa check.

visa_check_sequence.png

Visa Check Statuses

It's important you check the status of your visa check. A visa check can be in one of the following states:

  • pending: Most common for newly created checks, and no result is available yet.
  • completed: A visa check was returned successfully; Important: It does not mean the document/visa is 'valid'. Check the visa attribute for further detail.
  • failed: A visa check could not be returned successfully.
  • expired: The visa check was previously attempted and PII has since been removed by vSure's data retention policy.
  • purged: The visa check was previously attempted and PII has since been removed by the API