# Concepts

# Identity Verification Flow

For a typical application, the flow for identifying and verifying a new user will be as follows:

  1. The Endpass Connect library is triggered by a Javascript method call or the user's click on a "Login With Endpass" button.
  2. The user is prompted to log in to their Endpass account in a new window. If the user does not have an Endpass account, they will be able to create one without leaving your application.
  3. The user is shown a permissions dialog to approve access to the scopes requested by your application.
  4. The user is prompted to upload any additional documents needed to verify additional scopes.
  5. The user's documents are instantly verified by the Endpass backend.
  6. The Endpass Connect Javascript library returns a Promise with the data requested.
  7. Your server-side application retrieves additional user information, like document data and verification status.

# Scopes

Scopes represent the information you are requesting from a user. Scopes defined in application, on creation step.

When the user clicks the "Login With Endpass" button, a permissions dialog with the requested scopes will be shown to the user.

Try to request the minimal number of scopes required for your application. Users are more likely to agree to a smaller set of permissions.

# List of Scopes

Scope Description
user:email:read see user's email address
user:address:read see user's mailing address
user:phone:read see user's phone number
documents:passport:status:read allows see status of all users documents with type Passport
documents:passport:data:read allows see data from users documents with type Passport
documents:passport:image:read allows see images users documents with type Passport
documents:proof_address:status:read allows see status of all users documents with type Proof of Address
documents:proof_address:data:read allows see data from users documents with type Proof of Address
documents:proof_address:image:read allows see images users documents with type Proof of Address
documents:driver_license:status:read allows see status of all users documents with type Driver License
documents:driver_license:data:read allows see data from users documents with type Driver License
documents:driver_license:image:read allows see images users documents with type Driver License
documents:id_card:status:read allows see status of all users documents with type ID Card
documents:id_card:data:read allows see data from users documents with type ID Card
documents:id_card:image:read allows see images users documents with type ID Card

Most applications will only need the documents:status:read scope to get document verification status without requesting the actual documents.

# Documents

Documents represent the identity documents submitted by the user. After a document is submitted, it is automatically verified by Endpass AI technology. You do not need to verify that a document is valid if it has the "Verified" status.