Digital Identity
  • Introduction
  • Quick Start
  • Reference
    • API Reference
      • Register
      • User Profile
      • Verify
      • CancelVerifiedDigitalIdentity
      • Get Verify Data
      • Login
      • Admin Login
      • Check Eligibility
      • Current
      • Get All Product Types
      • Get Business Request Type Template Fields
      • User Create Request
      • User Activate Request
      • ⚙️ Admin Control Panel
        • Login API
        • GetRequests API
        • GetContractToPdf
        • GetUsers
        • GetTransactionById API
        • CancelVerifiedDigitalIdentity
      • Error Codes
Powered by GitBook
On this page
  • Definitions
  • API Key
  • Transaction ID
  • Bearer Access Token
  • APIs
  • Error codes
  1. Reference

API Reference

Base URL https://api.vlenseg.com/v1

Definitions

API Key

Authentication method representing each customer.

Transaction ID

the representation of each trial of list of services, for example ID front, ID back for same ID should be sent with the same transaction ID.

Bearer Access Token

A JWT Bearer Access Token is a specific type of access token used in authentication and authorization workflows.

  1. Bearer Token:

    • The term “bearer” indicates how the token is presented.

    • In an HTTP request, the token is included in the Authorization header as follows:

      Authorization: Bearer <token>

  2. Use Cases:

    • Authentication: Proves user identity.

    • Authorization: Grants access to specific resources.

    • Information Exchange: Securely shares data.

  3. Security Considerations:

    • Never store sensitive data in the payload.

    • Use HTTPS to prevent interception.

    • Rotate keys periodically for better security.

APIs

Vlens APIs are built using RESTful API standards and can be easily integrated within any system using an HTTP Client.

Our APIs accept and returns data in JSON format.

All API calls must be made over HTTPS, and must be authenticated using API key .

A Service API response often includes a Transaction ID indicating that a record of the attempt was created and to send back each request "for authorized services in bundle" related to same transaction on same transaction ID.

Each tenant by default can send up to 10 requests per second & 60 requests per minute.

Error codes

Each API call should return response code, there are 2 sections HTTP responses and Vlens error codes.

PreviousQuick StartNextRegister

Last updated 1 year ago

Register