GetTransactionById API

Base Endpoint: GET https://api.vlenseg.com/api/Transactions/GetTransactionById

Overview:

This endpoint retrieves the details of a specific transaction by its ID. The response contains metadata about the transaction, including steps, client transaction details, and verification status. The API requires authentication using a bearer token and an API key.

Headers:

• ApiKey (required): The API key for authenticating the request.

• TenancyName (required): The tenancy name that identifies the tenant.

• Authorization (required): Bearer token for user authentication, obtained from the Login API.

Get transaction details by ID

get

This endpoint retrieves transaction details, including steps and client transaction info.

Authorizations

Query parameters

idstring · uuidRequired

The unique identifier of the transaction.

Responses

200

Successful response

application/json

400

Invalid request

401

Unauthorized

404

Transaction not found

get

HTTPcURLJavaScriptPython

GET /api/Transactions/GetTransactionById?id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "data": {
    "transaction": {
      "stepsCount": 1,
      "fullName": "text",
      "isMatched": true,
      "idNumber": "text",
      "creationTime": "2025-06-07T16:13:13.849Z",
      "clientTransactionId": "text",
      "isVerified": true,
      "creatorUserId": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "transactionItems": {
      "lazyLoadImages": true,
      "hasOtherSteps": true,
      "phoneNumber": "text",
      "digitalIdentityData": "text",
      "deviceInfo": "text",
      "isDigitalIdentityVerified": true,
      "steps": [
        {
          "transactionId": "123e4567-e89b-12d3-a456-426614174000",
          "clientTransactionId": "text",
          "jsonString": "text",
          "stepAttributeName": "text",
          "stepName": "text",
          "stepImageFileName": "text",
          "imageBytes": "text",
          "showImageName": true,
          "servicesData": "text",
          "id": 1
        }
      ],
      "extraData": "text",
      "fullName": "text",
      "isMatched": true,
      "idNumber": "text",
      "creationTime": "2025-06-07T16:13:13.849Z",
      "clientTransactionId": "text",
      "isVerified": true,
      "creatorUserId": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "error_code": "text",
  "error_message": "text"
}

JavaScript

const fetchTransactionById = async () => {
  const apiUrl = 'https://api.vlenseg.com/api/Transactions/GetTransactionById?id=4E6C8FE0-BC9B-476E-BF17-003E74A188B6';
  
  const headers = {
    'Authorization': 'Bearer <access_token>', // Replace <access_token> with the actual token
    'ApiKey': 'your_api_key',                 // Replace 'your_api_key' with your actual API key
    'TenancyName': 'your_tenancy_name'        // Replace 'your_tenancy_name' with your actual tenancy name
  };

  try {
    const response = await fetch(apiUrl, { method: 'GET', headers: headers });
    if (response.ok) {
      const data = await response.json();
      console.log(data);
    } else {
      console.error('Error:', response.status, await response.text());
    }
  } catch (error) {
    console.error('Error:', error);
  }
};

fetchTransactionById();

Python

import requests

# Replace with your actual API key, access token, and tenancy name
api_url = "https://api.vlenseg.com/api/Transactions/GetTransactionById"
params = {
    'id': '4E6C8FE0-BC9B-476E-BF17-003E74A188B6'
}
headers = {
    'Authorization': 'Bearer <access_token>',
    'ApiKey': 'your_api_key',
    'TenancyName': 'your_tenancy_name'
}

response = requests.get(api_url, headers=headers, params=params)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Error: {response.status_code}, {response.text}")

cURL

curl -X GET "https://api.vlenseg.com/api/Transactions/GetTransactionById?id=4E6C8FE0-BC9B-476E-BF17-003E74A188B6" \
-H "Authorization: Bearer <access_token>" \
-H "ApiKey: your_api_key" \
-H "TenancyName: your_tenancy_name"