API Reference

Beneficiary Validations

post
https://app.financekey.com/OData/IbanChecks

The IbanCheck table is a part of the Account package and is used to store and validate International Bank Account Numbers (IBAN). It contains the IBAN number, the country code associated with the IBAN, and an indicator showing whether the IBAN is valid or not. This table is used to ensure accuracy when entering and checking the validity of different international bank accounts.

Body Params
int32

IbanCheckId is an integer field in the IbanCheck table which serves as the primary key and identifies each row/record uniquely. It is typically not used by developers for business logic, but serves to uniquely identify each row of the table for the purposes of data integrity.

string
required
length ≥ 1

BeneficiaryName: Field type nvarchar, information stored in this field is the legal name of the beneficiary associated with each IbanCheck record.

string
required
length between 1 and 11

SwiftBicId is an nvarchar field in the IbanCheck table which stores a character-encoded identifying code associated with a financial institution’s account. This maximum 11-character field is used to identify the specific bank or financial institution associated with a user's account.

string
required
length between 1 and 34

The Iban field in the IbanCheck table stores International Bank Account Numbers (IBANs) of up to 34 alphanumeric characters. The field is stored as an nvarchar data type to enable the storage of international character sets such as those used in IBANs.

int32 | null

RequestorId is an int data type field in a table called IbanCheck. It is used to store the unique ID of a client making a request to the system. This will be used to identify the client and to track the request.

string | null

IbanCheckStateId is an NVARCHAR field, with a maximum length of 128, which can be found in the IbanCheck table. This field is used to store a unique identifier for the check state for a given IBAN string.

string | null

The Response field in the IbanCheck table is of type nvarchar and it is used to store a text-based response to an IBAN check query with either 'valid' or 'invalid' as the two possible outcomes.

string | null

The BankReference field of the IbanCheck table stores the transaction reference code used by the bank to identify a particular transaction. It is stored as a NVARCHAR data type and allows for up to a predefined length of characters.

date-time | null

The field LastStateCheck of data type datetime2 in the table IbanCheck stores information related to the last time the state of the corresponding IBAN account was checked.

string | null

The SourceEntityId field in the IbanCheck table is a nvarchar data type that stores a unique identification number for the source entity of an International Bank Account Number (IBAN) check. This field serves as a reference to the financial institution or organization that initiated the IBAN verification process. It can contain a combination of letters and numbers and has a maximum character limit to ensure accurate and efficient data retrieval. This field is crucial in identifying the responsible party for an IBAN check and is essential in record-keeping and compliance purposes.

int32 | null

The SourceItemId field in the IbanCheck table is a data type of integer and serves as a unique identifier for each record. This field is used to track the source of the data for each entry in the table, allowing for easy categorization and sorting of information. It acts as a reference to the specific source system or source entity from which the data was extracted. The SourceItemId field is a crucial component in ensuring the accuracy and integrity of the data in the IbanCheck table.

string | null
string | null

The ProviderId field in the IbanCheck table is a nvarchar data type with a maximum length of 450 characters. It is used to store the unique identification number of the provider that is associated with a specific International Bank Account Number (IBAN). This field is an essential piece of data in the verification process of IBAN codes, as it helps identify the financial institution that issued the IBAN. With a maximum length of 450 characters, the ProviderId field can accommodate various identification numbers from different providers, ensuring accurate and comprehensive data storage for IBAN checks.

string | null
string | null

The SortCode field in the IbanCheck table is a column with a data type of nvarchar and a maximum length of 128 characters. It is used to store the sort code associated with an International Bank Account Number (IBAN). The sort code is a numerical code used to identify a specific bank and branch within a banking system. This field is important in verifying the validity of an IBAN and ensuring accurate financial transactions. Users can enter up to 128 characters in this field to accommodate different formats of sort codes.

int32 | null
string | null

Miscellaneous notes and information for the entry or record.

Response
200

OK

Updated over 2 years ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated over 2 years ago