Check Notification Status

🔄 Check Notification Status API Documentation

The Check Notification Status API (getRVNStatus) allows an enterprise to poll the REL-ID server for the status of a previously triggered notification using the notification_uuid.

Related : Notification Callback

This is useful if:

  • No callback_url was provided in the generateRVN request.
  • You want to verify whether the user responded, rejected, or ignored the notification.
  • You require JWT or digital signature verification results post-action.


🔗 Endpoint

GET https://<REL-ID-VERIFY-SERVER>:<VERIFY-PORT>/getRVNStatus.htm/<notification_uuid>

🔐 Authentication

Supports Basic Auth or Bearer Token:

Authorization: Basic <base64(username:password)>

or

Authorization: Bearer <access_token>

📥 Request Parameters

ParameterTypeRequiredDescription
notification_uuidstringUUID received from generateRVN API response. Used as a path parameter.

No body is needed for this GET request.


✅ Sample Success Response

{
  "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": "txn12345",
  "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",
  "jwt": "<jwt_token_if_any>"
}

❌ Sample Failure Response

{
  "response_code": 1,
  "error_code": 3558,
  "error_message": "Notification Identifier is not found"
}

🧾 Response Attribute Table

AttributeTypeAlways PresentDescription
user_idstringREL-ID user who received the notification.
notification_uuidstringUUID for this specific notification.
response_codeint0 for success, 1 for failure.
statusstringOne of: ACTIVE, UPDATED, EXPIRED, CANCELLED.
delivery_statusstringNotification delivery status.
action_responsestringOnly present if user responded.
is_ds_verifiedbooleanOnly present if digital signing is enabled.
msg_idstringMessage ID originally sent in generateRVN.
verification_modestringMode of verification used.
original_verification_modestringIncluded if fallback/escalation occurred.
create_tsstringWhen the notification was created.
update_tsstringWhen the user took action.
expiry_timestampstringWhen the notification will expire.
client_ip_addressstringIP of device used to respond.
jwtstringOnly included if GENERATE_JWT workflow was used.

📖 Response Values Explained

🔄 status – Notification Lifecycle

ValueMeaning
ACTIVENotification is still active and awaiting user response.
UPDATEDUser has acted on the notification (e.g., Approved or Rejected).
EXPIREDNotification was not acted on within the expires_in duration.
CANCELLEDNotification was cancelled via the Cancel Notification API.

🚚 delivery_status – Push Notification Delivery

ValueMeaning
NONEPush was not initiated (e.g., test mode or failure).
PARTIALLY_NOTIFIEDDelivered to some of the user's devices.
NOTIFIEDDelivered to all registered devices successfully.
FAILED_TO_NOTIFYDelivery failed on all targets (e.g., device not reachable).

🧾 action_response – User Action

ValueMeaning
Approved, Rejected, etc.Based on your actions[] configuration during notification creation.
NONENo action was taken by the user before expiry.

is_ds_verified – Digital Signature Validation

ValueMeaning
trueThe user's response was signed and successfully verified.
falseSignature verification failed or not applicable.
(absent)User hasn't responded yet or digital signing was disabled.

🧪 verification_mode and original_verification_mode

ValueMeaning
REL-IDVerification was done via REL-ID secure app flow.
OTPVerification fallback to OTP.
SMSFallback via SMS if mobile app was unavailable.
(others)Custom enterprise-specific verification types if supported.

⚠️ Error Codes

CodeMessageReason
2600INVALID URIIncorrect endpoint format
2607Invalid HTTP requestRequest format is not valid
3593Regex validation failedMalformed UUID
3557Internal Server ErrorIssue during server processing
3558Notification Identifier not foundUUID not found or expired
7002Invalid methodMethod must be GET
7019IPAddress is not whitelistedCalling IP is unauthorized

🧠 Notes

  • Use this API if callback_url is not available.
  • Safe to poll at regular intervals.
  • JWT (if included) should be validated on your backend.
  • Signature and IP fields are only returned if user has responded and signing is enabled.

📌

ThegetRVNStatus API is ideal for transaction state monitoring, fallback to async callback, or audit logging of user responses.