Skip to main content
GET
/
deliver
/
businesses
Get all businesses
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/businesses \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "businesses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_reference_id": "<string>",
      "legal_name": "<string>",
      "status": "created",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "business_name": "<string>",
      "entity_type": "<string>",
      "tax_id_type": "<string>",
      "account_holder_name": "<string>",
      "incorporation_date": "<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"
        }
      ],
      "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 Business.

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

​
legal_name
string

Filter by legal name The legal name of the business as it appears on official registration forms. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, hashes, colons, forward slashes, and diacritics.

Maximum string length: 255
​
account_number
string

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

​
id
string<uuid>

Filter results by the business id

Response

200 response.

​
businesses
BusinessResponseBase · object[]
required

List of businesses.