Search bank

URL of the service

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

The search_bank request can be used to search for a bank. The user enters all data known to him / her such as BIC, National Bank ID or town. The server returns a list of banks most closely matching the input.

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_result	Depending on the input argument passed, the result either refers to the IBAN validation or to the IBAN calculation. Result of the IBAN validation (in_iban input argument) `3` = The IBAN is valid, no input-related data found `2` = The IBAN is valid, BCN and/or BIC was/were modified `1` = The IBAN is valid `0` = The IBAN is invalid `-1` = Error in argument `-2` = Format error `-3` = The IBAN is invalid (according to the German IBAN rules) Result of the IBAN calculation (in_bcn and in_account input arguments) and validation of the national bank ID/account number: `5` = The account number was not validated `4` = The account number is valid, BCN and/or BIC was&were modified `3` = The account number is valid (no validation method defined) `2` = The account number is valid (no validation defined for this account number) `1` = The account number is valid `0` = The account number is invalid `-1` = Error in argument `-2` = The account number format is invalid `-3` = The national bank ID format is invalid `-4` = The national bank ID is invalid `-5` = Unknown validation method `-6` = A system function call failed	-
icon: arrow-up[] out_result_text	Result of account number validation as plain text.	-
icon: arrow-up[] out_bcn	National Bank ID	-
icon: arrow-up[] out_bic	Bank Identifier Code. The BIC is used for worldwide identification of the institutions involved in financial transactions. 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).	-

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_result

Depending on the input argument passed, the result either refers to the IBAN validation or to the IBAN calculation.

Result of the IBAN validation (in_iban input argument)
3 = The IBAN is valid, no input-related data found
2 = The IBAN is valid, BCN and/or BIC was/were modified
1 = The IBAN is valid
0 = The IBAN is invalid
-1 = Error in argument
-2 = Format error
-3 = The IBAN is invalid (according to the German IBAN rules)

Result of the IBAN calculation (in_bcn and in_account input arguments) and validation of the national bank ID/account number:
5 = The account number was not validated
4 = The account number is valid, BCN and/or BIC was&were modified
3 = The account number is valid (no validation method defined)
2 = The account number is valid (no validation defined for this account number)
1 = The account number is valid
0 = The account number is invalid
-1 = Error in argument
-2 = The account number format is invalid
-3 = The national bank ID format is invalid
-4 = The national bank ID is invalid
-5 = Unknown validation method
-6 = A system function call failed

icon: arrow-up[] out_result_text

Result of account number validation as plain text.

icon: arrow-up[] out_bcn

National Bank ID

icon: arrow-up[] out_bic

Bank Identifier Code. The BIC is used for worldwide identification of the institutions involved in financial transactions. 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).