Check account

URL of the service

https://real-time.data-quality-service.com/rest/bank/check_account

The check_account request can be used to validate bank details. The IBAN entered is validated. Based on the National ID which is part of the IBAN and other data entered by the user (e.g. bank name), the system searches for the bank associated with the IBAN. It returns a list of banks found and the IBAN validation result.

Whenever the user enters an IBAN or account number, the bank details will be validated. If both fields are empty, the search_bank request is executed internally. Alternatively, a connection based on an account number / bank code can be checked for Germany. However, this is only possible if you leave the IBAN input field empty. As with the IBAN validation, a list of the banks found and the account number check results will be returned.

This is an input field
This is an output argument
This is a configuration parameter

Name Description Default

Name	Description	Default
language	Language in which warnings and error messages will be displayed. `de` = German `en` = English `fr` = French	en
country	Enter the ISO-2-country code for the country	-
par_country_default	Here, you can set a default value for the mandatory country input field. This converts the mandatory country input field into an optional input field. Enter the 2-digit international code of the country according to ISO 3166 ALPHA-2	-
par_evalue_tab	Evaluation table to be used to calculate the overall evaluation	standard
par_iban_case	Sets whether or not upper/lower case spelling of the IBAN is to be ignored. According to the IBAN description, an IBAN consists of digits and upper case letters only. Possible values: `0` = Both upper and lower case permitted `1` = Upper case permitted only	1
par_iban_format	IBAN format. Possible values: `0` = paper format `1` = electronic format	0
par_list_max	Maximum number of entries permitted in the search result list. The records returned are those with the highest degree of similarity. Possible values: Integer in the range from 1 to 2048	256
par_min_mval	Similarity measure. Minimum value a record has to reach to be considered similar. Possible values: Integer in the range from 1 to 100	60
par_reduce	Size of an account number validation result list Possible values: `0` = Complete result list `1` = Aggregated at bank code level `2` = As 1, however highest similarity measure only 3 = First record only	2
par_time_out	Maximum period of time (in 1/10 seconds) available for a search. Possible values: Integer in the range from 0 to 300 (0 disables time limit)	0 (no time limit)
in_account (only DE)	Account number.	-
in_bcn	National Bank ID.	-
in_bank_name	Name of the bank (e.g. Sparkasse Karlsruhe).	-
in_bic	Bank Identifier Code	-
in_city	Town.	-
in_iban	International Bank Account Number	-
in_zip	Postcode.	-
out_bcn	National Bank ID	-
out_bic	Bank Identifier Code. The BIC is used for worldwide identification of the institutions involved in financial transac- tions. It consists of 8 or 11 characters and includes for Germany the following elements: Bank code (4 characters) Country code (2 characters - DE for Germany) City code (2 characters) Branch code (3 characters - optional) The 8-digit BIC is normally used for bank transfers; the optional 3-digit suffix can or must be omitted (e.g. in online banking form).	-
out_bank_name	Name of the bank	-
out_bank_network	Sector or banking network (e.g. mutual savings bank, etc)	-
out_city	Town where the bank is located	-
out_country_code	2-letter country code according to ISO 3166 ALPHA-2	-
out_list_count	Element count in the results list	-
out_mvals	Similarity measure (individual elements)	-
out_mval	Sum of similarity measures	-
out_office_type	Main office or branch office (if applicable) 1 = Main office 2 = Branch office	-
out_zip	Postcode	-
out_bank_name	Name of the bank	-
out_bank_network	Sector or banking network (e.g. mutual savings bank, etc)	-
out_city	Town where the bank is located	-
out_clearing_area	Region where the bank operates or has its registered office (if applicable)	-
out_country_code	2-letter country code according to ISO 3166 ALPHA-2	-
out_account	Account number as contained in the IBAN	-
out_iban	IBAN. The format is specified in the par_ibanFormat parameter.	-
out_iban_calc_text	Result of the IBAN calculation in text form	-
out_iban_calc_result	Result of the IBAN calculation `0` = Generation was successful `1` = Generation not possible/not allowed for these bank details `2` = Bank details not unique, generation not possible `3` = Invalid account number, generation not possible `-1` = Invalid character found when calculating the IBAN `-2` = During the IBAN calculation, a database error occurred `-3` = Invalid argument found when calculating the IBAN `-4` = Invalid validation method for IBAN calculation `-5` = Fatal error when searching for the follow-up national bank ID	-
out_list_count	Element count in the results list	-
out_mvals	Similarity measure (individual elements)	-
out_mval	Sum of similarity measures	-
out_office_type	Main office or branch office (if applicable) `1` = Main office `2` = Branch office	-
out_zip	Postcode	-

language

Language in which warnings and error messages will be displayed.
de = German
en = English
fr = French

country

Enter the ISO-2-country code for the country

par_country_default

Here, you can set a default value for the mandatory country input field. This converts the mandatory country input field into an optional input field. Enter the 2-digit international code of the country according to ISO 3166 ALPHA-2

par_evalue_tab

Evaluation table to be used to calculate the overall evaluation

standard

par_iban_case

Sets whether or not upper/lower case spelling of the IBAN is to be ignored. According to the IBAN description, an IBAN consists of digits and upper case letters only. Possible values:
0 = Both upper and lower case permitted
1 = Upper case permitted only

par_iban_format

IBAN format. Possible values:
0 = paper format
1 = electronic format

par_list_max

Maximum number of entries permitted in the search result list. The records returned are those with the highest degree of similarity.
Possible values: Integer in the range from 1 to 2048

256

par_min_mval

Similarity measure. Minimum value a record has to reach to be considered similar.
Possible values: Integer in the range from 1 to 100

par_reduce

Size of an account number validation result list
Possible values: 0 = Complete result list
1 = Aggregated at bank code level
2 = As 1, however highest similarity measure only 3 = First record only

par_time_out

Maximum period of time (in 1/10 seconds) available for a search.
Possible values: Integer in the range from 0 to 300 (0 disables time limit)

0 (no time limit)

in_account (only DE)

Account number.

in_bcn

National Bank ID.

in_bank_name

Name of the bank (e.g. Sparkasse Karlsruhe).

in_bic

Bank Identifier Code

in_city

Town.

in_iban

International Bank Account Number

in_zip

Postcode.

out_bcn

National Bank ID

out_bic

Bank Identifier Code. The BIC is used for worldwide identification of the institutions involved in financial transac- tions. It consists of 8 or 11 characters and includes for Germany the following elements: Bank code (4 characters) Country code (2 characters - DE for Germany) City code (2 characters) Branch code (3 characters - optional) The 8-digit BIC is normally used for bank transfers; the optional 3-digit suffix can or must be omitted (e.g. in online banking form).

out_bank_name

Name of the bank

out_bank_network

Sector or banking network (e.g. mutual savings bank, etc)

out_city

Town where the bank is located

out_country_code

2-letter country code according to ISO 3166 ALPHA-2

out_list_count

Element count in the results list

out_mvals

Similarity measure (individual elements)

out_mval

Sum of similarity measures

out_office_type

Main office or branch office (if applicable)
1 = Main office
2 = Branch office

out_zip

Postcode

out_bank_name

Name of the bank

out_bank_network

Sector or banking network (e.g. mutual savings bank, etc)

out_city

Town where the bank is located

out_clearing_area

Region where the bank operates or has its registered office (if applicable)

out_country_code

2-letter country code according to ISO 3166 ALPHA-2

out_account

Account number as contained in the IBAN

out_iban

IBAN. The format is specified in the par_ibanFormat parameter.

out_iban_calc_text

Result of the IBAN calculation in text form

out_iban_calc_result

Result of the IBAN calculation
0 = Generation was successful
1 = Generation not possible/not allowed for these bank details
2 = Bank details not unique, generation not possible
3 = Invalid account number, generation not possible
-1 = Invalid character found when calculating the IBAN
-2 = During the IBAN calculation, a database error occurred
-3 = Invalid argument found when calculating the IBAN
-4 = Invalid validation method for IBAN calculation
-5 = Fatal error when searching for the follow-up national bank ID