Create 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.
Filter criteria for selecting AIS methods/providers
Show child attributes
Show child attributes
Show child attributes
Tracking identifiers for billing, audit, and IBAN whitelisting purposes.
Configuration Requirements:
- Both fields are optional by default, but may be required based on API client configuration
- When required, the API will return a 401 error if the required tracking ID is missing
Validation Rules (applies to both fields):
- Length: 1-128 characters
- First character: lowercase letter (
a-z) or digit (0-9) - Remaining characters: lowercase letters, digits, hyphens (
-), o...
Show child attributes
Response
Consent created successfully
Response Attributes
Unique identifier for the API request (from x-request-id header)
Timestamp when the consent was created
Timestamp when the consent link expires (based on expires_in option)
Number of days the consent remains valid for data access after authorization
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/redirect_sca consents resolved to a decoupled AIS method (no SCA URL exists — see message).
Present only for direct_sca/redirect_sca consents resolved to a decoupled AIS method (e.g. BRD): instruction to display to the end user, who authorises the consent in their banking mobile app instead of via a redirect. Localised and processed per the AIS method's message configuration; may include the bank consent id.
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
Response