GET
/
deliver
/
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>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "<string>",
      "status": "created",
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "home",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US",
          "zip5": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "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"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The auth token received from Authentication endpoints.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. 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

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

Filter results created at or after this time

​
end_time
string

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

​
id
string

Filter results by the person id

Response

200
application/json
200 response.
​
persons
object[]
required

List of person objects.

Was this page helpful?

Create PersonGet Person By ID