Request Consent Data
Introduction
The Consent Data Request API opens a fresh financial-information (FI) fetch session for an existing consent and returns a sessionId for that fetch. Use it in two situations:
- Re-fetch a periodic consent — pull fresh financial data again for an active periodic consent, without starting a new journey.
- Trigger the first fetch of an autoFetch-disabled consent — by default the data is fetched automatically once the consent becomes active and you only read it via the Consent Data API. If the consent template has autoFetch set to false, no automatic fetch happens; you call this API once to trigger the single fetch.
The fresh data is fetched asynchronously. After a 201, read the data with the Consent Data API passing { consentHandle, sessionId }; it reports fetchInProgress: true until the new data lands, then returns it with fetchInProgress: false. If a callbackUrl was supplied at journey start, the session's data is also pushed there as a dataReady event carrying the same sessionId.
How to call the API
Send POST request to /consent/data/request endpoint with consentHandle in request body
API Input Guidelines
- consentHandle — the AA consent handle to open a fresh FI session for. Must be a periodic handle (re-fetch), or a one-time handle whose template set autoFetch:false (first fetch).
- Request is sent in the body as JSON
Sample Curl
curl --location 'https://api-preproduction.signzy.app/api/v3/aa-switch/consent/data/request' \
--header 'Content-Type: application/json' \
--header 'Authorization: <signzy-api-key>' \
--data '{
"consentHandle": "d0b89ea8-4c1e-4d83-9d93-68501cb26dcc"
}'
Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
|---|---|---|
consentHandle | Required | consentHandle generated from /consent/start api |
Sample Response
{
"sessionId": "fdde8d7e-3165-4bf6-bb59-551d49eb988f"
}Response Parameter
PARAMETER NAME | DESCRIPTION |
|---|---|
sessionId | New Data Fetch sessionId to fetch latest data. |