Transaction Status

This API is used by partners to request the status of an ongoing authentication or provisioning transaction. It helps in monitoring the transaction progress and managing any necessary follow-up actions

API Description

Method : POST

URL : https://{environment-url}/realms/{partner-id}/protocol/api/status

Parameters

• client_id : A unique client id that is shared for each partner.

• client_secret : A unique key that is generated for each parter and will be provided by VIDA.

• session_identifier : Session id received in response of Transaction Initiation API.

Transaction Status

POST https://{environment-url}/realms/{partner-id}/protocol/api/status

Query Parameters

Name	Type	Description
client_id*	String	A unique client id that is shared for each partner.
client_secret*	String	A unique key that is generated for each partner and will be provided by VIDA
session_identifier*	String	Session id received in response of Transaction Initiation API

Headers

Name	Type	Description
Content-Type*	String	application/x-www-form-urlencoded

200: OK

{
    "status": "INITIATED"
}

Curl

curl --location -g --request POST 'https://{environment-url}/realms/{partner-id}/protocol/api/status' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=api' \
--data-urlencode 'client_secret=enESfot4PPpSWxTa74vR8D9nrW4UTtT3' \
--data-urlencode 'session_identifier=jh1ZkGkVzDEg'

Python

import requests

url = "https://{environment-url}/realms/{partner-id}/protocol/api/status"

payload='client_id=api&client_secret=enESfot4PPpSWxTa74vR8D9nrW4UTtT3&session_identifier=jh1ZkGkVzDEg'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

NodeJS

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
  'client_id': 'api',
  'client_secret': 'enESfot4PPpSWxTa74vR8D9nrW4UTtT3',
  'session_identifier': 'jh1ZkGkVzDEg' 
});
var config = {
  method: 'post',
  url: 'https://{environment-url}/realms/{partner-id}/protocol/api/status',
  headers: { 
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "client_id=api&client_secret=enESfot4PPpSWxTa74vR8D9nrW4UTtT3&session_identifier=jh1ZkGkVzDEg");
Request request = new Request.Builder()
  .url("https://{environment-url}/realms/{partner-id}/protocol/api/status")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute()

C#

var client = new RestClient("https://{environment-url}/realms/{partner-id}/protocol/api/status");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("client_id", "api");
request.AddParameter("client_secret", "enESfot4PPpSWxTa74vR8D9nrW4UTtT3");
request.AddParameter("session_identifier", "jh1ZkGkVzDEg");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{environment-url}/realms/{partner-id}/protocol/api/status',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'client_id=api&client_secret=enESfot4PPpSWxTa74vR8D9nrW4UTtT3&session_identifier=jh1ZkGkVzDEg',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Transaction Status

INITIATED: The transaction has been initiated.

COMPLETE: The transaction has been successfully completed

FAILED : The transaction has been failed

KILLED : The transaction has been killed using the Kill Transaction API

TIMEOUT: The transaction has exceeded the allowed time duration without completing.

Success Response

{
    "status": "INITIATED"
}

Response Schema

{
    "status": "{STATUS OF SPECIFIED AUTHENTICATION SESSION}"
}

Error Response

{
    "error": "invalid_request",
    "errorDescription": "Invalid session identifier"
}

Response Schema

{
    "error": "{TYPE OF ERROR}",
    "errorDescription": "{REASONING FOR THE ERROR}"
}