Request errors

On this page you'll find information regarding errors that you might encounter when making API requests, and how to solve them.

400 null

[
    {
        "field": "institution",
        "request_id": "b9abda13c9afbbc64a265c6d4f937d06",
        "message": "This field may not be null.",
        "code": "null"
    }
]

Cause

You made a request without providing data in a required field. For example:

{
    "institution": , // This field is required.
    "username": "bnk100",
    "password": "full",
}

Solution

  • Check the error message to see which field you need to provide. If you're not sure what information to provide or the format, just check our API reference documentation.

400 required

[
    {
        "field": "username",
        "request_id": "b9abda13c9afbbc64a265c6d4f937d06",
        "message": "This field is required.",
        "code": "required"
    }
]

Cause

You sent a request without a required field. For example:

{
    "institution": "erebor_mx_retails",
            // When you are registering a new link, you must provide a username.
    "password": "full"
}

Solution

  • Check the error message to see which field you need to provide. If you're not sure what information to provide or the format, just check our API reference documentation.

400 blank

[
    {
        "field": "institution",
        "request_id": "b9abda13c9afbbc64a265c6d4f937d06",
        "message": "This field may not be blank.",
        "code": "null"
    }
]

Cause

You sent a request with an empty string for a required field. For example:

{
    "institution": "", // This field is required and cannot be an empty string.
    "username": "bnk100",
    "password": "full",
}

Solution

  • Check the error message to see which field you need to provide. If you're not sure what information to provide or the format, just check our API reference documentation.

400 invalid_choice

[
    {
        "field": "access_mode",
        "request_id": "ce49b6af6710bb0c7a2a456c223dde21",
        "message": "\"Dominik\" is not a valid choice.",
        "code": "invalid_choice"
    }
]

Cause

You made a request where in one of the fields you provided a value that wasn't valid (for example, it may only accept certain strings, much like an enum). For example:

{
    "institution": "erebor_mx_retail",
    "username": "bnk100",
    "password": "full",
    "access_mode": "Australia" // This is not a valid choice, as in the documentation it states that it is an enum: single or recurrent
}

Solution

  • Check the error message to see in which field you provided an incorrect value. Then check our documentation to see what value you should provide for this field.

400 invalid

[
    {
        "field": "date_to",
        "request_id": "a7ad9a4ad8b13f8f800f8f5b69c7856f",
        "message": "Date has wrong format. Use one of these formats instead: YYYY-MM-DD.",
        "code": "invalid"
    }
]
[
    {
        "field": "link",
        "request_id": "448f2b58fc88b2c5a9db6c9175494950",
        "message": "“YTZjMDA3YjktZTk5Yy00MDczLTgzNGItOGM3NzA1MTMyZGU3” is not a valid UUID.",
        "code": "invalid"
    }
]

Cause

You send a request where you provided a value in an invalid format. This could include:

  • The format of the login credentials is incorrect.
  • The data format is incorrect.
  • The UUID is not valid.

For example:

{
    "link": "a6c007b9-e99c-4073-834b-8c7705132de7",
    "date_from": "2020-01-01",
    "date_to": "2020-02" // Here, the date format must be YYYY-MM-DD
}
{
    "link": "a6c007b9-e99c" // Here, the link ID is not a valid UUID.
}

Solution

Check the error message to see which field is invalid and why. Then, if you need more information, check our API docs to know what the valid format for the field is.

400 does_not_exist

[
    {
        "field": "institution",
        "request_id": "744da6621cb09b3cbb8271d89fe09060",
        "message": "Object with name=narnia does not exist.",
        "code": "does_not_exist"
    }
]

Cause

You sent a request where you provided a value that doesn't exist in the Belvo database. For example:

{
    "institution": "narnia", // This institution does not exist in the Belvo database.
    "username": "bnk100",
    "password": "full"
}

Solution

Check the error message to see in which field you provided an incorrect value. Then:

  • Make sure that you haven't made any typos
  • Check if the value you are providing should be present in our database (for example, if you make a request for a link that wasn't registered yet, you will receive an error)

400 parse_error

[
    {
        "message": "JSON parse error - Expecting property name enclosed in double quotes: line 3 column 1 (char 54)",
        "code": "parse_error",
        "request_id": "d5af76cc66e0231e2be7f7be5c41170a"
    }
]

Cause

You sent a request with invalid JSON. For example:

{
    "link": "a6c007b9-e99c-4073-834b-8c7705132de7", // Here, you should not have a trailing comma in your request
}

Solution

Check the JSON payload (perhaps you're just missing a comma or quotation mark) and try again.

400 validation_error

[
    {
        "message": "Bad request",
        "code": "validation_error",
        "request_id": "e912d014d7976c3172bb8e65c7a22194"
    }
]

Cause

You sent a request where:

  • the credentials provided did not match the expected fields, leading to a field validation error from the institution.

For example:

{
    "link": "a6c007b9-e99c-4073-834b-8c7705132de7",
    "date_from": "2020-01-01",
    "date_to": "2021-03-30" // Between date_from and date_to there are more than 365 days
}

Solution
Get the details for the institution using our Institutions endpoint and check the form_fields object for information on what fields need to be provided and their format.

404 not_found

[
    {
        "message": "Not found.",
        "code": "not_found",
        "request_id": "1d1c4f427dac394a96c3fa49568f2a38"
    }
]

Cause
You made a request where you:

  • provided the wrong URL.
  • used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.

Solution
Make sure that:

  • You are using the correct URL (check for typos and our API reference documentation).
  • You are using an ID that is associated with your Belvo account.

Did this page help you?