Get Bank Verifications

get

https://{your-totality-url}.com/api/bank-verifications

Retrieve paginated bank verifications using optional filters. Permission: Read Bank Verifications

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Page

string

Defaults to page=1

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

Sort

string

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

Filter

string

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

createdAt

string

When the bank verification was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

customerUuid

string

The UUID of the customer. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

hasCompletedVerification

boolean

Whether the verification process has completed. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

hasPassedVerification

boolean

Whether the verification was successful. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isReceivingUpdates

boolean

Whether the verification is still receiving provider updates. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

loanUuid

string

The UUID of the associated loan. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

provider

string

The bank verification provider (e.g., Plaid, DecisionLogic). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

referenceId

string

The provider-assigned reference ID. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

reportUrl

string

The URL to the verification report. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

transactionDetails

string

Detailed transaction data from the provider. Sortable: No. Filter Operators: nn, null

transactionSummary

string

Summary of bank transaction activity. Sortable: No. Filter Operators: nn, null

updatedAt

string

When the bank verification was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

uuid

string

The bank verification's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

Headers

string

required

Defaults to application/vnd.totality.v1+json

Must be application/json.

Content-Type

string

required

Defaults to application/json

Must be application/json.

Responses

200Successful response

401Unauthenticated

403Forbidden

500Server Error