User Activate Request

Validating user contacts (phone number - email address) using One Time Password.

General Input For Any Request

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key
Authorization*	string	Bearer Access Token `Bearer <accessToken>` that returned from login Api

Request Body

Name	Type	Description
geoLocation*	object : { "latitude": <decimal>, "longitude": <decimal> }	User Current Location {latitude, longitude}
userDeviceUtcTime*	<isoTimestamp>
requestId	<GUID>

200: OK success

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

400: Bad Request Request parameters are not correct

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

401: Unauthorized Invalid credentials

{
    // Response
}

Step 1 - Request Activate OTP

POST https://api.vlenseg.com/api/BusinessRequest/Activate

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

200: OK success

{
    "data": {
        "isActive": <bool>,
        "needsReValidate": <bool>,
        "errorMessage": <string>,
        "paymentLink": <string>,
        "isValidPayment": <bool>,
        "requestId": <GUID>,
        "otpRequestId": <GUID>,
        "transactionId": <GUID>
    },
    "error_code": <string>,
    "error_message": <string>
}

403: Request is not approved yet

{
    "data": null,
    "error_code": 403,
    "error_message": "This request is pending approval form admin"
}

Step 2 - Validate The OTP

POST https://api.vlenseg.com/api/BusinessRequest/Activate

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

Request Body

Name	Type	Description
transactionId*	<GUID>	returned from the first step
otpRequestId*	<GUID>	returned from the first step
otpCode*	<string>	Sent to user register Phone Number via SMS
scanTransaction	{ "image": <string> }	Mandatory if needsReValidate = true in the first step, contains user captured image as base 64 string.

200: OK success

{
    "data": {
        "isActive": <bool>,
        "needsReValidate": <bool>,
        "errorMessage": <string>,
        "paymentLink": <string>,
        "isValidPayment": <bool>,
        "requestId": <GUID>,
        "otpRequestId": <GUID>,
        "transactionId": <GUID>
    },
    "error_code": <string>,
    "error_message": <string>
}

Step 3 - Preform Payment

Use the payment Link that returned from Step 2 to preform payment action to the using iFrame in the mobile or external browser

Step 4 - Validate Payment & Activate Contract

POST https://api.vlenseg.com/api/BusinessRequest/Activate

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

Request Body

Name	Type	Description
transactionId*	<GUID>	returned from the first step

200: OK success

{
    "data": {
        "isActive": true,
        "needsReValidate": <bool>,
        "errorMessage": <string>,
        "paymentLink": <string>,
        "isValidPayment": <bool>,
        "requestId": <GUID>,
        "otpRequestId": <GUID>,
        "transactionId": <GUID>
    },
    "error_code": <string>,
    "error_message": <string>
}