Sign in

v1

latestOpenAPI 3.0.12026-07-269671357.0 KB
Transactions

List Transactions

get/v1/transactions

Query parameters

limitinteger

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

offsetinteger

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

created_date_startstring date-time

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

created_date_endstring date-time

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

last_updated_date_startstring 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_endstring date-time

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

transaction_status'started' | 'sent' | 'received' | 'completed' | 'partially_completed' | 'completed_with_rejections' | 'active' | 'sent_to_closing_ops' | 'sent_to_title_agency' | 'expired'

Return transactions based on their current transaction status.

document_url_version'v1' | 'v2'

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

Response

successful

countinteger

Number of transactions returned in this call.

total_countinteger

Total number of transactions matching this query.