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
Lorum

Lorum Customers API

The Customers API from Lorum — 10 operation(s) for customers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Lorum Customers API is one of 10 APIs that Lorum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 14 operations across 10 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: https://api.fuse.me, https://api-sandbox.fuse.me.

14 operations 10 paths 43 schemas 1 DELETE5 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.fuse.me
Authentication
HTTP Bearer
Contact
Lorum
License
Proprietary license
Resource Areas
1

Authentication & Security 1

Lorum Customers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (OAuth2). By default, every request must be authenticated.

Paths & Operations 14

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

Customers 14
POST
/v1/customers/businesses
Add business
add_business 1 param body → 201400401409500
POST
/v1/customers/individuals
Add individual
add_individual 1 param body → 201400401409500
POST
/v1/customers/businesses/{customer_id}/shareholdersdeprecated
Add a shareholder to a business
add_shareholder 1 param body → 201400401500
GET
/v1/customers/businesses/{customer_id}/shareholdersdeprecated
List shareholders for a business
list_shareholders 1 param → 200400401500
PATCH
/v1/customers/{customer_id}/archive
Archive the customer so it is no longer available for use in the system.
archive_customer 1 param → 204400401500
GET
/v1/customers/{customer_id}
Get customer
get_customer 1 param → 200
PATCH
/v1/customers/{customer_id}
Update customer
update_customer 1 param body → 204400401409500
GET
/v1/customers/{customer_id}/onboarding/{currency}
Get Customer Onboarding Status for a specific currency
get_customer_onboarding 2 params → 200
POST
/v1/customers/{customer_id}/onboarding/{currency}
Onboard a customer for a specific currency
onboard_customer 2 params → 201400401500
GET
/v1/customers/businesses/shareholders/{shareholder_id}deprecated
Get a shareholder
get_shareholder 1 param → 200400401500
PATCH
/v1/customers/businesses/shareholders/{shareholder_id}deprecated
Update a shareholder
update_shareholder 1 param body → 204400401500
POST
/v1/customers/{customer_id}/documents
Submit a document
link_document 1 param body → 200400401500
GET
/v1/customers
List customers
list_customers 4 params → 200
DELETE
/v1/customers/{customer_id}/documents/{document_id}
Unlink a document from a customer.
unlink_document 2 params → 204400401500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are AddBusinessRequest (12 properties), AddIndividualRequest (12 properties), CustomerSummary (6 properties), Address (5 properties). Each schema is shown below with its type and property counts.

UpdateCustomerRequest
RejectionReason
string
RegulatoryLicenseType
string
AddIndividualRequest
object
12 properties 8 required
DocumentSummary
object
3 properties 3 required
ErrorResponse
object
User-facing error type. This is the general error structure returned by all api routes.
3 properties 3 required
ListCustomersResponse
object
2 properties 2 required
CustomerTypeFilter
string
Customer
Currency
string
ErrorCode
string
CustomerRelationshipType
Represents the relationship between a customer and the organisation.
AddShareholderRequest
Company 1 |-- Shareholder 1 (Business) | |-- Shareholder 3 (Individual) |-- Shareholder 2 (Business) | |-- Shareholder 4 (Business) |-- Shareholder 5 (Individu…
Address
object
5 properties 2 required
LinkDocumentRequest
object
1 property 1 required
CustomerSummary
object
6 properties 6 required
ApprovalStatus
string
OnboardingCurrency
string
AddShareholderResponse
object
1 property 1 required
IndividualCurrencyExtra
Represents the currency specific data for an individual.
UpdateCustomerExtraAPI
Cursor_String
object
2 properties 1 required
IndividualIdentification
Individual Identification Identification document of an individual.
Shareholder
Onboarding
object
3 properties 3 required
AedLicenseIssuer
string
ShareholderSummary
object
5 properties 4 required
AddBusinessRequest
object
12 properties 6 required
DocumentType
string
Types of documents that can be uploaded for customers and transactions.
UpdateAddress
object
5 properties
Gender
string
AddShareholder
AddCustomerResponse
object
1 property 1 required
OnboardingStatus
WatchlistIdType
string
OnboardingError
object
2 properties 2 required
UpdateShareholderRequest
GetCustomerResponse
BusinessCurrencyExtra
Represents the currency specific data for a business.
UpdateShareholder
GetShareholderResponse
ShareholderType
string
CustomerExtraAPI

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lorum-customers-api-openapi.yml Raw ↑

Other APIs Lorum publishes across the network.

Lorum Accounts API
AE Profile APIs.io
Lorum Customers V2 API
AE Profile APIs.io
Lorum Documents API
AE Profile APIs.io
Lorum Exchange API
AE Profile APIs.io
Lorum Internal Transfers API
AE Profile APIs.io
Lorum Oauth API
AE Profile APIs.io
Lorum Payments API
AE Profile APIs.io
Lorum Simulation API
AE Profile APIs.io
Lorum Transactions API
AE Profile APIs.io
#Customers
← Back to L APIs
API Details
ID
lorum:lorum-customers-api
Base URL
https://api.fuse.me
Docs
https://docs.lorum.com/docs/getting-started
Provider
Lorum
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=lorum-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lorum-customers-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 Lorum Customers 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.