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 Transaction File API

The Transaction File API API from Form3 — 7 operation(s) for transaction file api.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 7 paths, and defines 36 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.

10 operations 7 paths 36 schemas 5 GET1 PATCH3 POST1 PUT

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 Transaction File 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 10

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

Transaction File API 10
GET
/files/transactions
List transaction files
ListTransactionFiles 16 params → 200400401403500
POST
/files/transactions
Creates a Transaction File
CreateTransactionFile body → 201400401403409500
GET
/files/transactions/{transaction_file_id}
Fetch transaction file
GetTransactionFile 2 params → 200401403404500
PUT
/files/transactions/{transaction_file_id}
Put Transaction file chunk
UploadTransactionFile 2 params body → 200400401403404409500
POST
/files/transactions/{transaction_file_id}/admissions
Creates a Transaction File Admission
CreateTransactionFileAdmission 1 param body → 201400401403404409500
GET
/files/transactions/{transaction_file_id}/admissions/{transaction_file_admission_id}
Fetch transaction file admission
GetTransactionFileAdmission 2 params → 200401403404500
POST
/files/transactions/{transaction_file_id}/submissions
Creates a Transaction File Submission
CreateTransactionFileSubmission 1 param body → 201400401403404409500
GET
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}
Fetch transaction file submission
GetTransactionFileSubmission 2 params → 200401403404500
GET
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id}
Fetch transaction file submission task
GetTransactionFileSubmissionTask 3 params → 200401403404500
PATCH
/files/transactions/{transaction_file_id}/submissions/{transaction_file_submission_id}/tasks/{task_id}
Amend transaction file submission task
PatchTransactionFileSubmissionTask 3 params body → 200400403404409500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are TransactionFileAttributes (9 properties), ListTransactionFileItem (8 properties), TransactionFileSubmission (8 properties), TransactionFileSubmissionTask (8 properties). Each schema is shown below with its type and property counts.

TransactionFileSubmissionTask
object
8 properties 2 required
TransactionFileSubmissionTaskStatus
string
Processing status of the task
TransactionFileResponse
object
2 properties
TransactionFileAdmission
object
8 properties 2 required
TransactionFileSubmission
object
8 properties 2 required
NewTransactionFile
object
4 properties 3 required
ListTransactionFilesResponse
object
2 properties 1 required
TransactionFile
object
8 properties 3 required
TransactionFileAttributes
object
9 properties 7 required
Links
object
5 properties 1 required
ListTransactionFileItem
object
8 properties 3 required
ListTransactionFileItemRelationships
object
4 properties
TransactionFileRelationships
object
4 properties
TransactionFileAdmissionRelationships
object
1 property
TransactionFileSubmissionTaskResponse
object
2 properties
TransactionFileSubmissionShortRelationship
object
3 properties 1 required
TransactionFileAdmissionResponse
object
2 properties
ApiErrorWithActualResource
object
3 properties
TransactionFileSubmissionTaskRelationships
object
Thin relationships returned on GET (id and type only)
3 properties
TransactionFileCreation
object
1 property 1 required
TransactionFileSubmissionConflictError
object
3 properties
TransactionFileAdmissionCreation
object
1 property 1 required
TransactionFileSubmissionSchemeReference
object
5 properties
TransactionFileLink
object
2 properties 1 required
TransactionFileLinks
object
1 property 1 required
TransactionFileSubmissionTaskAttributes
object
6 properties
TransactionFileSubmissionResponse
object
2 properties
ThinRelationship
object
1 property
TransactionFileSubmissionStatus
string
Status of the transaction file submission
TransactionFileSubmissionCreation
object
1 property 1 required
TransactionFileSubmissionTaskAmendment
object
1 property 1 required
TransactionFileAdmissionStatus
string
Status of the transaction file admission
TransactionFileSubmissionTaskUpdate
object
4 properties
TransactionFileSubmissionTaskOutcome
string
Result of the task when in a terminal state
ApiError
object
2 properties
TransactionFileSubmissionRelationships
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-transaction-file-api-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 Mandates API
AE Profile APIs.io
Form3 Metrics API
AE Profile APIs.io
#Transaction File API
← Back to F APIs
API Details
ID
form3:form3-transaction-file-api-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-transaction-file-api-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/form3-transaction-file-api-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 Transaction File 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.