Skip to main content
GET
Get all verify accounts

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://api-sandbox.orum.io/oauth/token
Scopes1
read:verify-accounts
Read verify accounts

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Query Parameters

index
integer
default:0

Index for paginated results

Required range: x >= 0
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500
id
string<uuid>

Filter results by the account id

start_time
string<date-time>

Filter results created at or after this time

end_time
string<date-time>

Filter results created before this time

account_number
string

Filter results by account number Account number for US bank account. 4 to 17 digits are acceptable.

Pattern: ^(?:\d-{0,1}){3,16}\d$
verification_status
enum<string>[]

Filter results by account status

Status of account verification.

Available options:
pending,
valid,
closed,
invalid,
failed
ownership_status
enum<string>[]

Filter results by account ownership status

Status of account ownership.

Available options:
pending,
full,
partial,
not_a_match,
not_found
control_status
enum<string>[]

Filter results by account control status

Status of account control.

Available options:
pending,
valid,
canceled
debit_status
enum<string>[]

Filter results by account debit status

Status of account debit.

Available options:
pending,
valid,
blocked,
failed

Response

200 response.

accounts
VerifyAccountResponseBase · object[]
required

An array of verify accounts.