REL-ID for MobileREL-ID APIsREL-ID for Web
Guides
Start typing to search…

Notification Callback

🔁 callback_url – Notification Callback Endpoint

The callback_url parameter in the generateRVN API allows enterprises to receive real-time updates when a user acts on a notification or when it expires.

If provided, REL-IDverify will make an HTTP POST request to this URL with a structured JSON payload when:

  • The user approves/rejects the notification.
  • The notification expires (i.e., no user action within expires_in period).

🌐 When Is It Called?

  • Immediately after a user takes an action (e.g., Approve/Reject).
  • After the expires_in duration if no action was taken.
  • Only for notifications with msg_type = "TWO-WAY".
❗

For msg_type = "OTP", callback_url is ignored. You must use validateOTP API.

📬 Sample Callback Payload

{
  "user_id": "testuser",
  "notification_uuid": "03f67f9e-ec4f-11e6-b006-92361f002671",
  "response_code": 0,
  "status": "UPDATED",
  "delivery_status": "NOTIFIED",
  "action_response": "Approved",
  "is_ds_verified": true,
  "msg_id": "1234567890",
  "verification_mode": "REL-ID",
  "original_verification_mode": "REL-ID",
  "create_ts": "2024-10-11T13:00:00Z",
  "update_ts": "2024-10-11T13:00:15Z",
  "expiry_timestamp": "2024-10-11T13:03:00Z",
  "client_ip_address": "192.168.1.2"
}

🧾 Field Descriptions

FieldDescription
user_idREL-ID user who received the notification
notification_uuidUnique ID returned during notification creation
response_code0 for success, 1 for error
error_codeOnly when response_code is 1
statusUPDATED (user acted), EXPIRED (no action)
delivery_statusNOTIFIED, PARTIALLY_NOTIFIED, FAILED_TO_NOTIFY, NONE
action_responseAction label (e.g., "Approved", "Rejected"), or NONE
is_ds_verifiedBoolean, if digital signature was successfully verified
msg_idOriginal msg_id sent in the request
verification_modeTypically "REL-ID"
original_verification_modeOriginal verification mode; same as above
create_tsTimestamp when notification was created
update_tsTimestamp when user acted on it
expiry_timestampWhen the notification expired
client_ip_addressIP address from which the user took action (only present if status isUPDATED)

🔐 Security Notes

  • REL-IDverify POSTs the data using application/json content type.
  • Ensure the endpoint is secured and validates the source (e.g., IP whitelisting or token-based auth).
  • Retry logic is not explicitly documented—implement idempotency based on notification_uuid.
📌

Use this callback to update your transaction status in real time without polling.

Updated 3 months ago