Get All Persons

Get all persons

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/persons \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "persons": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_reference_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "status": "created",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "date_of_birth": "<string>",
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "home",
          "address1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US",
          "zip5": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "address2": "<string>"
        }
      ],
      "contacts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "email",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "status_reasons": [
        {
          "reason_code": "invalid_address",
          "reason_code_message": "Address submitted is a non-supported address type"
        }
      ],
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

GET

deliver

persons

Get all persons

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/persons \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "persons": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_reference_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "status": "created",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "date_of_birth": "<string>",
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "home",
          "address1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US",
          "zip5": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "address2": "<string>"
        }
      ],
      "contacts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "email",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "status_reasons": [
        {
          "reason_code": "invalid_address",
          "reason_code_message": "Address submitted is a non-supported address type"
        }
      ],
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

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.

string<uuid>

Filter results by the person id

Response

200 response.

persons

object[]

required

List of person objects.

Show child attributes

persons.id

string<uuid>

required

Orum generated unique id for the resource.

persons.customer_reference_id

string

required

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

Required string length: 1 - 255

persons.first_name

string

required

persons.last_name

string

required

persons.status

enum<string>

required

Status of person in Orum system.

Available options:

created,

verified,

rejected,

restricted,

closed

persons.created_at

string<date-time>

required

Timestamp when the resource was created.

persons.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

persons.middle_name

string

persons.date_of_birth

string

Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and greater than 18 years to be verified.

persons.addresses

PostalAddressResponse · object[]

Address information for the person. Note: This field is required for payouts, deposits, or account-to-account transfers.

Required array length: 1 element

Show child attributes

persons.addresses.id

string<uuid>

required

Orum generated unique id for the resource.

persons.addresses.type

enum<string>

required

Type of address.

Available options:

home,

legal

persons.addresses.address1

string

required

Address line 1.

Maximum string length: 255

persons.addresses.city

string

required

City.

Maximum string length: 255

persons.addresses.state

string

required

Uppercase two-character state code of the address.

persons.addresses.country

enum<string>

required

2-character ISO country code.

Available options:

US

persons.addresses.zip5

string

required

5-digit ZIP Code. Numeric values (0-9) only.

persons.addresses.created_at

string<date-time>

required

Timestamp when the resource was created.

persons.addresses.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

persons.addresses.address2

string

Address line 2.

Maximum string length: 255

persons.contacts

ContactResponse · object[]

List of contact information for the person.

Required array length: 1 - 2 elements

Show child attributes

persons.contacts.id

string<uuid>

required

Orum generated unique id for the resource.

persons.contacts.type

enum<string>

required

Type of contact information associated with a person - 'email' or 'phone'.

Available options:

email,

phone

persons.contacts.value

string

required

Email or phone number.

persons.contacts.created_at

string<date-time>

required

Timestamp when the resource was created.

persons.contacts.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

persons.status_reasons

object[]

Array that explains why the person failed verification.

Show child attributes

persons.status_reasons.reason_code

string

required

A word-based code that describes the verification failure.

Example:

"invalid_address"

persons.status_reasons.reason_code_message

string

required

A human-readable description of the reason code.

Example:

"Address submitted is a non-supported address type"

persons.closed_at

string<date-time>

Timestamp when the status of the resource was set to "closed".

persons.metadata

object

Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.

Create Person Get Person By ID

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Query Parameters

Response