Flag Customer

Endpoint to read a customer

Flag or remove fraud risk for a customer

POST https://api.waldo.ai/flag

Request Body

Field	Type	Description
customerId*	String	Waldo AI customer id
flag*	Boolean	The new risk fraud status (true or false)
note	String	Only when flag is set to true

Headers

Name	Type	Description
Authorization*	String	The token in the format Bearer eyJhbG...
Content-Type*	String	Expected type is application/json

Response

200: OK Customer Flagged

{
    "flagged": true,
    "status": "REJECTED",
    "externalId": "abcd-123-456-efgh",
    "customerId": "65f2ddf6cfcf6ee1fd726307",
    "uri": "https://app.waldo.ai/customers/65f2ddf6cfcf6ee1fd726307"
}

403: Forbidden Missing authorization header

{
  "code": "NOT_AUTHORIZED",
  "message": "Not authorized."
}

401: Unauthorized Invalid token or expired

{
  "code": "INVALID_TOKEN",
  "message": "Invalid token."
}

403: Forbidden Service not authorized

{
  "code": "NOT_AUTHORIZED",
  "message": "You are not authorized to perform this action. Please contact support for assistance."
}

403: Forbidden Inactive API key

{
  "code": "API_KEY_REVOKED",
  "message": "This API key has been revoked. Please visit the Waldo AI dashboard to review your API key."
}

400: Bad Request Missing query parameters

The query should include at least one of the following parameters: customerId, flag

{
  "code": "INVALID_QUERY",
  "message": "Invalid query."
}

Webhooks event notification

{
    "event": "flag", 
    "flag": true,
    "externalId": "abcd-123-456-efgh",
    "customerId": "<customer-id>",
    "uri": "https://app.waldo.ai/customers/<customer-id>"
}