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
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
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 providedunprocessable_entity: Valid request but cannot be processedcooldown_failed: Data refresh cooldown period not yet elapsedconsent_not_active: Consent is not usable for this operation (e.g.expired,revoked,failed,suspended)method_selection_error: No AIS method ma...
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expiredHuman-readable error message
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
What made this section helpful for you?
What made this section unhelpful for you?
Response
What made this section helpful for you?
What made this section unhelpful for you?