Skip to content

Authorised Users

Webhooks

Auth user deactivation
Webhook

Request

Notification that an auth user has been deactivated.

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, (int64)required

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

signaturestringrequireddeprecated

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

signature-v2stringrequired

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.

Bodyapplication/jsonrequired
actionDoneBystring(ActionDoneBy)required
Enum:"UNDEFINED""ADMIN""INNOVATOR"
emailAddressstringrequired
reasonCodestring(IdentityDeactivatedReasonCode)required
Enum:"UNDEFINED_REASON""ACCOUNT_REVIEW""ACCOUNT_SECURITY""TEMPORARY""ACCOUNT_CLOSURE""ACCOUNT_ABANDONED"
corporateKybStatusstring(CorporateKybStatus)

The Corporate KYB Status. Only populated for corporates.

Enum:"NEW""PENDING""APPROVED""REJECTED""CLOSED"
kybRunsArray of objects(KybRun)

The latest KYB Run per regulatory FI. Only populated for corporates.

Payload
{
  "actionDoneBy": "UNDEFINED",
  "emailAddress": "string",
  "reasonCode": "UNDEFINED_REASON",
  "corporateKybStatus": "NEW",
  "kybRuns": [
    { … }
  ]
}

Responses

Success - No Content