Consents / Insights Data Webhook
For general webhook mechanics (response requirements, security, IP whitelisting, troubleshooting), see Webhooks - Async Updates. This page covers the webhook events fired for the Account Information Service (AIS) — both the raw-data consent flow (ais/user) and the processed-insights flow (view_ais/user, i.e. VIEW).
Consent lifecycle events
A consent (ais/user or view_ais/user) fires several distinct events over its lifetime, not just one status-change event. All share the same base payload — user, consent (consent ID), flow (flow ID), and context (if you set one) — plus event-specific fields listed below.
ConsentStatusChanged
ConsentStatusChangedFired on every status transition.
Additional payload fields: currentStatus, previousStatus, consentStatusChanged (timestamp of the change, may be null), validUntil, isContinuation (true if this consent continues a previous one), deletionReason (only present if applicable).
*For distribution partners only:
targetSystem (only for consents created through a distribution partner: targetSystemType, targetSystemId, distributorTermsVersion, targetSystemAppendixVersion, approvedAt).
Example targetSystem object:
{
"targetSystem": {
"targetSystemType": "ERP",
"targetSystemId": "priority",
"distributorTermsVersion": "v1",
"targetSystemAppendixVersion": "v1",
"approvedAt": "2026-11-02T10:15:00Z"
}
}Payload example
{
"event": "ConsentStatusChanged",
"timestamp": "2026-10-18T14:05:24.656895+00:00",
"payload": {
"user": "user-123@your-tpp-id",
"consent": "120120-200200202_202610181405_4ddd9191-22e0-4377-8c41-bfb97dba6ecc",
"flow": "default@your-tpp-id",
"currentStatus": "valid",
"previousStatus": "received",
"consentStatusChanged": "2026-10-18T14:05:24.636496+00:00",
"validUntil": "2027-01-18",
"isContinuation": true,
"context": "ref-20261018-001",
"tpp": "your-tpp-id"
}
}Consent statuses
| Status | Meaning |
|---|---|
received | Received, not yet approved |
valid | Valid — data can be fetched |
rejected | Rejected |
expired | Expired |
revokedByPsu | Revoked by the user |
terminatedByTpp | Terminated by you |
suspendedByASPSP | Suspended by the bank |
partiallyAuthorised | Partially approved (multi-level) |
waitingForInitialFetch | Waiting for first data fetch |
initialFetchFailed | First fetch failed |
noAnswer | No status received within two weeks |
UserDataIsAvailable
UserDataIsAvailableFired once the initial data pull for a consent completes — this is your signal that data is actually ready, distinct from the consent simply being valid.
Additional payload fields: fetchedAccounts (array of account references successfully pulled), failedToFetchAccounts (array of account references that failed).
Payload example
{
"event": "UserDataIsAvailable",
"timestamp": "2026-10-18T14:05:43.840977+00:00",
"payload": {
"user": "user-123@your-tpp-id",
"consent": "120120-200200202_202610181405_4ddd9191-22e0-4377-8c41-bfb97dba6ecc",
"flow": "default@your-tpp-id",
"fetchedAccounts": [
{
"currency": "ILS",
"iban": "IL650107320000001234567",
"cashAccountType": "CACC",
"displayName": "732-12345/67",
"name": "732-12345/67"
},
{
"currency": "ILS",
"iban": "IL540205210000000123456",
"cashAccountType": "SVGS",
"ownerName": "Israel Israeli",
"name": "Savings 1"
},
{
"currency": "ILS",
"iban": "IL540121700000000001111",
"cashAccountType": "LOAN",
"ownerName": "Israel Israeli"
},
{
"currency": "ILS",
"maskedPan": "532610xxxxxx2851",
"cashAccountType": "CARD",
"ownerName": "Israel Israeli"
},
{
"currency": "ILS",
"iban": "IL540121700000000007771",
"other": {
"identification": "MyProprietaryID-0001",
"issuer": "testbank",
"schemeNameProprietary": "Depotnummer"
},
"cashAccountType": "SCTS",
"ownerName": "Israel Israeli",
"name": "Securities 1"
}
],
"failedToFetchAccounts": [],
"context": "ref-20261018-001",
"tpp": "your-tpp-id"
}
}ConsentAboutToExpire
ConsentAboutToExpireFired once, ahead of a consent's validUntil (mirrors MandateAboutToExpire on the Mandate side).
Additional payload field: validUntil.
ConsentNotAccessed
ConsentNotAccessedFired if a valid consent's data hasn't been accessed by you within a configured period — a nudge that you have live access you aren't using.
Additional payload fields: validFrom, validUntil, consentTerminationDate.
DataRefreshComplete
DataRefreshCompleteA TPP-wide event (not tied to a specific user or consent) — payload only contains tpp.
What to do on receipt
Once ConsentStatusChanged reports valid (or you receive UserDataIsAvailable), fetch data via the AIS API (/tpp/v1/users/USERID/accounts, /cards, /loans, /savings, /securities) using a Bearer token obtained via a JWT with srv: "ais/tpp".
UserInsightReady (VIEW)
UserInsightReady (VIEW)Fired once a user's insights report finishes computing after a view_ais/user consent flow.
{
"event": "UserInsightReady",
"payload": { "user": "Useridentifier@test", "tpp": "test" },
"timestamp": "2024-04-08T05:01:12.981118+00:00"
}What to do on receipt
Call GET /tpp/v1/users/USERID/insights (or open the VIEW dashboard link) to retrieve the report. Response includes, where configured for your plan: income, expense, deposit, security, externalInvestmentOrSavings, loan, creditLimit, salary, children, financialEvents (nsfEvents, warningEvents, loanPaymentDelayEvents, closedLoanPaymentDelayEvents, unemploymentPaymentEvents, technicalCheckBounceEvents), businessReportsAnalysis, monthlyFees, creditScore.
⚠️ Don't restrict against a strict schema — additional fields may be present, and sections only appear if configured in your plan. For the full response reference, use Feezback's Swagger / the Aggregate Data API spec.
AIS vs VIEW — quick reference
ais/user (AIS) | view_ais/user (VIEW) | |
|---|---|---|
| Result | Raw data access (accounts, transactions) | Processed financial analysis (insights) |
| Webhook | Consent lifecycle events (above) | UserInsightReady |
| Data retrieval | AIS API endpoints (/accounts, /transactions, etc.) | /insights endpoint |
Access token srv | ais/tpp | ais/tpp |
Updated 20 days ago