Get Document

The Get Document API retrieves metadata and content of a document that is being processed in a transaction. The request needs to contain the document ID and the transaction ID.

The document is a fundamental resource in the OneSpan platform domain model (see Document model).

Syntax

GET /api/transaction/uuid: transaction_id/document/document_id/pdf

Examples

Example request

GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b/document/ee02adab-4946-4fae-884f-d8990aaf776a/pdf HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript

Example response

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json; charset=UTF-8

The response body contains the requested document.

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: Depends on the Accept header of the request.

Status codes