Transaction Management API

General Input For Any Request

As a transaction is just a container for the underlying steps, no end point to create or update a transaction, only delete. A transaction is created by adding a step with an empty transaction_id

POST https://portalapi.vlenseg.com/v1/app/<endpoint_path>

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key
BundleKey	string	Bundle Key to identify the required services

200: OK

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

400: Bad Request

401: Unauthorized

Gets transactions list according to the provided filters

GET /transactions

Query parameters are used as needed to filter the results and apply paging. All string parameters are partial matching

Query Parameters

Name	Type	Description
filterText	string	Any part of the name, national Id, transaction Id or client transaction Id
skipCount	int	Number of items to skip. Default is 0
maxResultCount	int	Number of records to be retreived. Default is 10, max is 1000

200: OK

{
  "data": {
     "totalCount": <int>,
     "items": [
      {
	"id": <GUID>,
	"stepsCount": <int>,
	"fullName": <string>,
	"isMatched": <bool>,
	"idNumber": <string>,
	"clientTransactionId": <string>,
	"creationTime": <date>
       }
     ]
  },
  .
  .
  .
}

Gets a single transaction basic data

GET /transactions/{id}

Path Parameters

Name	Type	Description
id*	GUID	Transaction Id

200: OK

{
  "data": {
      "id": <GUID>,
      "stepsCount": <int>,
      "fullName": <string>,
      "isMatched": <bool>,
      "idNumber": <string>,
      "clientTransactionId": <string>,
      "creationTime": <date>
  },
  .
  .
  .
}

Gets a single transaction with all the underlying steps

GET /transactions/{id}/steps

Path Parameters

Name	Type	Description
id*	GUID	Transaction Id

200: OK

{
  "data": {
      "id": <GUID>,
      "fullName": <string>,
      "isMatched": <bool>,
      "idNumber": <string>,
      "clientTransactionId": <string>,
      "creationTime": <date>,
      "steps": [
          {<Data model according to each step type model>}
      ]
  },
  .
  .
  .
}

Deletes the transaction with the specified id along with all underlying steps and documents

DELETE /transactions/{id}

200: OK Transaction is deleted successfully. No data model is returned

Creates a new step

POST /steps

Request Body

Name	Type	Description
transaction_id	GUID	Transaction Id to create the step under it. If null then a new transaction is created and its Id will be returned in response data
type*	string	Step type. Type must be one of the pre-defined types or "others". Available types (updated): id_front id_back car_license_front car_license_back face_match passport driving_license license_plate others
data	string	Step data in JSON format. It can be null or empty only in case of "others" type

200: OK

{
  "data": {
      "transction_id": <GUID>,
      "step": {
          //Inserted data is returned to validate that the sent json for pre-defined types is correct
           <Data model according to each step type model>
      }
  },
  .
  .
  .
}

Updates an existing step

PUT /steps/{id}

Path Parameters

Name	Type	Description
id*	int	Step Id

Request Body

Name	Type	Description
data	string	Updated step data in JSON format - or free text in case of "others" type. It can be null or empty only in case of "others" type
is_json	bool	Whether the step data is free text or JSON. Default is "true". This field is ignored if the type is one of the pre-defined types

200: OK

{
  "data": {
      "transction_id": <GUID>,
      "step": {
          //Inserted data is returned to validate that the sent json for pre-defined types is correct
           <Data model according to each step type model>
      }
  },
  .
  .
  .
}