GET /service/inquiry/:inquiryId

Get consent inquiry

Provides details on a consent inquiry, including scope, duration, and additional information for the party for whom the consent is intended.

Path Parameters

inquiryId ConsentInquiryId required

id of consent inquiry

Responses

• 200
• 400
• 401

---

Configured consent inquiry

application/json

Schema

Example (from schema)

---

Schema

id ConsentInquiryId

Consent inquiry id

status ConsentInquiryStatus

Possible values: [initiated, active, inactive, deleted]

Consent inquiry status.

name string
displayName string
description string
scope ConsentScope

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

Consent scopes for account information access.

frequency ConsentInquiryFrequency

Possible values: [once, daily]

Consent inquiry frequency.

tenant object

Additional Tenant information as configured.

name string

Name of tenant - as configured in administration - Settings

companyName string

Company legal name. As configured in administration - Company info

addressStreet string

Company address street. As configured in administration - Company info

addressStreetNumber string

Company address street number. As configured in administration - Company info

addressCity string

Company address city name. As configured in administration - Company info

addressZipCode string

Company address city ZIP code. As configured in administration - Company info

addressCountry string

Company address country code. As configured in administration - Company info

{
  "id": "string",
  "status": "active",
  "name": "string",
  "displayName": "string",
  "description": "string",
  "scope": "all",
  "frequency": "once",
  "tenant": {
    "name": "string",
    "companyName": "string",
    "addressStreet": "string",
    "addressStreetNumber": "string",
    "addressCity": "string",
    "addressZipCode": "string",
    "addressCountry": "string"
  }
}

Invalid parameter, can't fulfill request

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": "invalid_parameter",
  "errorMessage": "Missing consent 'provider'!",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/invalid_parameter"
}

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"
}

Loading...