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

The query_api API from Form3 — 10 operation(s) for query_api.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Query 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 11 operations across 10 paths, and defines 92 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 10 paths 92 schemas 7 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 Query 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 10 paths, the API surfaces 11 operations — 7 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

query_api 11
GET
/transaction/queries
Get Query
ListQueries 16 params → 200400502
POST
/transaction/queries
Create a Query
CreateQuery body → 201400403502
GET
/transaction/queries/{query_id}
Fetch a Query
GetQuery 1 param → 200400403
GET
/transaction/queries/{query_id}/admissions/{query_admission_id}
Fetch a Query Admission
GetQueryAdmission 2 params → 200400403
POST
/transaction/queries/{query_id}/responses
Create a Query Response
CreateQueryResponse 1 param body → 201400403502
GET
/transaction/queries/{query_id}/responses/{query_response_id}
Fetch a Query Response
GetQueryResponse 2 params → 200400403
GET
/transaction/queries/{query_id}/responses/{query_response_id}/admissions/{query_response_admission_id}
Fetch a Query Response Admission
GetQueryResponseAdmission 3 params → 200400403
POST
/transaction/queries/{query_id}/responses/{query_response_id}/submissions
Create a Query Response Submission
CreateQueryResponseSubmission 2 params body → 201400403502
GET
/transaction/queries/{query_id}/responses/{query_response_id}/submissions/{query_response_submission_id}
Fetch a Query Response Submission
GetQueryResponseSubmission 3 params → 200400403
POST
/transaction/queries/{query_id}/submissions
Create a Query submission
CreateQuerySubmission 1 param body → 201400403502
GET
/transaction/queries/{query_id}/submissions/{query_submission_id}
Fetch a Query submission
GetQuerySubmission 2 params → 200400403

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are QueryBeneficiaryDebtorParty (23 properties), QueryUltimateEntity (19 properties), QueryAttributes (12 properties), RequestForInformationCreatorParty (11 properties). Each schema is shown below with its type and property counts.

RelationshipsQuery
object
1 property
QueryResponseAnswer
string
RequestForInformationReferences
array
QueryResponseSubmissionCreation
object
1 property 1 required
QueryResponseAttributes
object
7 properties 1 required
RelationshipsPaymentAdmissionProperties
object
2 properties 2 required
RelationshipQueryResponseAdmission
object
1 property
QuerySubmissionCreation
object
1 property 1 required
Links
object
5 properties 1 required
QueryBeneficiaryDebtorOrganisationIdentification
object
4 properties
RelationshipsQueryResponseProperties
object
2 properties 2 required
RelationshipsFullQueryResponse
object
1 property
RelationshipsPaymentSubmission
object
1 property
QueryResponseResponse
object
2 properties 1 required
RelationshipsQueryAdmission
object
1 property
RelationshipsPaymentSubmissionProperties
object
2 properties 2 required
QuerySubmissionRelationships
object
1 property 1 required
QueryResourceType
string
QueryResponseRelationships
object
3 properties
Query
object
8 properties 5 required
RelationshipsPaymentProperties
object
2 properties 2 required
RequestForInformationAgents
array
RelationshipsQuerySubmission
object
1 property
NewQuerySubmission
object
3 properties 3 required
QuerySubmission
object
8 properties 5 required
PaymentAdmissionResourceType
string
PaymentTypeInformation
object
Set of elements used to further specify the type of transaction.
8 properties
NewQuery
object
5 properties 4 required
QueryResponseSubmissionStatus
string
NewQueryResponseSubmission
object
4 properties 3 required
QuerySubmissionAttributes
object
2 properties
PaymentRecallSubmissionResourceType
string
QueryResponseResourceType
string
RequestForInformationRequestedInformation
array
QueryAdmissionAttributes
object
2 properties 1 required
QueryAdmissionResponse
object
2 properties 1 required
QueryResponseSubmissionResourceType
string
QueryAdmissionStatus
string
QueryResponseAdmissionRelationships
object
4 properties
QueryResponse
object
8 properties 5 required
NewQueryResponse
object
4 properties 4 required
QueryAdmissionRelationships
object
1 property 1 required
DuplicateTransactionInformation
object
3 properties
RelationshipsFullQuery
object
1 property
RelationshipsPaymentRecallProperties
object
2 properties 2 required
RequestForInformationAgentBankId
object
2 properties
QueryBeneficiaryDebtorAccountProxy
object
3 properties
QueryResponseStatusCode
string
QueryResponseSubmission
object
8 properties 5 required
PaymentRecallResourceType
string
RelationshipsPaymentRecallSubmissionProperties
object
2 properties 2 required
RelationshipsPayment
object
1 property
QueryListResponse
object
2 properties 2 required
QueryFetchResponse
object
2 properties 1 required
RelationshipQueryResponseSubmission
object
1 property
QueryAdmissionResourceType
string
QueryResponseCompensation
object
4 properties
QueryReference
object
Arbitrary references for payment or case. Defined by a pair of reference type and reference value.
2 properties 2 required
QueryResponseAdmissionResponse
object
2 properties 1 required
QueryRelationships
object
9 properties
QueryResponseAdmissionAttributes
object
2 properties 1 required
QueryResponseAdmissionResourceType
string
QueryResponseAdmissionStatus
string
CorrectionTransactionInformation
object
References a transaction initiated to fix the case under investigation.
8 properties
QueryResponseSubmissionAttributes
object
3 properties
QueryResponseCharges
object
4 properties
QuerySubmissionStatus
string
ApiError
object
2 properties
QuerySubmissionResponse
object
2 properties 1 required
RelationshipsPaymentAdmission
object
1 property
QueryResponseSubmissionRelationships
object
2 properties
QueryResponseSubmissionResponse
object
2 properties 1 required
QueryAttributes
object
12 properties 1 required
RelationshipsPaymentRecallSubmission
object
1 property
PaymentSubmissionResourceType
string
QueryAdmission
object
8 properties 5 required
QueryResponseCreation
object
1 property 1 required
RequestForInformationCreatorParty
object
11 properties
QueryAccountNumberCode
string
The type of identification given at accountnumber attribute
QuerySubmissionResourceType
string
PaymentResourceType
string
RelationshipsQueryProperties
object
2 properties 2 required
RelationshipsQueryResponse
object
1 property
NewQueryRelationships
object
6 properties
QueryUltimateEntity
object
19 properties
QueryResponseAdmission
object
8 properties 5 required
QueryResponseInformation
object
8 properties
RequestForInformationQuerySubTypes
array
QueryBeneficiaryDebtorParty
object
23 properties
QueryCreation
object
1 property 1 required
RelationshipsPaymentRecall
object
1 property
QueryPrivateIdentification
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

form3-query-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
#Query API
← Back to F APIs
API Details
ID
form3:form3-query-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-query-api-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/form3-query-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 Query 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.