OTP Failed Event

Fired when an OTP delivery to the subject fails.

Inbound webhook callback — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.

POST /_webhooks/otp-failed

OTP Failed Event

cURL

curl --request POST \
  --url https://api.example.com/_webhooks/otp-failed \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "issuerDid": "<string>",
  "user": {
    "contact": "<string>",
    "id": "<string>",
    "internalId": "<string>"
  },
  "api_version": "<string>",
  "otp": {
    "resendEndpoint": "<string>",
    "error": {
      "code": "<string>",
      "message": "<string>"
    }
  },
  "internalId": "<string>"
}
'

Headers

API-Version · string

Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-03-03"

Body

application/json

eventType · enum<string> · required

Available options: otp.failed

requestId · string · required

issuerDid · string · required

user · object · required

Show child attributes

api_version · string · required

otp · object · required

Show child attributes

internalId · string

Response

200

Webhook received successfully