Consumers

Consumer deactivation

Sent when a consumer identity is deactivated. A deactivated consumer cannot sign in, and its instruments stop accepting new transactions until it is activated again. reasonCode says why.

Enable and configure webhooks in the Embedder Portal; recent events are listed on its Webhook Logs page. Weavr sends this event to {Webhook URL}/consumers/consumer_deactivated/watch.

postWebhook/consumers/consumer_deactivated/watch

Headers

call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestring required

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2string required

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

Payload

actionDoneBy'ADMIN' | 'INNOVATOR' required

Who performed the activation or deactivation:

  • ADMIN: Weavr, through the Admin API or Admin Portal.
  • INNOVATOR: you, through the Innovator API or Embedder Portal.
emailAddressstring required

Email address of the identity's root user.

reasonCode'ACCOUNT_REVIEW' | 'ACCOUNT_SECURITY' | 'TEMPORARY' | 'ACCOUNT_CLOSURE' | 'ACCOUNT_ABANDONED' required

Why an identity was deactivated:

  • ACCOUNT_REVIEW: the identity is under review.
  • ACCOUNT_SECURITY: deactivated in response to a security concern.
  • TEMPORARY: a temporary deactivation the identity is expected to recover from.
  • ACCOUNT_CLOSURE: the account is being closed.
  • ACCOUNT_ABANDONED: the account was abandoned before it became usable.

Example payload

{
  "emailAddress": "alex.smith@example.com"
}

Response

Event received.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.