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

The Reports API from Form3 — 4 operation(s) for reports.

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

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

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

4 operations 4 paths 26 schemas 4 GET

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 Reports 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 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Reports 4
GET
/notification/reports
List reports
ListReports 12 params → 200400403
GET
/notification/reports/{id}
Get report by ID
GetReport 2 params → 200400403404406
GET
/notification/reports/{id}/admissions/{admissionId}
Get Report Admission by ID
GetReportAdmissionByID 2 params → 200400403404
GET
/notification/reports/{id}/content
Get report content by ID
GetReportContent 2 params → 200400403404406

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are ReportAdmission (8 properties), ReportRequestSubmission (8 properties), Report (8 properties), ReportRequest (8 properties). Each schema is shown below with its type and property counts.

ReportRequestAttributes
object
4 properties 4 required
ReportRequestSubmission
object
8 properties 6 required
ReportUsers
array
Users or organisations this report was generated for
ReportRequestSubmissionRelationships
object
1 property
ReportAttributes
object
7 properties
Report
object
8 properties 3 required
ReportLinks
object
1 property 1 required
ReportAdmissionRelationships
object
1 property
ReportRequest
object
8 properties 3 required
ReportRequestRelationships
object
2 properties
ReportRequestSubmissionStatus
string
ReportLink
object
2 properties 1 required
Links
object
5 properties 1 required
ReportAdmissionStatus
string
ReportUser
object
2 properties
ReportRequestStatus
string
ReportRequestSubmissionAttributes
object
3 properties 1 required
ReportDetailsListResponse
object
2 properties 1 required
ReportRequestFilter
object
3 properties 1 required
ReportAdmission
object
8 properties 2 required
ReportDetailsResponse
object
2 properties 1 required
ThinRelationship
object
1 property
ReportAdmissionAttributes
object
4 properties
ReportAdmissionDetailsResponse
object
2 properties 1 required
ApiError
object
2 properties
ReportRelationships
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-reports-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 Reports 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.