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

Form3 Accounts API

The Accounts API from Form3 — 3 operation(s) for accounts.

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

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 6 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.form3.tech/v1.

6 operations 3 paths 28 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.form3.tech/v1
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Form3 Accounts API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 with Client Credentials Grant type

Paths & Operations 6

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

Accounts 6
GET
/organisation/accounts
List accounts
ListAccounts 12 params → 200
POST
/organisation/accounts
Create account
CreateAccount body → 201
DELETE
/organisation/accounts/{id}
Delete account
DeleteAccount 2 params → 204
GET
/organisation/accounts/{id}
Fetch account
GetAccount 1 param → 200
PATCH
/organisation/accounts/{id}
Amend account
PatchAccount 1 param body → 200
GET
/organisation/accounts/{id}/events
Fetch account events
GetAccountEvents 3 params → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AccountAttributes (32 properties), AccountAttributesOrganisationIdentification (10 properties), AccountAttributesPrivateIdentification (9 properties), AccountEventAttributes (6 properties). Each schema is shown below with its type and property counts.

AcceptanceQualifier
string
All accepted payments will receive the matching qualifier code
ValidationType
string
optional validation to apply to the account
AccountEventListResponse
object
2 properties
AccountAttributesOrganisationIdentificationActor
object
4 properties
AccountAmendment
object
1 property
AccountCreationResponse
object
2 properties
AccountEventRelationships
object
1 property
Account
object
6 properties 3 required
RelationshipLinks
object
1 property
AccountWithBankId
object
2 properties
BankIdCode
string
Links
object
5 properties 1 required
AccountAttributesPrivateIdentification
object
9 properties
AccountRelationships
object
2 properties
AccountCreation
object
1 property 1 required
AccountAttributes
object
32 properties 1 required
AccountEvent
object
6 properties 5 required
AccountEventAttributes
object
6 properties 4 required
SwitchedAccountDetails
object
Alternate Account details to use in case the account has been switched away from this organisation.
5 properties 4 required
StatusReason
string
Used to determine appropriate scheme or internal payment reject code. Account status field must be set to closed to use this functionality.
RelationshipAccount
object
1 property
AccountDetailsResponse
object
2 properties
AccountUpdate
object
6 properties 4 required
UserDefinedData
object
2 properties 2 required
AccountDetailsListResponse
object
2 properties
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties 2 required
RelationshipData
object
2 properties
AccountAttributesOrganisationIdentification
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-accounts-api-openapi.yml Raw ↑

Other APIs Form3 publishes across the network.

Form3 Account Identification API
Form3 Account Validation API
Form3 ACE API
Form3 Audit API
Form3 Branches API
Form3 Branch Identification API
Form3 Claims API
Form3 Direct Debits API
Form3 Direct Debits Reads API
Form3 Mandates API
Form3 Metrics API
Form3 Name Verification API
Where this information came from

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