User Profile

Use 3 endpoints StepVerifyPhone, StepVerifyEmail, StepCreate to register a user using his mobile number and email.

General Input For Any Request

base-url: https://api.vlenseg.com/api/DigitalIdentity/<endpoint_path>

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key

200 success

{
  "data": <Data model according to each model described below>,
  "error_code": <int>,
  "error_message": <string>
}

400: Bad Request

{
    "data": null,
    "error_code": 400,
    "error_message": "Bad Request - Input parameters are invalid."
}

401: Unauthorized

{
  "data": null,
  "Services": null,
  "error_code": 401,
  "error_message": "Unauthorized – invalid API Key"
}

User Reset Password

Sends Request to reset user password

POST https://<base-url>/api/DigitalIdentity/SendPasswordResetCode

This Api would send a Reset Password email to EmailAddress parameter value if it registered.

Request Body

Parameter Name	Type	Description
EmailAddress	string	email: Represents the user mail to be verified. The verification process will typically involve sending a one-time code to this mail.

200 success

{
  "data": <bool>,
  "error_code": <int>,
  "error_message": <string>
}

Register Step 1 Check Email & Phone Is Exist

Update User Email

Step 01 Sends Request to Verify the user mail

POST https://<base-url>/UpdateEmailRequest

Use parameters mentioned in general input above along with below parameters, check the data model in responses below.

Process of sending OTP to verify the possession of the mail.

Request Body

Name	Type	Description
email	string	email: Represents the user mail to be verified. The verification process will typically involve sending a one-time code to this mail.

200 success

{
  "data": {
     "emailOtpRequestId": <GUID>,
     "emailOtpExpireInSeconds": <int>
  },
  "error_code": <int>,
  "error_message": <string>
}

To Use this API

1. First you need to call it with email to send an OTP verification code to the new email.

2. The server will response you with emailOtpRequestId.

3. Send post request on the next endpoint with same emailOtpRequestId and emailOtp value sent on mail.

Step 02 Sends Validate the sent OTP user mail

POST https://<base-url>/ValidateUpdateEmailRequestOtp

Use parameters mentioned in general input above along with below parameters, check the data model in responses below.

Process of sending OTP to verify the possession of the mail.

Request Body

Name	Type	Description
emailOtpRequestId	GUID	GUID auto generated form the server for the current verify request.
emailOtp	string	The one-time code that was sent to the E-Mail.

200 success

{
  "data": {
     "isEmailConfirmed": <bool>
  },
  "error_code": <int>,
  "error_message": <string>
}