For AI agents: visit https://docs.braidfi.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Guides API Reference Changelog

API Reference

Home Guides API Reference Changelog

Fees
Counterparty
Transactions
Individuals
Businesses
Alerts
Webhook
Simulation
Identity Verification
- Create Identity Verificationpost
- Get customer identity verificationget
Webhook responses
ACH Processing
- Upload outbound ACH filepost
- Get ACH file processing statsget
Accounts
Statements V2
- Get summary account statementget
Statements
- Get product statementget

Powered by

Braid API
Alerts

Get a list of alerts

post

https://api.sandbox.braid.zone/alerts/search

Query Params

pageNumber

int32

Defaults to 0

pageSize

int32

Defaults to 50

Body Params

types

array of strings

Alert types

types

statuses

array of strings

Alert statuses

statuses

contextType

string

Context type

contextId

string

Context id

showAssigned

boolean

Show assigned alerts

alertId

int64

Alert id

rfiStatus

string

enum

Request for information status

Allowed:

assignee

string

Assignee

startDate

date

Start Date

endDate

date

End Date

includeDetails

boolean

Assignee

Responses

Updated 4 months ago

Add notes to an alert

Update alerts request for information status. This endpoint is only for Admin and Developers use. Only admins can set the status to COMPLETED.

Did this page help you?

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

Updated 4 months ago

Add notes to an alert

Update alerts request for information status. This endpoint is only for Admin and Developers use. Only admins can set the status to COMPLETED.

Did this page help you?