Skip to main content
GET
Get all persons

Authorizations

Authorization
string
header
required

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

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
customer_reference_id
string

Filter by customer reference id Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255
status
enum<string>[]

Filter by customer statuses (multiple allowed)

Status of person in Orum system.

Available options:
created,
verified,
rejected,
restricted,
closed
start_time
string<date-time>

Filter results created at or after this time

end_time
string<date-time>

Filter results created before this time

first_name
string

The first name to filter persons by (case-insensitive, exact match).

last_name
string

The last name to filter persons by (case-insensitive, exact match).

account_number
string

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

Pattern: ^(?:\d-{0,1}){3,16}\d$
id
string<uuid>

Filter results by the person id

Response

200 response.

persons
object[]
required

List of person objects.