API Reference

Here you can find a list of the different endpoints available to use across the Digital Identity API. Click into each card to learn more.

Registration

📱 Validate Phone

Send an OTP to a phone number for verification. Essential for securing user identities.

📧 Validate Email

Send an OTP to an email address for verification. Ensures email authenticity.

📝 Create Account

Finalize registration by creating a new account after successful phone and email verification.

USER PROFILE

Change password

Enables the user to change their current password.

🔄 Forget Password

Enable users to reset their password, sending a reset link or OTP to their registered email.

✉️ Update User Email

Enable users to reset their password, sending a reset link or OTP to their registered email.

📱Update phone number

Users can change their registered phone number using their own credentials (access token).

The new number must be registered to their NID number.

✉️ Validate Email

In case the user skipped the Email verification in the registration.

Validate Digital Identity

🆔 National ID Front Side

To capture and analyze the front image of the National ID.

🆔 National ID Back Side

To capture and analyze the back image of the National ID.

📸 Liveness detection with three face images

Ensures that the person presenting the ID is physically present and matches the ID photo.

Login

🔑 User Login

Authenticate users by verifying their name, ID number, birthdate, and phone number against sanction lists and custom blacklists.

Business Request

📊 Business Eligibility Check

Determines if a user is eligible to create a new business request, ensuring they meet all required criteria.

📄 Current User Business Request

Retrieves the details of the current business request for the user, including request status and associated documents.

🏢 Retrieve Business Request Types

Fetches all available business request types that have been configured by the tenant admin through the Admin Portal.

📋 Business Request Fields

Retrieves all fields associated with a specific business request type, allowing for detailed customization when creating a new business request.

📝 Create Business Request

Initiates a new business request for a specified business request type, with validation of user contact details via OTP.

🚀 Activate Business Request

Validates user contact details via OTP and activates a business request, including handling payments and contract activation.

🚨 Error Codes

This section provides a comprehensive list of error codes that might be returned by the Digital Identity VLens API, along with their descriptions and potential resolutions. It is essential for debugging and handling API responses appropriately.