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 External Accounts API

The External Accounts API from Orum — 4 operation(s) for external accounts.

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

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

This API exposes 9 operations across 4 paths, and defines 24 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.

9 operations 4 paths 24 schemas 1 DELETE4 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 External Accounts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 9

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

External Accounts 9
POST
/deliver/external/accounts
Create an external account
post-external-account 1 param body → 200400default
GET
/deliver/external/accounts
Get all external accounts
get-external-accounts 5 params → 200400default
PUT
/deliver/external/accounts
Update an external account by reference id
put-external-account-using-reference-id 1 param body → 200400default
GET
/deliver/external/accounts/{id}
Get an external account by id
get-external-account 2 params → 200404default
PUT
/deliver/external/accounts/{id}
Update an external account by id
put-external-account 2 params body → 200400404default
PATCH
/deliver/external/accounts/{id}
Partial update an external account by id
patch-external-account 2 params body → 200400404default
DELETE
/deliver/external/accounts/{id}
Closes an external account by id
delete-external-account 2 params → 200400404default
GET
/deliver/persons/{id}/external/accounts
Get all external accounts for a specific person
get-person-external-accounts 4 params → 200400404default
GET
/deliver/businesses/{id}/external/accounts
Get all external accounts for a specific business
get-business-external-accounts 4 params → 200400404default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ExternalAccountResponseBase (13 properties), ExternalAccountRequest (8 properties), PatchExternalAccountRequest (5 properties), ErrorResponse (3 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".
PutExternalAccountRequest
CreatedAt
string
Timestamp when the resource was created.
ExternalAccountRequest
object
8 properties 7 required
UpdatedAt
string
Timestamp when the resource was last updated.
DuplicateAccountError
ExternalAccountResponse
object
1 property 1 required
AccountHolderName
string
Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
AbaRoutingNumber
string
9-digit American Bankers Association (ABA) routing number.
AccountReferenceId
string
Unique reference id for the external account. Generated by you.
AccountType
string
Type of bank account - checking or savings.
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
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.
UsBankAccountNumber
string
Account number for US bank account. 4 to 17 digits are acceptable.
OrumId
string
Orum generated unique id for the resource.
ExternalAccountStatus
string
Status of the external account.
ExternalAccountsResponse
object
1 property 1 required
PatchExternalAccountRequest
object
5 properties
ExternalAccountResponseBase
object
A single object of External Account.
13 properties 11 required
EndCustomerResourceType
string
Type of customer resource - business, person, or enterprise.
ErrorResponse
object
3 properties 2 required
ExternalAccountCustomerReferenceId
string
Unique customerreferenceid that you passed when creating the associated customer (business or person) resource.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-external-accounts-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility 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 External Accounts 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.