DEVELOPER GUIDE
Codes and Errors

Open Data Codes and Errors

2min

The following code definition is only valid for Open Data.

Common code

Code

Message

Description

Suggested instructions

200

OK





201

The crawler has completed the scheduled work, but some data still needs user's extra authorization, which is beyond klavi's control.

Extra authorization required



202

The crawler has completed the scheduled work, but some transaction details failed to be downloaded. It is related to the availability of data source itself, which is beyond klavi's control.

Partial transaction missing



203

CPF missing

The report did not return CPF value



400

Signature failed

Signature failed



401

User not found

[GET method only] No matching CPF found for data retrieve



402

User credential error

Generic error when the user input the wrong credential (e.g. e-mail, phone number, account, password or token) and connection fails

Instruct users to double check their info and try it again

403

Bank service error

Bank service is not available and connection failed

Instruct users to log in again later

404

Unexpected error

Other unexpected error and connection failed

Open a ticket with the Klavi team

405

Account info is null

Connection is successful but no account information found



406

Wrong password input too many times, try again tomorrow

The user input the wrong credential too many times. To avoid password blocking, the system has frozen the login retry until the next day

Instruct users to login after 1 day (24h)

407

Account or password activation problem

Inactive account, inactive password, temporary password or expired password

Instruct users to resolve the pending issue with the bank

408

Account or password blocked

The account or password is blocked

Instruct users to reset their internet banking password

409

Account type error

The user input the credential of wrong account type (e.g. corporate or whitelabel credit card)

Instruct users to connect to a compatible account

410

Input format error

User input credential format is incorrect or missing



411

TraceId is null or not found

TraceId of task is null or not found



412

Token is not required

Token is not required



413

Duplicated login

Duplicated login, users need to logout their bank and try again

Instruct users to close the current active sessions

414

Security measurement from bank

Security measurement from bank that caused connection failure

Instruct users to connect after 1 day (24h)

415

Institution registration not finished

As a security measure, wait 30 minutes for the registration to be finished.

Instruct users to log in after 30 min

416

Account cannot be accessed in multiple devices

Unable to make the connection. This account does not allow access on multiple devices



417

Unable to connect using external authenticator

Unable to connect using an external authenticator, such as Google, Apple or Facebook



418

Registration not found at the institution

Registration not found at the institution trough the data provided



419

Registration Limit

The amount of cell phones registration reached the limit for this CPF

Specific for FGTS. Instruct the user to go to a Caixa's agency

420

Access regularization required

User needs to regularize access

Specific for FGTS. Instruct the user to go to a Caixa's agency

429

Too Many Requests

Too many API requests in a short period



430

The data has been deleted

The data has been deleted by calling the delete API.



431

Connection update limit exceeded

Number of updates requested are above the limit allowed



432

Institution unavailable

A connection request was made to an institution that is currently unavailable

Check our status page for more updates on institution availability (https://status.klavi.ai/)

433

Password Error

The user input wrong password

Instruct users to input the correct password

434

Wrong MFA Error

The user inputs the wrong MFA token

Instruct users to input the correct MFA Token

435

MFA not entered

The user doesn't input the MFA token

Instruct users to input the correct MFA Token

500

Internal Server Error

Internal Server Error



501

Invalid access

[GET method only] Either Partner Code or Partner Token is missing



502

Partner code not activated

[GET method only] Partner Code has not been activated or is disabled



503

Partner credential error

[GET method only] Wrong Partner Code or Partner Token



504

Permission required for the data type

[GET method only] Permission required for the data type



505

Request parameter missing or invalid

[GET method only] Request parameter missing or invalid





Update user data code

Code

Message

Description

200

OK



600

Invalid route

Invalid route for access

601

Auto update unauthorized

Auto update is not authorized by user

602

Request body invalid

Parameter in request body is missing or invalid (e.g. connectionKey or allowAutoUpdate)

701

Invalid access

Either Partner Code or Partner Token is missing

702

Partner code not activated

Partner Code has not been activated or is disabled

703

Partner code or token invalid

Wrong Partner Code or Partner Token

704

No access permission

Partners have no access permission to this service

708

Data format verification failed

The request data format is incorrect