119 lines
3.0 KiB
Markdown
119 lines
3.0 KiB
Markdown
---
|
|
name: beacon-routes
|
|
description: Handle 13 OpenAPI operation(s) under /beacon for the beacon route group.
|
|
---
|
|
|
|
# beacon API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /beacon for the beacon 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
|
|
|
|
### beacon_account_risk_evaluate
|
|
|
|
- Operation ID: `beacon_account_risk_evaluate`
|
|
- Route: `POST /beacon/account_risk/v1/evaluate`
|
|
- Mode: WRITE
|
|
- Summary: Evaluate risk of a bank account
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_create
|
|
|
|
- Operation ID: `beacon_user_create`
|
|
- Route: `POST /beacon/user/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_get
|
|
|
|
- Operation ID: `beacon_user_get`
|
|
- Route: `POST /beacon/user/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_review
|
|
|
|
- Operation ID: `beacon_user_review`
|
|
- Route: `POST /beacon/user/review`
|
|
- Mode: WRITE
|
|
- Summary: Review a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_report_create
|
|
|
|
- Operation ID: `beacon_report_create`
|
|
- Route: `POST /beacon/report/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a Beacon Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_report_list
|
|
|
|
- Operation ID: `beacon_report_list`
|
|
- Route: `POST /beacon/report/list`
|
|
- Mode: WRITE
|
|
- Summary: List Beacon Reports for a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_report_syndication_list
|
|
|
|
- Operation ID: `beacon_report_syndication_list`
|
|
- Route: `POST /beacon/report_syndication/list`
|
|
- Mode: WRITE
|
|
- Summary: List Beacon Report Syndications for a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_report_get
|
|
|
|
- Operation ID: `beacon_report_get`
|
|
- Route: `POST /beacon/report/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a Beacon Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_report_syndication_get
|
|
|
|
- Operation ID: `beacon_report_syndication_get`
|
|
- Route: `POST /beacon/report_syndication/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a Beacon Report Syndication
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_update
|
|
|
|
- Operation ID: `beacon_user_update`
|
|
- Route: `POST /beacon/user/update`
|
|
- Mode: WRITE
|
|
- Summary: Update the identity data of a Beacon User
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_duplicate_get
|
|
|
|
- Operation ID: `beacon_duplicate_get`
|
|
- Route: `POST /beacon/duplicate/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a Beacon Duplicate
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_history_list
|
|
|
|
- Operation ID: `beacon_user_history_list`
|
|
- Route: `POST /beacon/user/history/list`
|
|
- Mode: WRITE
|
|
- Summary: List a Beacon User's history
|
|
- Body: JSON request body accepted.
|
|
|
|
### beacon_user_account_insights_get
|
|
|
|
- Operation ID: `beacon_user_account_insights_get`
|
|
- Route: `POST /beacon/user/account_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Get Account Insights for a Beacon User
|
|
- Body: JSON request body accepted.
|