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

Formance Auth API

OAuth2 / OIDC authorization server, clients, and users.

Formance Auth API is one of 8 APIs that Formance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 8 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://{organization}.{environment}.formance.cloud.

11 operations 8 paths 1 schemas 2 DELETE5 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://{organization}.{environment}.formance.cloud/api/ledger
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Formance Auth API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth2 client-credentials flow. Exchange a client id and secret at /api/auth/oauth/token for a Bearer access token, then send it as Authorization: Bearer .

Paths & Operations 11

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

Auth 11

OAuth2 / OIDC authorization server, clients, and users.

POST
/api/auth/oauth/token
Request an OAuth2 access token
createToken body → 200
GET
/api/auth/.well-known/openid-configuration
Retrieve OpenID Connect configuration
getOIDCWellKnowns → 200
GET
/api/auth/clients
List OAuth clients
listClients → 200
POST
/api/auth/clients
Create an OAuth client
createClient body → 201
GET
/api/auth/clients/{clientId}
Read an OAuth client
readClient 1 param → 200
PUT
/api/auth/clients/{clientId}
Update an OAuth client
updateClient 1 param → 200
DELETE
/api/auth/clients/{clientId}
Delete an OAuth client
deleteClient 1 param → 204
POST
/api/auth/clients/{clientId}/secrets
Add a secret to a client
createSecret 1 param → 200
DELETE
/api/auth/clients/{clientId}/secrets/{secretId}
Delete a client secret
deleteSecret 2 params → 204
GET
/api/auth/users
List users
listUsers → 200
GET
/api/auth/users/{userId}
Read a user
readUser 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ClientOptions (4 properties). Each schema is shown below with its type and property counts.

ClientOptions
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

formance-auth-api-openapi.yml Raw ↑

Other APIs Formance publishes across the network.

Formance Ledger API
Formance Orchestration API
Formance Payments API
Formance Reconciliation API
Formance Search API
Formance Wallets API
Formance Webhooks API
Where this information came from

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