POST/webhooks/outbound/kyc.information_request

kyc.information_request

This operation documents an outbound webhook request that CryptoCard Platform sends to your configured webhook URL. Sent when Equals Money requests additional KYC documents. Configure the destination URL and webhook secret on the company configuration. We send an HTTP `POST` with `Content-Type: application/json` and `X-Hoppacard-Signature`. The signature is a lowercase hex HMAC-SHA256 digest of the exact request body, using your webhook secret as the key. Return any 2xx status code to acknowledge the webhook.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
X-Hoppacard-Signature (header)stringYesLowercase hex HMAC-SHA256 signature of the raw request body, generated with your webhook secret.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
idstringYesUnique webhook event id.
typekyc.information_requestYesWebhook event type.
domainkycYesBusiness domain for the event.
providerequalsmoneyYesProvider that originated the event.
timestampstring (date-time)YesUTC time when the webhook was created.
dataobjectYesEvent-specific payload for `kyc.information_request`.

Responses

200 — Return any 2xx response to acknowledge receipt.

Example request

curl -X POST "https://{base_url}/webhooks/outbound/kyc.information_request" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","type":"…","domain":"…","provider":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.