v1

latestOpenAPI 3.0.12026-07-269671357.0 KB
Transactions

List Transactions

get/mortgage/v2/transactions

Query parameters

organization_idstring

The organization id of a child account. If the authenticated account has child accounts, specifying this parameter will exclude the authenticated account's transactions and return only the transactions for this child account, as well as all of the child account's children. If this is not provided, we will return all transactions in the authenticated account as well as all transactions in all child accounts.

loan_numberstring

To find transactions associated with the given loan number.

limitinteger

How many results to return. Max value accepted is 1000.

offsetinteger

Return requested # of items starting with the value.

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.