List Transactions

get

https://api.proof.com/v1/transactions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns a list of transactions. The returned transactions are sorted by creation date, with the most recently created transactions appearing first.

Returns

A dictionary with a data property that contains an array of up to limit transactions, starting at index offset. Each entry in the array is a separate transaction object. If no more transactions are available, the resulting array will be empty.

Query Params

limit

integer

How many results to return. Default is 10; max is 1000.

offset

integer

Offset request by given # of items. Default is 0.

created_date_start

date-time

An ISO-8061 formatted DateTime String, optionally including the timezone offset. Will return all transactions created after this DateTime.

created_date_end

date-time

An ISO-8061 formatted DateTime String, optionally including the timezone offset. Will return all transactions created before this DateTime.

last_updated_date_start

date-time

An ISO-8061 formatted DateTime String, optionally including the timezone offset. Will return all transactions last updated after this DateTime.

last_updated_date_end

date-time

An ISO-8061 formatted DateTime String, optionally including the timezone offset. Will return all transactions last updated before this DateTime.

transaction_status

string

enum

Return transactions based on their current transaction status.

document_url_version

string

enum

Defaults to v1

Control documents and signer photo identifications download URLs. v1 for AWS S3 pre-signed URLs. v2 for Proof secure URLs.

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Returns

200successful