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 Subledgers API

The Subledgers API from Orum — 2 operation(s) for subledgers.

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

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

This API exposes 3 operations across 2 paths, and defines 14 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.

3 operations 2 paths 14 schemas 2 GET1 POST

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 Subledgers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 3

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

Subledgers 3
POST
/deliver/subledgers
Create a subledger
post-subledger 1 param body → 200400401default
GET
/deliver/subledgers
Get all subledgers
get-subledgers 4 params → 200400default
GET
/deliver/subledgers/{id}
Get a subledger
get-subledger 2 params → 200400404default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SubledgerResponseBase (8 properties), ErrorResponse (3 properties), SubledgerRequest (2 properties), SubledgerResponse (1 property). Each schema is shown below with its type and property counts.

ClosedAt
string
Timestamp when the status of the resource was set to "closed".
SubledgerReferenceId
string
Unique reference id for the subledger resource. Generated by you.
OrumId
string
Orum generated unique id for the resource.
SubledgerStatus
string
Status of subledger in Orum system.
SubledgersResponse
object
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
SubledgerResponse
object
1 property 1 required
CreatedAt
string
Timestamp when the resource was created.
ErrorResponse
object
3 properties 2 required
SubledgerRequest
object
2 properties 2 required
CustomerReferenceId
string
Unique reference id for the customer (business or person) resource. Generated by you.
UpdatedAt
string
Timestamp when the resource was last updated.
EndCustomerResourceType
string
Type of customer resource - business, person, or enterprise.
SubledgerResponseBase
object
8 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-subledgers-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 External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Where this information came from

This is an independent, third-party profile of Orum Subledgers 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.