129 lines
3.2 KiB
Markdown
129 lines
3.2 KiB
Markdown
---
|
|
name: user-routes
|
|
description: Handle 13 OpenAPI operation(s) under /user for the user route group.
|
|
---
|
|
|
|
# user API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /user for the user route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### user_transactions_refresh
|
|
|
|
- Operation ID: `user_transactions_refresh`
|
|
- Route: `POST /user/transactions/refresh`
|
|
- Mode: WRITE
|
|
- Summary: Refresh user items for Transactions bundle
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_financial_data_refresh
|
|
|
|
- Operation ID: `user_financial_data_refresh`
|
|
- Route: `POST /user/financial_data/refresh`
|
|
- Mode: WRITE
|
|
- Summary: Refresh user items for Financial-Insights bundle
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_create
|
|
|
|
- Operation ID: `user_create`
|
|
- Route: `POST /user/create`
|
|
- Mode: WRITE
|
|
- Summary: Create user
|
|
- Parameters:
|
|
- `Plaid-New-User-API-Enabled` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_get
|
|
|
|
- Operation ID: `user_get`
|
|
- Route: `POST /user/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve user identity and information
|
|
- Parameters:
|
|
- `Plaid-New-User-API-Enabled` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_identity_remove
|
|
|
|
- Operation ID: `user_identity_remove`
|
|
- Route: `POST /user/identity/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove user identity data
|
|
- Parameters:
|
|
- `Plaid-New-User-API-Enabled` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_update
|
|
|
|
- Operation ID: `user_update`
|
|
- Route: `POST /user/update`
|
|
- Mode: WRITE
|
|
- Summary: Update user information
|
|
- Parameters:
|
|
- `Plaid-New-User-API-Enabled` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_remove
|
|
|
|
- Operation ID: `user_remove`
|
|
- Route: `POST /user/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove user
|
|
- Parameters:
|
|
- `Plaid-New-User-API-Enabled` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_products_terminate
|
|
|
|
- Operation ID: `user_products_terminate`
|
|
- Route: `POST /user/products/terminate`
|
|
- Mode: WRITE
|
|
- Summary: Terminate user-based products
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_items_get
|
|
|
|
- Operation ID: `user_items_get`
|
|
- Route: `POST /user/items/get`
|
|
- Mode: WRITE
|
|
- Summary: Get Items associated with a User
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_items_associate
|
|
|
|
- Operation ID: `user_items_associate`
|
|
- Route: `POST /user/items/associate`
|
|
- Mode: WRITE
|
|
- Summary: Associate Items to a User
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_items_remove
|
|
|
|
- Operation ID: `user_items_remove`
|
|
- Route: `POST /user/items/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove Items from a User
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_third_party_token_create
|
|
|
|
- Operation ID: `user_third_party_token_create`
|
|
- Route: `POST /user/third_party_token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a third-party user token
|
|
- Body: JSON request body accepted.
|
|
|
|
### user_third_party_token_remove
|
|
|
|
- Operation ID: `user_third_party_token_remove`
|
|
- Route: `POST /user/third_party_token/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove a third-party user token
|
|
- Body: JSON request body accepted.
|