How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Businesses API

The Businesses API from Orum — 2 operation(s) for businesses.

Orum Businesses API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Businesses. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 2 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

7 operations 2 paths 41 schemas 1 DELETE2 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Businesses API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 7

Across 2 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Businesses 7
POST
/deliver/businesses
Create a business
post-business 1 param body → 200400default
GET
/deliver/businesses
Get all businesses
get-businesses 10 params → 200400default
PUT
/deliver/businesses
Update a business by reference id
put-business-using-reference-id 1 param body → 200400default
GET
/deliver/businesses/{id}
Get a business by id
get-business 2 params → 200404default
PUT
/deliver/businesses/{id}
Update a business by id
put-business 2 params body → 200400404default
PATCH
/deliver/businesses/{id}
Partial update a business by id
patch-business 2 params body → 200400404default
DELETE
/deliver/businesses/{id}
Closes a business by id
delete-business 2 params → 200400404default

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are BusinessResponseBase (15 properties), BusinessRequest (11 properties), PatchBusinessRequest (10 properties), PostalAddressResponse (10 properties). Each schema is shown below with its type and property counts.

ClosedAt
string
Timestamp when the status of the resource was set to "closed".
BusinessPostalAddressRequest
object
Address.
7 properties 6 required
BusinessRequest
object
11 properties 2 required
Zip5
string
5-digit ZIP Code. Numeric values (0-9) only.
CreatedAt
string
Timestamp when the resource was created.
ContactTypeBusiness
string
Type of contact information associated with a business - 'email', 'phone' or 'website'.
UpdatedAt
string
Timestamp when the resource was last updated.
ContactRequestBusiness
object
Contact information.
2 properties 2 required
TaxId
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 pa…
PatchContactRequestBusiness
object
Contact information.
2 properties 1 required
BusinessResponseBase
object
15 properties 6 required
Address2
string
Address line 2.
OptionalAccountHolderName
string
Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
BusinessStatus
string
Status of Business.
PostalAddressResponse
object
Address.
10 properties 9 required
AddressType
string
Type of address.
PutBusinessResponse
object
1 property 1 required
PutBusinessRequest
BusinessName
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…
IncorporationDate
string
Date the business was incorporated, in YYYY-MM-DD format.
Country
string
2-character ISO country code.
PutBusinessResponseBase
PatchBusinessRequest
object
10 properties
BusinessEntityType
stringnull
Describes the type of business entity.
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
TaxIdType
string
The type of tax ID number associated with the business. Note: This field is required for payouts, deposits, or account-to-account transfers.
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…
MetadataPut
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…
CustomerReferenceId
string
Unique reference id for the customer (business or person) resource. Generated by you.
LegalName
string
The legal name of the business as it appears on official registration forms. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces,…
BusinessPatchPostalAddressRequest
object
Address.
7 properties 1 required
UsBankAccountNumber
string
Account number for US bank account. 4 to 17 digits are acceptable.
BusinessResponse
object
1 property 1 required
OrumId
string
Orum generated unique id for the resource.
Address1
string
Address line 1.
State
string
Uppercase two-character state code of the address.
BusinessesResponse
object
1 property 1 required
ContactResponseBusiness
object
Contact information.
5 properties 5 required
AddressTypeBusiness
string
Type of address. Always 'legal' for business object.
ErrorResponse
object
3 properties 2 required
City
string
City.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-businesses-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

This is an independent, third-party profile of Orum Businesses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.