Consent Status

Introduction

Returns the current status of a consent journey — no financial data. Use it to poll a journey after start until journeyStatus becomes SUCCESS (or FAILED).

How to call the API

Send a POST request. Every request must carry your API key in the authorization header, and Content-Type: application/json.

API Input Guidelines

You need to pass the following information:

journeyId — the id returned by the start call.

Sample Curl

Preproduction

Production

curl -X POST "https://api-preproduction.signzy.app/api/v3/aa-switch/consent/status" \
  -H "Authorization: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{ "journeyId": "7b1d2e9c-3f6a-4c11-9a2e-2c1f0b8d4a55" }'

curl -X POST "https://api.signzy.app/api/v3/aa-switch/consent/status" \
  -H "Authorization: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{ "journeyId": "7b1d2e9c-3f6a-4c11-9a2e-2c1f0b8d4a55" }'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
journeyId	Required	The journey id returned by the consent start

Sample Response

{
    "journeyStatus": "SUCCESS",
    "stage": "DATA_FETCH",
    "accountCount": 6,
    "consents": [
        {
            "consentHandle": "ec286e1e-7dea-4ddc-8da5-5701be1954fd",
            "consentTemplateId": "<consent template id>",
            "consentStatus": "ACTIVE",
            "dataFetchStatus": "SUCCESS",
            "lastFetchedAt": "2026-07-13T11:05:31.497Z",
            "fips": [
                {
                    "fipId": "fip@finbank",
                    "dataFetchStatus": "SUCCESS",
                    "sessionId": "9bac8751-b3d7-4864-9bbe-20a897645801"
                }
            ],
            "sessions": [
                {
                    "sessionId": "9bac8751-b3d7-4864-9bbe-20a897645801",
                    "cycle": 1,
                    "sessionStatus": "COMPLETED",
                    "createdAt": "2026-07-13T11:05:28.732Z",
                    "fetchedAt": "2026-07-13T11:05:31.497Z"
                }
            ]
        },
        {
            "consentHandle": "933f7638-755f-4386-94e9-693e796ed7b7",
            "consentTemplateId": "<consent template id>",
            "consentStatus": "ACTIVE",
            "dataFetchStatus": "SUCCESS",
            "lastFetchedAt": "2026-07-13T11:41:05.408Z",
            "fips": [
                {
                    "fipId": "fip@finbank",
                    "dataFetchStatus": "SUCCESS",
                    "sessionId": "fdde8d7e-3165-4bf6-bb59-551d49eb988f"
                }
            ],
            "sessions": [
                {
                    "sessionId": "5d599562-f338-4c24-84e4-61541c9f238d",
                    "cycle": 1,
                    "sessionStatus": "COMPLETED",
                    "createdAt": "2026-07-13T11:05:28.617Z",
                    "fetchedAt": "2026-07-13T11:05:32.198Z"
                },
                {
                    "sessionId": "fdde8d7e-3165-4bf6-bb59-551d49eb988f",
                    "cycle": 2,
                    "sessionStatus": "COMPLETED",
                    "createdAt": "2026-07-13T11:41:03.687Z",
                    "fetchedAt": "2026-07-13T11:41:05.408Z"
                }
            ]
        }
    ]
}

Response Parameter

PARAMETER NAME	Type	DESCRIPTION
journeyStatus	string	Overall journey state: WAITING / RUNNING / SUCCESS / FAILED. Poll until SUCCESS or FAILED.
accountCount	number	Total number of accounts fetched so far across all consent data fetch sessions.
consents[]	array	One entry per consent in the journey.
consents[].consentHandle	string	The consent handle; use it with the data call.
consents[].consentTemplateId	string	The consent template this consent was created from.
consents[].consentStatus	string	Consent state: PENDING / READY / ACTIVE / PAUSED / REVOKED / EXPIRED / REJECTED / FAILED.
consents[].fips[]	array	Per-bank (FIP) fetch entries for this consent.
consents[].fips[].fipId	string	The bank / FIP identifier.
consents[].fips[].dataFetchStatus	string	Per-bank data readiness: PENDING/ SUCCESS / READY / DELIVERED / PARTIAL / FAILED.
consents[].fips[].sessionId	string	The FI session this FIP's data came from
consents[].sessions[]	array	Every FI session opened for this consent (sorted by cycle).
consents[].sessions[].sessionId	string	The FI session id.
consents[].sessions[].cycle	number	Fetch cycle number (increments for periodic fetches).
consents[].sessions[].sessionStatus	string	FI session lifecycle: ACTIVE \| COMPLETED \| EXPIRED \| FAILED.
consents[].sessions[].createdAt	string	ISO 8601 timestamp the session was opened.
consents[].sessions[].fetchedAt	string	ISO 8601 timestamp the data for this session was fetched