GET /service/consent/:consentId

Account consent details

Retrieves account consent details of a started / ongoing account consent request.

Path Parameters

consentId ConsentId required

The ID of the account consent to retrieve.

Responses

• 200
• 401
• 404

---

Default response

application/json

Schema

Example (from schema)

---

Schema

inquiryId ConsentInquiryId

Consent inquiry id

consentId ConsentId

Unique consent id

status ConsentStatus

Possible values: [initiated, started, received, rejected, partially_authorised, valid, revoked_by_psu, expired, terminated_by_tpp, failed]

Consent status.

created date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

modified date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

scope ConsentScope

Possible values: [all, accounts, balances, transactions]

Consent scopes for account information access.

validUntil date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

providerId ProviderId

Unique payment provider (bank) id

name string

Short info of the account consent intent. Will be visible int the customers consent list.

description string

Simple description of why account access is being used.

owner object

msisdn Msisdn

Mobile phone number

email Email

Email address

country CountryCode

Provider country code (ISO 3166 alpha-2 codes)

data object[]
Additional internal data to be stored alongside payment. This can be internal shopping basked id, customer profile id, or any other information to link payment to an internal process.
Array [
key string
unique key of internally stored data. For instance basked_id, customer_id ...
value string
value of internally stored data.
]
locale Locale

Two letter ISO 639-1 language/locale code.

{
  "inquiryId": "string",
  "consentId": "123",
  "status": "initiated",
  "created": "2025-10-30T15:47:48.764Z",
  "modified": "2025-10-30T15:47:48.764Z",
  "scope": "all",
  "validUntil": "2025-10-30T15:47:48.764Z",
  "providerId": "string",
  "name": "Account ownership check",
  "description": "Account ownership confirmation",
  "owner": {
    "msisdn": "string",
    "email": "string"
  },
  "country": "AT",
  "data": [
    {
      "key": "customer_id",
      "value": "external_id_1234"
    }
  ],
  "locale": "en"
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "9c14c6f2f0ee4a54a280be3c18ec1dba"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

Consent not found

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "9c14c6f2f0ee4a54a280be3c18ec1dba"
}

{
  "errorCode": "not_found",
  "errorMessage": "Can't find consent '123'",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/not_found"
}

Loading...