---
title: "Get Transaction Status and Metadata"
slug: "get-transaction-status-and-metadata"
updated: 2025-06-27T19:51:41Z
published: 2025-06-27T19:51:41Z
canonical: "docs.onespan.com/get-transaction-status-and-metadata"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/v1/docs/retrieve-verification-images).

## Syntax

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

## Examples

### Example requests

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

#### Example request including withVerifications parameter

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

### Example responses

```http
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
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](https://tools.ietf.org/html/rfc7231#section-5.3.2): The response content type depends on the Accept header.
- [Authorization](https://tools.ietf.org/html/rfc7235#section-4.2): The OAuth/JWT token to authenticate.

#### Response headers

- [Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5): application/json

### Status codes

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><div data-type="table-content"> <table width="100%" class=" fr-alternate-rows editor360-table" borderstyle="Solid"> <colgroup style="display:none;"> <col style="width:250px;"> <col style="width:250px;"> <col style="width:250px;"> </colgroup> <tbody> <tr> <td colspan="3" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="242f9007-dd41-4cfd-ac69-85d9df79d61a"><a name="Tab_Status_codes" display="false"></a><strong>Status codes</strong></p> </td> </tr> <tr> <th colspan="1" rowspan="1" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="2912d983-3e25-48af-90d1-6f13a9b84963">Status code</p> </th> <th colspan="1" rowspan="1" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="98197ad1-c0e4-4efe-b2c2-acb9655fe30d">Name</p> </th> <th colspan="1" rowspan="1" class="TableStyle-Global-HeadD-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="6c139681-d966-4038-8e80-f0696b439bcf">Description</p> </th> </tr> <tr> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="854af340-c3eb-44e7-899c-78820f3e3a42"><span class="vdsCodeBasic" type="spanMark">200</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="e99d9ca9-cbea-46ba-afd0-8d33addb9a79"><span class="vdsCodeBasic" type="spanMark">OK</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="0dfc4e1d-19bc-4f3b-abb6-14992bff4710">No error.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="2439075a-9f86-43e1-a17e-b21b11ae4b32"><span class="vdsCodeBasic" type="spanMark">400</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="fdbf1c28-5e35-404c-8941-ab0ade30e370"><span class="vdsCodeBasic" type="spanMark">Bad Request</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="138b1826-ff79-48ae-b92c-b488aea8194b">The transaction data is invalid.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="3d2f2f80-0d55-4e9a-8655-51a79e2e5619"><span class="vdsCodeBasic" type="spanMark">401</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="868534d7-973b-4f14-8e1b-d2fc1bb6a26b"><span class="vdsCodeBasic" type="spanMark">Unauthorized</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="8bccc780-28b2-444d-b3d1-c9df7827dc37">Invalid token.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="f3b6a9f9-aeb9-4e84-a3a6-8d81e142b904"><span class="vdsCodeBasic" type="spanMark">403</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="53be5217-c490-4d0b-bc13-4a529026fad7"><span class="vdsCodeBasic" type="spanMark">Forbidden</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="21c446d7-4817-4b09-a09e-bb4c544d256d">The token does not grant transaction creation rights.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="85646d46-d0d1-4efb-b5d9-ff00ec769e86"><span class="vdsCodeBasic" type="spanMark">500</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="97560aab-eb39-4112-aa91-f4182af9ca44"><span class="vdsCodeBasic" type="spanMark">Internal Server Error</span></p> </td> <td colspan="1" rowspan="1" style="vertical-align:middle;text-align:left;"> <p data-block-id="ba085190-dad4-4eda-b8d3-3b11b3c1ea70">Server or application error.</p> </td> </tr> </tbody> </table></div></editor360-custom-block>
