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

The Scheme File API API from Form3 — 6 operation(s) for scheme file api.

Form3 Scheme 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 Scheme 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 8 operations across 6 paths, and defines 22 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.

8 operations 6 paths 22 schemas 4 GET3 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 Scheme 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 8

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

Scheme File API 8
GET
/files/schemefiles
List Scheme files
ListSchemeFiles 14 params → 200400401403500
POST
/files/schemefiles
Creates a Scheme File
CreateSchemeFile body → 201400401403409500
GET
/files/schemefiles/{scheme_file_id}
Get Scheme file
GetSchemeFile 2 params → 200401403404500
PUT
/files/schemefiles/{scheme_file_id}
Put Scheme file chunk
UploadSchemeFile 2 params body → 200400401403404409500
POST
/files/schemefiles/{scheme_file_id}/admissions
Creates a Scheme File Admission
CreateSchemeFileAdmission 1 param body → 201400401403404409500
GET
/files/schemefiles/{scheme_file_id}/admissions/{scheme_file_admission_id}
Fetch scheme file admission
GetSchemeFileAdmission 2 params → 200401403404500
POST
/files/schemefiles/{scheme_file_id}/submissions
Creates a Scheme File Submission
CreateSchemeFileSubmission 1 param body → 201400401403404409500
GET
/files/schemefiles/{scheme_file_id}/submissions/{scheme_file_submission_id}
Get Scheme file submission
GetSchemeFileSubmission 2 params → 200401403404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SchemeFileAdmission (8 properties), SchemeFile (8 properties), SchemeFileSubmission (8 properties), SchemeFileAttributes (7 properties). Each schema is shown below with its type and property counts.

SchemeFileResponse
object
2 properties 1 required
SchemeFileAdmissionResponse
object
2 properties
SchemeFileLinks
object
1 property 1 required
SchemeFileLink
object
2 properties 1 required
ListSchemeFilesResponse
object
2 properties 1 required
SchemeFileAdmission
object
8 properties 2 required
Links
object
5 properties 1 required
SchemeFileAdmissionStatus
string
Status of the scheme file admission
SchemeFile
object
8 properties 3 required
SchemeFileAttributes
object
7 properties 7 required
SchemeFileAdmissionRelationships
object
1 property
SchemeFileSubmission
object
8 properties 2 required
SchemeFileSubmissionResponse
object
2 properties
SchemeFileRelationships
object
2 properties
SchemeFileAdmissionCreation
object
1 property 1 required
SchemeFileSubmissionRelationships
object
1 property
SchemeFileCreation
object
1 property 1 required
SchemeFileSubmissionStatus
string
Status of the scheme file submission
SchemeFileSubmissionCreation
object
1 property 1 required
ApiError
object
2 properties
NewSchemeFile
object
4 properties 3 required
SchemeFileSubmissionConflictError
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-scheme-file-api-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 Branches API
Form3 Branch Identification API
Form3 Claims API
Form3 Direct Debits API
Form3 Direct Debits Reads API
Form3 Mandates API
Form3 Metrics API
Where this information came from

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