REST API

The OneSpan Identity Verification REST API is organized around the Transaction model . This model is fully defined by JSON schemas that can be used to generate client-side libraries for accessing the API. With the OneSpan Identity Verification RES...

Transactions are the main resource in OneSpan Identity Verification (see also Transaction model ). This API creates and starts the execution of a new transaction: Create transactions with documents, signatures, signers, and an instance of the pr...

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 th...

The Get Transaction Verification API retrieves the results of a transaction verification. The request needs to contain the transaction ID. Syntax GET /api/transaction/ uuid: transaction_id /verification Examples Example request GET /api/tra...

The Get Evidence API retrieves the complete evidence audit trail for a transaction. The evidence is produced as a single evidence pack that contains the full transaction audit trail, signer session recordings, identity validation data, and all a...

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 d...

The Cancel Transaction API prevents a transaction from progressing. Once the API is invoked, the transaction status becomes cancelled . The transaction information is returned, and when the session is resumed, the transaction canceled page is dis...

The Mark Transaction for Erasure API facilitates the deletion of a transaction. Users can request to delete one or more completed or incomplete transactions. They can also specify the time when the transaction should be deleted. Within the grace ...

With the Unmark Transaction for Erasure API, marking for erasure can be reverted. Transactions that were marked for erasure before are unmarked and will not be deleted. Syntax POST /api/transactions/unmark-for-erasure Examples Example reques...

The Create Session Creation Token API generates a new session creation token for existing transactions. A new session creation token is required when the old token has expired and the transaction is still valid. Syntax POST /api/transaction/ tra...

You can generate the audit trail document at any time during an active workflow. With the APIs described in this article, you can inspect the data and progress of a transaction whenever necessary, e.g. in case of unexpected behavior. Generating an ...

With this API, you can download the audit trail document that was generated with Generate audit trail on demand . The response of the generate-audit-trail request contains the link to the download location of the document. This link is included i...

With the API endpoints described in this article, you can retrieve the identity document images and the selfie images that were captured for a given completed transaction that has passed verification. Retrieving the verification images involves the...

The Detailed Verification Report API retrieves the verification results for a transaction. The following data is included in the report: Personal information Document information An SFT URL to the picture of the ID document The score a...