Get Transaction Status and Metadata

The Get Transaction Status and Metadata API retrieves the transaction status and metadata of a transaction based on its ID (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/transaction_id(?withVerifications=true/false optional)

Examples

Example requests

  1. GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b HTTP/1.1

  2. Host: onespan.com

  3. Accept: application/json, text/javascript

Example request including withVerifications parameter

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

Example responses

  1. HTTP/1.1 200 OK

  2. Vary: Accept
  3. Content-Type: application/json
  4. {
  5.   "id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",

  6.   "status":"new",
  7.   "created":"2017-04-23T18:25:43.511Z",
  8.   "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
  9.   "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  10.   "urlSetKey":"default",
  11.   "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  12.   language":"english",
  13.   "tokens": [...],
  14.   "users": [...],
  15.   "documents": [...],
  16.   "events": [...]
  17. }

Example response when using withVerifications parameter

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

Headers

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

Request headers

  • Accept: The response content type depends on the Accept header
  • Authorization: The OAuth/JWT token to authenticate

Response headers

Status codes

Status codes
Status code Name Description
200 OK

No error.

400 Bad Request The transaction data is invalid.
401 Unauthorized Invalid token.
403 Forbidden The token does not grant transaction creation rights.
500 Internal Server Error Server or application error.