# Form3 Users API

**Canonical:** https://apis.io/apis/form3/form3-users-api/  
**Provider:** Form3 — https://apis.io/providers/form3/  
**Base URL:** https://api.form3.tech/v1  
**Documentation:** https://www.api-docs.form3.tech/

Form3 Users API is one of 28 APIs that [Form3](https://apis.io/providers/form3/) publishes on the [APIs.io](https://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.

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

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/security/users` | List all users |
| POST | `/security/users` | Create user |
| DELETE | `/security/users/{user_id}` | Delete user |
| GET | `/security/users/{user_id}` | Fetch user |
| PATCH | `/security/users/{user_id}` | Update user details |
| GET | `/security/users/{user_id}/aces` | Fetch access control list for user |
| GET | `/security/users/{user_id}/authn/public_keys` | List all public keys associated with the user |
| POST | `/security/users/{user_id}/authn/public_keys` | Create a new public key for user |
| GET | `/security/users/{user_id}/authn/public_keys/{public_key_id}` | Fetch public key for user |
| POST | `/security/users/{user_id}/authn/public_keys/{public_key_id}/cancel_deletion` | Cancel key deletion |
| POST | `/security/users/{user_id}/authn/public_keys/{public_key_id}/schedule_deletion` | Schedule key deletion |
| GET | `/security/users/{user_id}/credentials` | Fetch credentials for user |
| POST | `/security/users/{user_id}/credentials` | Create new credentials for user |
| DELETE | `/security/users/{user_id}/credentials/{client_id}` | Delete credentials for user |
| GET | `/security/users/{user_id}/roles` | Fetch all roles for user |
| DELETE | `/security/users/{user_id}/roles/{role_id}` | Remove role from user |
| POST | `/security/users/{user_id}/roles/{role_id}` | Add role to user |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/form3/refs/heads/main/openapi/form3-users-api-openapi.yml
- **Documentation** — https://www.api-docs.form3.tech/
- **APIReference** — https://api-docs.form3.tech/api.html
- **GettingStarted** — https://www.api-docs.form3.tech/api/tutorials/getting-started/introduction
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/getting-started/send-a-payment
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/getting-started/receive-a-payment
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/bacs/receive-a-direct-debit
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/confirmation-of-payee/cop-tutorial
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/bacs/send-transactions-in-a-file
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/event-notifications/subscriptions-for-event-notifications
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/event-notifications/verify-event-notifications
- **Documentation** — https://www.api-docs.form3.tech/api/tutorials/security/create-a-read-only-user

## Other Form3 APIs (12)

- [Form3 Account Identification API](https://apis.io/apis/form3/form3-accountidentification-api/)
- [Form3 Accounts API](https://apis.io/apis/form3/form3-accounts-api/)
- [Form3 Account Validation API](https://apis.io/apis/form3/form3-accountvalidation-api/)
- [Form3 ACE API](https://apis.io/apis/form3/form3-ace-api/)
- [Form3 Audit API](https://apis.io/apis/form3/form3-audit-api/)
- [Form3 Branches API](https://apis.io/apis/form3/form3-branches-api/)
- [Form3 Branch Identification API](https://apis.io/apis/form3/form3-branchidentification-api/)
- [Form3 Claims API](https://apis.io/apis/form3/form3-claims-api/)
- [Form3 Direct Debits API](https://apis.io/apis/form3/form3-directdebits-api/)
- [Form3 Direct Debits Reads API](https://apis.io/apis/form3/form3-directdebitsreads-api/)
- [Form3 Mandates API](https://apis.io/apis/form3/form3-mandates-api/)
- [Form3 Metrics API](https://apis.io/apis/form3/form3-metrics-api-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/form3/form3-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/form3/.