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

The Branches API from Form3 — 2 operation(s) for branches.

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

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

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

5 operations 2 paths 14 schemas 1 DELETE2 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 Branches 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 5

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

Branches 5
GET
/organisation/branches
List branches
ListBranches 8 params → 200
POST
/organisation/branches
Create a Branch
CreateBranch body → 201409
DELETE
/organisation/branches/{id}
Delete branch
DeleteBranch 2 params → 204
GET
/organisation/branches/{id}
Fetch branch
GetBranch 1 param → 200
PATCH
/organisation/branches/{id}
Amend branch
PatchBranch 1 param body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Branch (7 properties), BranchAttributes (6 properties), Links (5 properties), BranchUpdate (5 properties). Each schema is shown below with its type and property counts.

UserDefinedData
object
2 properties 2 required
ReferenceMask
string
Account number of the account. A unique number will automatically be generated if not provided.
BranchDetailsListResponse
object
2 properties
Branch
object
7 properties 3 required
BranchCreation
object
1 property 1 required
AcceptanceQualifier
string
All accepted payments will receive the matching qualifier code
Links
object
5 properties 1 required
BranchCreationResponse
object
2 properties
BranchAttributes
object
6 properties 2 required
BranchDetailsResponse
object
2 properties
ApiError
object
2 properties
BranchUpdate
object
5 properties 4 required
BranchValidationType
string
optional validation to apply to the branch
BranchAmendment
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-branches-api-openapi.yml Raw ↑

Other APIs Form3 publishes across the network.

Form3 Account Identification API
Form3 Accounts API
Form3 Account Validation API
Form3 ACE API
Form3 Audit 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 Branches 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.