Finqware API
Search…
Errors
A list of standard errors & codes.

Notes

  • The errors returned by the middleware are technical- not meant to be used in a user-facing application.
  • Please use these messages for internal logging and map them to user-friendly messages depending on your particular app architecture and use case.
  • When reporting an error to Finqware, please include the provided id.

Schema

API errors respect this common structure:
1
{
2
"id": String,
3
"type": String,
4
"http": Integer,
5
"code": String,
6
"message": String
7
}
Copied!
Description of fields:
  • id: an error id used for debugging
  • type: a more generic class of errors
  • http: a standard http code (200, 4xx, 5xx)
  • code: a more specific error code
  • message: developer friendly message and eventual hints

Invalid requests

Errors generated due to incorrect input.
1
{
2
"id": "uuid",
3
"type": "invalid_request",
4
"http": 400 | 404,
5
"code": "missing_fields" |
6
"unknown_fields" |
7
"invalid_field" |
8
"invalid_credentials_id" |
9
"invalid_client_id" |
10
"invalid_client_secret" |
11
"invalid_access_token" |
12
"invalid_input" |
13
"invalid_body" |
14
"invalid_headers" |
15
"not_found" |
16
"invalid_step" |
17
"invalid_session_id" |
18
"invalid_skill_name" |
19
"invalid_pcd_data_retention" |
20
"tpp_redirect_error"
21
"message": "Detailed error message"
22
}
Copied!

Unauthorized

Errors generated due to incorrect input, related to various security tokens.
1
{
2
"id": "uuid",
3
"type": "unauthorized",
4
"http": 401,
5
"code": "invalid_api_keys" |
6
"unauthorized_tenant" |
7
"invalid_access_token" |
8
"invalid_credentials_id" |
9
"invalid_client_id" |
10
"invalid_client_secret" |
11
"invalid_client_app_key" |
12
"inactive_credentials" |
13
"expired_credentials" |
14
"invalid_uuid" |
15
"invalid_tenant_keys" |
16
"invalid_api_keys" |
17
"invalid_temp_token"
18
"message": "Detailed error message"
19
}
Copied!

External API errors

Errors generated by external APIs. Sometimes these errors are returned even when correct input is provided.
1
{
2
"id": "uuid",
3
"type": "external_api_error",
4
"http": 400,
5
"code": "external_api_connection_error" |
6
"external_api_too_many_requests" |
7
"external_api_unauthorized" |
8
"external_api_forbidden" |
9
"external_api_duplicated_consent" |
10
"external_api_expired_consent" |
11
"external_api_invalid_psu_id" |
12
"external_api_server_error" |
13
"message": "Detailed error message"
14
}
Copied!

Internal server errors

1
{
2
"type": "server_error",
3
"http": 500,
4
"code": "internal_server_error" |
5
"planned_maintenance"
6
"message": "Detailed error message"
7
}
Copied!
Last modified 3mo ago