Get Consent
Body Parameters
API client identifier
API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.
Consent ID to retrieve
Response
Consent details retrieved successfully
Response Attributes
Consent lifecycle status:
created: Consent created via API, not yet initiatedstarted: Consent flow initiated or reset for retrysca_url_retrieved: SCA URL retrieved from banking providerawaiting_decoupled_authz: User must authorise in their banking app (decoupled flow, e.g. BRD)awaiting_authz: User opened SCA URL (link/wrapped_sca only)authorized: User authentication successful, before data fetchactive: Consent active, data persisted to database- `expi...
createdstartedsca_url_retrievedawaiting_decoupled_authzawaiting_authzauthorizedactiveexpiredrevokedfailed... 1 other enums
Timestamp when the consent authorization link expires (based on expires_in option). After this time, users cannot access the WebUI to complete authorization. This does NOT affect already-active consents.
Number of days the consent remains valid for data access after authorization. When this period ends, the consent is automatically revoked.
Timestamp when the data access consent expires and will be automatically revoked (set after user authorizes, calculated from consent_validity_days). After this time, data access is no longer possible.
Name of the API client application
Internal UUID identifier for the consent
Public identifier for the consent (used in web URLs)
URL where the end-user can complete the consent authorization flow. Null for direct_sca type.
Unique identifier for the API request
Types of data this consent covers
accountsbalancestransactions Show child attributes
Selected AIS method details (available after method selection)
Show child attributes
Service provider (bank) details
Show child attributes
List of account IDs associated with this consent (available after consent is active)
Show child attributes
Information about the most recent successfully completed data refresh job
Show child attributes
Validation error or invalid request
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 400 errors:
bad_request: Generic validation or request errorvalidation_error: Request payload validation failedinvalid_input: Invalid input data providedinternal_error: AIS-side unexpected internal errorexternal_api_unavailable: External provider HTTP failure (timeout, connection refused, DNS, etc.). Surfaced as HTTP 400 instead of a gateway 504.external_api_error: External provider returned a structured error during the AIS ...
bad_requestvalidation_errorinvalid_inputinternal_errorexternal_api_unavailableexternal_api_errorcooldown_failedconsent_not_activejob_in_progressmethod_selection_error... 2 other enums
Human-readable error message
Authentication failed
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 401 errors:
unauthorized: Authentication failed or insufficient permissions
unauthorizedHuman-readable error message
Resource not found
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 404 errors:
not_found: Generic resource not foundconsent_not_found: Specified consent does not existjob_not_found: Specified job does not exist or outside accessible date range
not_foundconsent_not_foundjob_not_foundHuman-readable error message
Response