For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inTalk to sales
GuidesAPI Reference
  • Introduction
    • Getting started
  • API Reference
  • Webhooks
      • POSTUser State Update
      • POSTKYC Status Update
      • POSTUser Tags Update
      • POSTCRA Risk Level Update
LogoLogo
Log inTalk to sales
WebhooksUser

User State Update

Payload
1{
2  "id": "string",
3  "triggeredBy": "MANUAL",
4  "createdTimestamp": 2220000000000,
5  "type": "USER_STATE_UPDATED",
6  "data": {
7    "state": "UNACCEPTABLE",
8    "userId": "string"
9  }
10}
Occurs whenever a user's state is updated
Was this page helpful?
Previous

KYC Status Update

Next
Built with

Headers

x-flagright-signaturestringRequired

An HMAC SHA256 signature generated using the webhook payload and a shared signing secret. This is then converted to a hex encoded string.

Payload

The payload of this webhook request is an object.
idstringRequired
Unique identifier for the event
triggeredByenumRequired
Event triggered by a user or system
Allowed values:
createdTimestampdoubleRequired315529200000-4133890801000
Time at which the event was created. Measured in ms since the Unix epoch.
typeenumRequired
Allowed values:
dataobjectRequired
accountstringOptional
Email ID associated with the event

Response

200
any
Return a 200 status to indicate that the data was received successfully.