Get Business By ID

GET

deliver

businesses

{id}

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

{
  "business": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "legal_name": "<string>",
    "business_name": "<string>",
    "entity_type": "<string>",
    "tax_id_type": "<string>",
    "account_holder_name": "<string>",
    "incorporation_date": "<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"
      }
    ],
    "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

Path Parameters

string

required

Orum generated unique id for the business you are fetching.

Response

200

application/json

200 response.

business

object

required

business.id

string

required

Orum generated unique id for the resource.

business.customer_reference_id

string

required

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

Required string length: 1 - 255

business.legal_name

string

required

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.

business.status

enum<string>

required

Status of Business.

Available options:

created,

verified,

rejected,

restricted,

closed

business.created_at

string

required

Timestamp when the resource was created.

business.updated_at

string

required

Timestamp when the resource was last updated.

business.business_name

string

A trade name or pseudonym used by the business that is not its officially registered company name. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, hashes, colons, forward slashes, and diacritics.

business.entity_type

string

Describes the type of business entity.

business.tax_id_type

string

The type of tax ID number associated with the business. Note: This field is required for payouts, deposits, or account-to-account transfers.

business.account_holder_name

string

Name of the owner or primary person associated with the business.

business.incorporation_date

string

Date the business was incorporated, in YYYY-MM-DD format.

business.addresses

object[]

Incorporated address information for the business. Note: This field is required for payouts, deposits, or account-to-account transfers. Orum requires a physical address for all registered businesses; aligned with standards mandated by FinCEN and the FDIC. A physical address is a tangible building address, such as a home, office, or office suite. A PO Box is a mailing address, but not a physical address.

Address.

business.contacts

object[]

List of contact information for the business.

Contact information.

business.closed_at

string

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

business.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.

Was this page helpful?

Get All Businesses Update Business By ID

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

{
  "business": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "legal_name": "<string>",
    "business_name": "<string>",
    "entity_type": "<string>",
    "tax_id_type": "<string>",
    "account_holder_name": "<string>",
    "incorporation_date": "<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"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Path Parameters

Response