GET /account/auth/token/:environment/:channel/:inquiryId

Access token

Returns a new access token. The access token validity is time-limited. Each account access consent flow is coupled with an access token - therefore the account access consent flow is also time-limited (i.e. must be finished or cancelled in the given time frame).

Path Parameters

environment Environment required

Possible values: [production, sandbox]

API key/secret and environment must match.

channel AccountChannel required

Possible values: [api, sdk]

Channel for account access flow - api/sdk.

inquiryId ConsentInquiryId required

Account consent inquiry definition id

Header Parameters

Api-Key string required

API key for given environment

Api-Secret string required

API secret for given environment

Responses

• 200
• 401
• 403

---

Access token with scope and expiration time

application/json

Schema

Example (from schema)

---

Schema

accessToken string

generated access token to access API

expires date-time

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

expiresIn integer

number of seconds when token session expires

scope TenantService[]

Possible values: [account_owner, account_info, account_transactions, payments, risk_scoring]

Set of token access privileges

{
  "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJ0ZW5hbnRJZCI",
  "expires": "2026-01-12T09:34:33.055Z",
  "expiresIn": 360,
  "scope": [
    "account_owner"
  ]
}

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

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

Access forbidden / most likely production access is not allowed

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

{
  "errorCode": "forbidden",
  "errorMessage": "Point of sale with id 'my_point_of_sale' does not have 'production' access.",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/forbidden"
}

Loading...