Live demo of agent247 on Digio's docs — click the orange button at the bottom right to start.

Webhook Event

EventEntityDescription
CONSENT_REQUEST_SHAREDCONSENT_REQUESTRaised when Digio FIU TSP shares the consent request with Account Aggregator, will be done when user navigates to account aggregator webview via DIGIO FIU JS SDK
CONSENT_REQUEST_APPROVEDCONSENT_REQUESTRaised when the user approves consent.
CONSENT_ACTIVECONSENT_REQUESTRaised when a FI request can be raised against an approved consent
CONSENT_REQUEST_REJECTEDCONSENT_REQUESTRaised when the user rejects consent.
CONSENT_REQUEST_FAILEDCONSENT_REQUESTRaised when consent request fails
CONSENT_REVOKEDCONSENT_REQUESTRaised when the user revokes consent.
CONSENT_EXPIREDCONSENT_EXPIREDRaised when the user consent expires.
FI_REQUESTEDFI_REQUESTRaised when FI request is submitted to AA
FI_AVAILABLEFI_REQUESTRaised when FI data is available to be fetched
FI_REQUEST_FAILEDFI_REQUESTRaised when FI request sent is failed or rejected by AA
FI_DELIVEREDFI_REQUESTRaised when FI is fetched by client
DATA_PURGEDFI_REQUESTRaised When FI data is Purged by Client
ANALYTICS_AVAILABLEFI_REQUESTRaised When Analytics is available against an account ID
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_REQUEST_APPROVED",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "",
    "customer_name": "",
    "customer_identifier": "",
    "aa_entity_id": "digio_link",
    "customer_ref_number": ""
  }
}
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_REQUEST_REJECTED",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "",
    "customer_name": "",
    "customer_identifier": "",
    "aa_entity_id": "digio_link",
    "customer_ref_number": ""
  }
}
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_REVOKED",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "",
    "customer_name": "",
    "customer_identifier": "",
    "aa_entity_id": "digio_link",
    "customer_ref_number": ""
  }
}
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_PAUSED",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "",
    "customer_name": "",
    "customer_identifier": "",
    "aa_entity_id": "digio_link",
    "customer_ref_number": ""
  }
}
{
    "web_hook_notification_id": "WHN12345",
    "created_at": 1741571173,
    "event": "CONSENT_REQUEST_FAILED",
    "payload": {
        "error_code": "",
        "error_description": "",
        "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
        "customer_mobile": "",
        "customer_name": "",
        "customer_identifier": "",
        "aa_entity_id": "digio_link",
        "customer_ref_number": ""
    }
}
{
    "web_hook_notification_id": "WHN12345",
    "created_at": 1741571173,
    "event": "CONSENT_REQUEST_FAILED",
    "payload": {
        "error_code": "INVALID_CONSENT_ID",
        "error_description": "Invalid consent handle",
        "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
        "customer_mobile": "",
        "customer_name": "",
        "customer_identifier": "",
        "aa_entity_id": "digio_link",
        "customer_ref_number": ""
    }
}
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_ACTIVE",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "9945478460",
    "customer_name": "Darshan",
    "customer_identifier": "9945478460",
    "aa_entity_id": "digio_link",
    "customer_ref_number": "9945478460",
    "accounts": [
      {
        "account_id": "5a92045e-ca4c-4d98-be8a-2d70e3efe6e0",
        "link_ref_number": "5a92045e-ca4c-4d98-be8a-2d70e3efe6e0",
        "masked_account_number": "XXXXXXXX6704",
        "fi_type": "MUTUAL_FUNDS",
        "fip_id": "DIGIO_FIP"
      }
    ]
  }
}
{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "CONSENT_EXPIRED",
  "payload": {
    "consent_request_id": "CRD2411071248267383PVRHMU7AOWKUG",
    "customer_mobile": "",
    "customer_name": "",
    "customer_identifier": "",
    "aa_entity_id": "digio_link",
    "customer_ref_number": ""
  }
}

FI Request Received (FI_REQUESTED)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_REQUESTED",
  "payload": {
    "consent_request_id": "",
    "fi_request_id": ""
  }
}

FI Available (FI_AVAILABLE)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_AVAILABLE",
  "payload": {
    "consent_request_id": "",
    "fi_request_id": "",
    "accounts": [
      {
        "account_id": "5a92045e-ca4c-4d98-be8a-2d70e3efe6e0",
        "link_ref_number": "5a92045e-ca4c-4d98-be8a-2d70e3efe6e0",
        "masked_account_number": "XXXXXXXX6704",
        "fi_type": "MUTUAL_FUNDS",
        "fip_id": "DIGIO_FIP"
      }
    ]
  }
}

FI Available via File (FI_AVAILABLE)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_AVAILABLE",
  "payload": {
    "consent_request_id": "",
    "is_file": true,
    "fi_request_id": "",
    "accounts": [
      {
        "account_id": "5a92045e-ca4c-4d98-be8a-2d70e3efe6e0",
        "masked_account_number": "XXXXXXXX6704",
        "fi_type": "MUTUAL_FUNDS",
        "fip_id": "DIGIO_FIP"
      }
    ]
  }
}

FI Data Available (FI_DATA_AVAILABLE)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_DATA_AVAILABLE",
  "payload": {
    "fi_data_id": "",
    "fi_type": "",
    "customer_mobile": "",
    "customer_id": "",
    "account_id": "",
    "fip_id": "",
    "account_number": "",
    "consent_request_id": "",
    "fi_request_id": ""
  }
}

FI Request Failed (FI_REQUEST_FAILED)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_REQUEST_FAILED",
  "payload": {
    "consent_request_id": "",
    "fi_request_id": ""
  }
}

FI Delivered (FI_DELIVERED)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_DELIVERED",
  "payload": {
    "consent_request_id": "",
    "fi_request_id": ""
  }
}

Data Purged (FI_DATA_PURGED)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "FI_DATA_PURGED",
  "payload": {
    "consent_request_id": "",
    "fi_request_id": ""
  }
}

Analytics Available (ANALYTICS_AVAILABLE)

{
  "web_hook_notification_id": "WHN12345",
  "created_at": 1741571173,
  "event": "ANALYTICS_AVAILABLE",
  "payload": {
    "customer_id": "",
    "masked_account_number": "",
    "customer_mobile": "",
    "account_id": ""
  }
}

Was this page helpful?