POST
/
deliver
/
businesses
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/businesses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "customer_reference_id": "<string>",
  "legal_name": "<string>",
  "business_name": "<string>",
  "entity_type": "sole_proprietorship",
  "tax_id": "<string>",
  "tax_id_type": "tin",
  "account_holder_name": "<string>",
  "incorporation_date": "<string>",
  "addresses": [
    {
      "type": "legal",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>"
    }
  ],
  "contacts": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "metadata": {}
}'
{
  "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

Body

application/json
​
customer_reference_id
string
required

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

Required string length: 1 - 255
​
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.

Maximum length: 255
​
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.

Maximum length: 255
​
entity_type
enum<string> | null

Describes the type of business entity.

Available options:
sole_proprietorship,
partnership,
limited_liability_partnership,
limited_liability_company,
c_corporation,
s_corporation,
b_corporation,
nonprofit_corporation
​
tax_id
string

9-digit corporate tax id of business - can be Taxpayer Identification Number (TIN) or Employer Identification Number (EIN). Note: This field is required for payouts, deposits, or account-to-account transfers.

​
tax_id_type
enum<string>

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

Available options:
tin,
ein
​
account_holder_name
string

Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Maximum length: 255
​
incorporation_date
string

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

​
addresses
object[] | null

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.

​
contacts
object[] | null

List of contact information for the business. 'email', 'phone', or 'website' are required. A maximum of three persons or businesses can have the same phone number.

Contact information.

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

Response

200
application/json
200 response.
​
business
object
required

Was this page helpful?

Close Person By IDGet All Businesses