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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Orum

Orum Persons API

The Persons API from Orum — 2 operation(s) for persons.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 7 operations across 2 paths, and defines 44 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 44 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
Apache 2.0
Resource Areas
1

Authentication & Security 1

Orum Persons 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.

Persons 7
POST
/deliver/persons
Create a person
post-person 1 param body → 200400default
GET
/deliver/persons
Get all persons
get-persons 11 params → 200400default
PUT
/deliver/persons
Update a person by customer reference id
put-person-using-reference-id 1 param body → 200400default
GET
/deliver/persons/{id}
Get a person by id
get-person 2 params → 200400404default
PUT
/deliver/persons/{id}
Update a person by id
put-person 2 params body → 200400404default
PATCH
/deliver/persons/{id}
Partial update a person by id
patch-person 2 params body → 200400404default
DELETE
/deliver/persons/{id}
Closes a person by id
delete-person 2 params → 200400404default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PersonResponseBase (14 properties), PostalAddressResponse (10 properties), PersonRequest (9 properties), PatchPersonRequest (8 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".
SocialSecurityNumber
stringnull
Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) in XXX-XX-XXXX format. An example dummy value is 123-45-6789. Note: This field…
PersonResponse
object
1 property 1 required
Zip5
string
5-digit ZIP Code. Numeric values (0-9) only.
LastName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
CreatedAt
string
Timestamp when the resource was created.
PatchPersonRequest
object
8 properties
ContactTypePerson
string
Type of contact information associated with a person - 'email' or 'phone'.
UpdatedAt
string
Timestamp when the resource was last updated.
PutPersonResponseBase
PutPersonRequest
object
Address2
string
Address line 2.
AddressTypePerson
string
Type of address. Always 'home' for person object.
ContactPostBasePerson
object
Contact information.
2 properties 2 required
ReasonCode
string
A word-based code that describes the verification failure.
ContactBasePerson
object
Contact information.
2 properties 1 required
PostalAddressResponse
object
Address.
10 properties 9 required
AddressType
string
Type of address.
ContactRequestPerson
PersonRequest
object
9 properties 3 required
PersonsResponse
object
1 property 1 required
StatusReason
object
2 properties 2 required
Country
string
2-character ISO country code.
PutPersonResponse
object
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
ContactResponsePerson
object
Contact information.
5 properties 5 required
PersonStatus
string
Status of person in Orum system.
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…
MiddleName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
CustomerReferenceId
string
Unique reference id for the customer (business or person) resource. Generated by you.
PersonResponseBase
object
14 properties 7 required
UsBankAccountNumber
string
Account number for US bank account. 4 to 17 digits are acceptable.
OrumId
string
Orum generated unique id for the resource.
Address1
string
Address line 1.
PersonPostalAddressRequest
object
Address.
7 properties 6 required
State
string
Uppercase two-character state code of the address.
DateOfBirth
string
Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and gr…
PatchContactRequestPerson
ReasonCodeMessage
string
A human-readable description of the reason code.
ErrorResponse
object
3 properties 2 required
City
string
City.
PersonPatchPostalAddressRequest
object
Address.
7 properties 1 required
FirstName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-persons-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
AE Profile APIs.io
Orum Balance API
AE Profile APIs.io
Orum Book Transfers API
AE Profile APIs.io
Orum Businesses API
AE Profile APIs.io
Orum Cards API
AE Profile APIs.io
Orum Configure webhooks API
AE Profile APIs.io
Orum Eligibility API
AE Profile APIs.io
Orum External Accounts API
AE Profile APIs.io
Orum Reports API
AE Profile APIs.io
Orum Schedules API
AE Profile APIs.io
Orum Secure webhooks API
AE Profile APIs.io
Orum Subledgers API
AE Profile APIs.io
#Persons
← Back to O APIs
API Details
ID
orum:orum-persons-api
Base URL
https://api.orum.io
Docs
https://docs.orum.io
Provider
Orum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=orum-persons-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/orum-persons-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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