API explorerPay APIsData APIs

Theme switcher

Handle Redirect

Body Parameters

client_idstring Required

API client identifier

Max length
128
client_secretstring

API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.

Max length
128
query_stringstring Required

The query string received from the AIS consent provider callback. Must contain a state parameter for session identification.

Pattern
^(?:[^&=]+=[^&]*&)*state=[^&]*(?:&[^&=]+=[^&]*)*$
syncboolean

Whether to wait for the consent to reach a final status.

  • false (default): Returns immediately with current status
  • true: Waits for active, failed, or authorized status
Default value
false

Response

200
Object
Redirect processed successfully

Response Attributes

statusstring

Current consent status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See AisConsentStatus enum (e.g. active, failed, authorized)
api_client_appstring

Name of the API client application

consent_idstring

Internal UUID identifier for the consent

web_idstring

Public identifier for the consent

request_idstring

Unique identifier for the API request

201
Object
Redirect already processed (duplicate request)

Response Attributes

statusstring

Current consent status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See AisConsentStatus enum (e.g. active, failed, authorized)
api_client_appstring

Name of the API client application

consent_idstring

Internal UUID identifier for the consent

web_idstring

Public identifier for the consent

request_idstring

Unique identifier for the API request

202
Object
Redirect in progress

Response Attributes

statusstring

Current consent status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See AisConsentStatus enum (e.g. active, failed, authorized)
api_client_appstring

Name of the API client application

consent_idstring

Internal UUID identifier for the consent

web_idstring

Public identifier for the consent

request_idstring

Unique identifier for the API request

400
Object
Validation error or invalid request

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 400 errors:

  • bad_request: Generic validation or request error
  • validation_error: Request payload validation failed
  • invalid_input: Invalid input data provided
  • internal_error: AIS-side unexpected internal error
  • external_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 ...
Enum values:
bad_requestvalidation_errorinvalid_inputinternal_errorexternal_api_unavailableexternal_api_errorcooldown_failedconsent_not_activejob_in_progressmethod_selection_error
... 2 other enums
messagestring Required

Human-readable error message

401
Object
Authentication failed

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 401 errors:

  • unauthorized: Authentication failed or insufficient permissions
Enum values:
unauthorized
messagestring Required

Human-readable error message

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot