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

The Users API from Form3 — 11 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 17 operations across 11 paths, and defines 23 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.

17 operations 11 paths 23 schemas 3 DELETE7 GET1 PATCH6 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 Users 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 17

Across 11 paths, the API surfaces 17 operations — 3 DELETE, 7 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Users 17
GET
/security/users
List all users
ListAllUsers 2 params → 200
POST
/security/users
Create user
CreateUser body → 201400409
DELETE
/security/users/{user_id}
Delete user
DeleteUser 2 params → 204404409
GET
/security/users/{user_id}
Fetch user
FetchUser 1 param → 200404
PATCH
/security/users/{user_id}
Update user details
UpdateUserDetails 1 param body → 200400404
GET
/security/users/{user_id}/aces
Fetch access control list for user
FetchAccessControlListForUser 3 params → 200404
GET
/security/users/{user_id}/authn/public_keys
List all public keys associated with the user
ListPublicKeysForUser 1 param → 200404
POST
/security/users/{user_id}/authn/public_keys
Create a new public key for user
CreatePublicKeyForUser 1 param body → 201400403404409
GET
/security/users/{user_id}/authn/public_keys/{public_key_id}
Fetch public key for user
FetchPublicKeyForUser 2 params → 200404
POST
/security/users/{user_id}/authn/public_keys/{public_key_id}/cancel_deletion
Cancel key deletion
CancelPublicKeyDeletion 3 params → 204400403404409
POST
/security/users/{user_id}/authn/public_keys/{public_key_id}/schedule_deletion
Schedule key deletion
SchedulePublicKeyDeletion 3 params → 200400403404409
GET
/security/users/{user_id}/credentials
Fetch credentials for user
FetchCredentialsForUser 1 param → 200404
POST
/security/users/{user_id}/credentials
Create new credentials for user
CreateNewCredentialsForUser 1 param → 201404
DELETE
/security/users/{user_id}/credentials/{client_id}
Delete credentials for user
DeleteCredentialsForUser 2 params → 204404
GET
/security/users/{user_id}/roles
Fetch all roles for user
FetchAllRolesForUser 1 param → 200404
DELETE
/security/users/{user_id}/roles/{role_id}
Remove role from user
RemoveRoleFromUser 2 params → 204404
POST
/security/users/{user_id}/roles/{role_id}
Add role to user
AddRoleToUser 2 params → 201404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are PublicKey (8 properties), Ace (5 properties), User (5 properties), Links (5 properties). Each schema is shown below with its type and property counts.

UserCreation
object
1 property 1 required
PublicKeyCreation
object
1 property 1 required
PublicKeyCreationResponse
object
2 properties 1 required
Ace
object
5 properties 3 required
UserCredentialListResponse
object
2 properties 1 required
PublicKey
object
8 properties
PublicKeyResponse
object
2 properties 1 required
Credential
object
1 property
Links
object
5 properties 1 required
Role
object
5 properties
KeyState
string
Current lifecycle state of the key
User
object
5 properties
UserRoleListResponse
object
2 properties 1 required
PublicKeysListResponse
object
2 properties 1 required
UserCreationResponse
object
2 properties 1 required
CredentialSecret
object
2 properties
UserDetailsListResponse
object
2 properties 1 required
AceDetailsListResponse
object
2 properties 1 required
CredentialCreationResponse
object
2 properties 1 required
RoleAttributes
object
2 properties
ScheduleDeletionResponse
object
1 property
ApiError
object
2 properties
UserDetailsResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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