Query risk status by email

Status	Description
`CARD_OPTIONS_RESTRICTED`	The user's card options are restricted because Breeze has detected fraudulent or suspicious activity within the Breeze ecosystem.
`OFFBOARDED`	The user has been denied access to Breeze services for compliance reasons.
`ACTIVE`	The user is active and not subject to any card restrictions.
`UNKNOWN`	Breeze has no record of this user.

When to use this

This Risk endpoint is gated — contact Breeze to enable it for your account. Once enabled, call this endpoint when you need a user's risk status before a payment page is created. Breeze enforces all risk decisions at payment time regardless, so this call is not required to protect a payment.

Query by email

curl -X GET 'https://api.breeze.cash/v1/[email protected]' \
  -u "YOUR_API_KEY:" \
  --header 'Accept: application/json'

Parameters

Parameter	Type	Description
email	string	Required. Email address of the user to query. Must be a valid email format.

Successful response

{
  "status": "SUCCEEDED",
  "data": {
    "status": "ACTIVE"
  }
}

Error response

{
  "status": "FAILED",
  "errorCode": "WRONG_PARAMETER",
  "errorMessage": "<more-detailed-error-message>"
}