Pricing Templates
Log in Sign up
Integrations / Plaid / ...

POST /beacon/user/review

Update the status of a Beacon User.

When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check:

  1. Whether there are any associated Beacon Reports connected to the Beacon User, and
  2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User.

When updating a Beacon User's status to rejected, we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to cleared, we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to cleared. There are no restrictions on updating a Beacon User's status to pending_review.

If these conditions are not met, the request will be rejected with an error explaining the issue.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
client_id String No

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
beacon_user_id String Yes

ID of the associated Beacon User.
status String Yes

A status of a Beacon User.

rejected: The Beacon User has been rejected for fraud. Users can be automatically or manually rejected.

pending_review: The Beacon User has been marked for review.

cleared: The Beacon User has been cleared of fraud.

Valid values:

  • "pending_review"
  • "cleared"
  • "rejected"
secret String No

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy