Get Transaction Status and Metadata

The Get Transaction Status and Metadata API retrieves the transaction status and the metadata of a transaction based on its ID (uuid: transaction_id).

If you want to obtain the verification ID of a completed transaction, you need to use the withVerifications parameter. The verification ID is required for the retrieval of a transaction's verification images. For more information, see Retrieve verification images.

Syntax

GET /api/transaction/uuid: transaction_id(?withVerifications=true/false optional)

Examples

Example requests

GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript

Example request including withVerifications parameter

GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b?withVerifications=true HTTP/1.1
Host: onespan.com

Example responses

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
  "id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",
  "status":"new",
  "created":"2017-04-23T18:25:43.511Z",
  "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
  "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  "urlSetKey":"default",
  "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  language":"english",
  "tokens": [...],
  "users": [...],
  "documents": [...],
  "events": [...]
}

Example response when using withVerifications parameter

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
  "id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",
  "status":"new",
  "created":"2017-04-23T18:25:43.511Z",
  "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
  "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  "urlSetKey":"default",
  "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  language":"english",
  "tokens": [...],
  "verifications": [...],
  "users": [...],
  "documents": [...],
  "events": [...]
}

Headers

The following headers are included in the request and the response:

Request headers

• Accept: The response content type depends on the Accept header.

• Authorization: The OAuth/JWT token to authenticate.

Response headers

• Content-Type: application/json

Status codes