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

The Claims API from Form3 — 8 operation(s) for claims.

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

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

This API exposes 9 operations across 8 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.

9 operations 8 paths 22 schemas 5 GET4 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 Claims 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 9

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

Claims 9
GET
/transaction/claims
List claims
19 params → 200
POST
/transaction/claims
Create Claim
body → 201400
GET
/transaction/claims/{id}
Fetch claim
1 param → 200400404
POST
/transaction/claims/{id}/reversals
Create Claim Reversal
1 param body → 201400404
GET
/transaction/claims/{id}/reversals/{reversalId}
Fetch Claim Reversal
2 params → 200400404
POST
/transaction/claims/{id}/reversals/{reversalId}/submissions
Create Claim Reversal Submission
2 params body → 201400404
GET
/transaction/claims/{id}/reversals/{reversalId}/submissions/{submissionId}
Fetch Claim Reversal Submission
3 params → 200400404
POST
/transaction/claims/{id}/submissions
Create Claim Submission
1 param body → 201400404
GET
/transaction/claims/{id}/submissions/{submissionId}
Fetch Claim Submission
2 params → 200400404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ClaimAttributes (12 properties), ClaimReversalSubmission (8 properties), Claim (8 properties), ClaimReversal (8 properties). Each schema is shown below with its type and property counts.

ClaimReversalSubmissionCreation
object
1 property 1 required
ClaimReversalSubmission
object
8 properties 2 required
ClaimSubmissionDetailsResponse
object
2 properties
DisputedTransaction
object
2 properties 2 required
ClaimReversalSubmissionRelationships
object
2 properties
ClaimReversal
object
8 properties 3 required
Links
object
5 properties 1 required
ClaimReversalCreation
object
1 property 1 required
ClaimSubmissionRelationships
object
1 property
ClaimAttributes
object
12 properties 9 required
ClaimDetailsResponse
object
2 properties
ClaimReversalRelationships
object
2 properties
ClaimDetailsListResponse
object
2 properties
ClaimSubmissionCreation
object
1 property 1 required
ClaimSubmissionStatus
string
ClaimReversalSubmissionDetailsResponse
object
2 properties
ClaimRelationships
object
2 properties
ClaimCreation
object
1 property
Claim
object
8 properties 3 required
ClaimReversalDetailsResponse
object
2 properties
ClaimSubmission
object
8 properties 2 required
ApiError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-claims-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 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 Claims 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.