API Reference

Upload Bank Statement

ParameterRequiredFormatComment
fileTruePDF/XLSXOne of more bank statement files can be uploaded
bank_nameTrueStringValid bank name of the uploaded bank statement.
Bank names you can get from our get_banks_list API.
account_numberTrueStringAccount Number of the uploaded bank statements
account_typeTrueStringIt should be either
1)CURRENT
2)CASH_CREDIT
3)OVER_DRAFT
4)SAVINGS
passwordOptionalHashmap/DictionaryIt should be a key value pair with filename and password.
entity_nameTrueStringEntity full name. Alphanumeric input will be accepted with limit of
130 characters.

Name of the Entity , For example if the account type is SAVINGS entity name would be the customer name and if the account type is CURRENT then it should be a Company Name.

Exceptions:

❗️

One or many of the fields in the payload is empty.

When Required params are empty.

{
    "is_success": false,
    "error": {
        "message": "Payload is Incorrect, Mandatory field is missing.",
        "code": "service_error"
    }
}

❗️

One or many of the files in the payload is empty.

When file key is present and in the value , file not uploaded.

{
    "is_success": false,
    "error": {
        "message": "One or many of the files in the payload is empty.",
        "code": "service_error"
    }
}

❗️

Payload is Incorrect, Mandatory field is missing.

When Mandatory/Required fields are missing in the payload

{
    "is_success": false,
    "error": {
        "message": "Payload is Incorrect, Mandatory field is missing.",
        "code": "service_error"
    }
}

❗️

Passwords in payload are not in valid format.

When passwords are not in the asked format.

{
    "is_success": false,
    "error": {
        "message": "Passwords in payload are not in valid format.",
        "code": "service_error"
    }
}

❗️

Either .pdf or xlsx format bank statements only accepted.

When uploaded bank statements were not in PDF/xlsx.

{
    "is_success": false,
    "error": {
        "message": "Either .pdf or xlsx format bank statements only accepted.",
        "code": "service_error"
    }
}

❗️

The uploaded files seems to be modified. Please upload original online downloaded files.

When we try to upload a documents which has been tampered like edited while sending..etc

{
    "is_success": false,
    "error": {
        "message": "EUP063 : The uploaded files seems to be modified. Please upload original online downloaded files.",
        "code": "service_error"
    }
}

❗️

The uploaded file does not meet the required criteria. Please upload digital PDF file.

When we upload scanned documents to the API.

{
    "is_success": false,
    "error": {
        "message": "EUF059: The uploaded file does not meet the required criteria. Please upload digital PDF file.",
        "code": "service_error"
    }
}

❗️

Incorrect file password provided

When incorrect file password have given.

{
    "is_success": false,
    "error": {
        "message": "EIP069: Incorrect file password provided.",
        "code": "service_error"
    }
}

❗️

Incorrect Account Number Format

When Account number format is not correct.

{
    "is_success": false,
    "error": {
        "message": "EAN093: Incorrect Account Number Format.",
        "code": "service_error"
    }
}

❗️

More than 12 files uploaded

If we tried to upload more than 12 files.

{
    "is_success": false,
    "error": {
        "message": "ENF031: More than 12 files uploaded.",
        "code": "service_error"
    }
}

❗️

The uploaded files do not meet the required criteria. Please upload latest bank statement files

When the uploaded documents doesn't have latest six months bank statements.

{
    "is_success": false,
    "error": {
        "message": "EPD068: The uploaded files do not meet the required criteria. Please upload latest bank statement files.",
        "code": "service_error"
    }
}

❗️

Mismatch in Account Number entered in payload and in file

If AccountNumber entered in payload is not match with Account Number in all files

{
    "is_success": false,
    "error": {
        "message": "EAN140 : Mismatch in Account Number entered in payload and in file.",
        "code": "service_error"
    }
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!