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
Form3

Form3 Mandates API

The Mandates API from Form3 — 9 operation(s) for mandates.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 9 paths, and defines 39 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.

11 operations 9 paths 39 schemas 6 GET1 PATCH4 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 Mandates 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 11

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

Mandates 11
GET
/transaction/mandates
List mandates
GetMandates 27 params → 200
POST
/transaction/mandates
Create Mandate
PostMandates body → 201400409
GET
/transaction/mandates/{id}
Fetch mandate
GetMandatesID 1 param → 200404
PATCH
/transaction/mandates/{id}
Update mandate
PatchMandatesID 1 param body → 200400404409
GET
/transaction/mandates/{id}/admissions/{admissionId}
Fetch Mandate Admission
GetMandatesIDAdmissionsAdmissionID 2 params → 200404
POST
/transaction/mandates/{id}/returns
Create mandate return
PostMandatesIDReturns 1 param body → 201400404409
GET
/transaction/mandates/{id}/returns/{returnId}
Fetch mandate return
GetMandatesIDReturnsReturnID 2 params → 200404
POST
/transaction/mandates/{id}/returns/{returnId}/submissions
Create mandate return submission
PostMandatesIDReturnsReturnIDSubmissions 2 params body → 201400404409
GET
/transaction/mandates/{id}/returns/{returnId}/submissions/{submissionId}
Fetch return submission
GetMandatesIDReturnsReturnIDSubmissionsSubmissionID 3 params → 200404
POST
/transaction/mandates/{id}/submissions
Create Mandate Submission
PostMandatesIDSubmissions 1 param body → 201400409
GET
/transaction/mandates/{id}/submissions/{submissionId}
Fetch Mandate Submission
GetMandatesIDSubmissionsSubmissionID 2 params → 200400404

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are MandateAttributes (16 properties), MandateReturnSubmission (8 properties), MandateAdmission (8 properties), MandateAttributesBeneficiaryParty (8 properties). Each schema is shown below with its type and property counts.

ApiError
object
2 properties
MandateAttributesDebtorParty
object
6 properties
MandateSubmissionStatus
string
MandateCreation
object
1 property
MandateAdmissionRelationships
object
1 property
MandateAdmission
object
8 properties
MandateAttributes
object
16 properties
MandateAdmissionDetailsResponse
object
2 properties
MandateReturnSubmissionCreationResponse
object
2 properties
MandateDetailsResponse
object
2 properties
AccountWithBankId
object
2 properties
MandateStatus
stringnull
BankIdCode
string
Links
object
5 properties 1 required
MandateReturnSubmissionCreation
object
1 property
MandateSubmissionDetailsResponse
object
2 properties
MandateDetailsListResponse
object
2 properties
MandateReturn
object
8 properties
MandateAmendment
object
1 property
MostRecentCollection
object
2 properties
Mandate
object
8 properties 2 required
PrivateIdentification
object
4 properties
MandateSubmissionCreation
object
1 property
MandateFrequency
string
MandateReturnSubmission
object
8 properties
MandateAdmissionStatusReason
string
MandateCreationResponse
object
2 properties
MandateRelationships
object
4 properties
MandateReturnSubmissionStatus
string
AccountNumberCode
string
The type of identification given at accountnumber attribute
MandateReturnDetailsResponse
object
2 properties
MandateReturnSubmissionDetailsResponse
object
2 properties
MandateAdmissionStatus
string
MandateReturnCreation
object
1 property
MandateReturnCreationResponse
object
2 properties
MandateSubmission
object
8 properties
AccountHoldingEntity
object
Information about the financial institution servicing the account.
6 properties 2 required
MandateAttributesBeneficiaryParty
object
8 properties
MandateSubmissionRelationships
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-mandates-api-openapi.yml Raw ↑

Other APIs Form3 publishes across the network.

Form3 Account Identification API
AE Profile APIs.io
Form3 Accounts API
AE Profile APIs.io
Form3 Account Validation API
AE Profile APIs.io
Form3 ACE API
AE Profile APIs.io
Form3 Audit API
AE Profile APIs.io
Form3 Branches API
AE Profile APIs.io
Form3 Branch Identification API
AE Profile APIs.io
Form3 Claims API
AE Profile APIs.io
Form3 Direct Debits API
AE Profile APIs.io
Form3 Direct Debits Reads API
AE Profile APIs.io
Form3 Metrics API
AE Profile APIs.io
Form3 Name Verification API
AE Profile APIs.io
#Mandates
← Back to F APIs
API Details
ID
form3:form3-mandates-api
Base URL
https://api.form3.tech/v1
Docs
https://www.api-docs.form3.tech/
Provider
Form3
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=form3-mandates-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/form3-mandates-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 Form3 Mandates 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.