Error dictionary in web client calls in OB-clients

During the TPP flow, errors can happen at various stages:

  1. On integration with the Central Directory;

  2. In the DCR flow;

  3. In the generation of token client credentials;

  4. In the creation of consent;

  5. In the Redirect (authorize).

In this way, in order to precisely identify the stage where the error occurs and compose the interoperability report required by the Bacen, a dictionary with the specific error codes was created.

Error Dictionary

ACCESSTOKENDISC
- Error when calling the process of requesting the OAuth 2 token endpoint (OpenID Connect Discovery).
- Endpoint malfunction: https://remoteAuthServerHost/tokenPath

ACESSTOKENAUTHCODE
- Error when calling the token endpoint to generate access token authorization code.
- Endpoint malfunction: https://remoteAuthServerHost/tokenPath

APIREQ
- Error when calling the requested resource endpoint.
- Endpoint malfunction: https://remoteBankHost/apiResourcePath

APIREQORGAUTH
- Error when calling to list API Resources by organizationId and authServerId.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/authorisationServersPath/{authServerId}/apiResourcesPath

APIREQORGAUTHRID
- Error when calling to list API Resources by organizationId, authServerId and API resourceId.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/authorisationServersPath/{authServerId}/apiResourcesPath/{apiResourceId}

AUTH
- Error when calling to get auth server by organizationId in the Central Directory.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/authorisationServersPath

AUTHORG
- Error when calling to get an auth server by organizationId and authServerId in the Central Directory.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/authorisationServersPath/{authServerId}

CERTDEC
- Error when calling to get certificate for decode process (keyStore).
- Endpoint malfunction: https://keyStoreHost/{organisationId}/{keyId}

DELCLI
- Error when calling delete on client registry endpoint.
- Endpoint malfunction: https://remoteAuthServerHost/registrationEndpoint

DELCONSENT
- Error when calling to revoke a share consent.
- Endpoint malfunction: https://remoteBankHost/open-banking/consents/v1/consents/{consentId}

ENCRYPT
- Error when calling to request JWKS.
- Endpoint malfunction: https://remoteAuthServerHost/jwksPath

GETCONSENT
- Error when calling to get a share consent.
- Endpoint malfunction: https://remoteBankHost/open-banking/consents/v1/consents/{consentId}

GETPAYMENT
- Error when calling to get a payment consent.
- Endpoint malfunction: https://remoteBankHost/open-banking/payments/v1/consents/{consentId}

OIDCDISC
- Error when calling the discovery process (OpenID Connect Discovery).
- Endpoint malfunction: https://remoteAuthServerHost/.well-known/openid-configuration

ORG
- Error when calling to get an organization by organizationId in the Central Directory.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}

POSTCONSENT
- Error when calling to create a share consent.
- Endpoint malfunction: https://remoteBankHost/open-banking/consents/v1/consents

POSTPAYMENT
- Error when calling to create a payment consent.
- Endpoint malfunction: https://remoteBankHost/open-banking/payments/v1/consents

REFRESHTOKEN
- Error when calling token endpoint to generate refresh token.
- Endpoint malfunction: https://remoteAuthServerHost/tokenPath

REGCLI
- Error when registering a new client (DCR).
- Endpoint malfunction: https://remoteAuthServerHost/registrationEndpoint

SOFTIDSTATORG
- Error when calling to list an Open Banking Brazil software statement by organizationId and software statementId.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/softwareStatementsPath/{softwareStatementId}

SOFTSTATASS
- Error when calling Software Statement Assertion operation.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/softwareStatementsPath/{softwareStatementId}/softwareStatementAssertionPath

SOFTSTATORG
- Error when calling to list software statements of Open Banking Brazil by organizationId.
- Endpoint malfunction: https://diretorioApiHost/organisationPath/{organisationId}/softwareStatementsPath

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]