The Ruby OCR SDK supports the Bank Account Details API.
Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
require 'mindee' # Init a new client mindee_client = Mindee::Client.new(api_key: 'my-api-key') # Load a file from disk input_source = mindee_client.source_from_path('/path/to/the/file.ext') # Parse the file result = mindee_client.parse( input_source, Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2 ) # Print a full summary of the parsed data in RST format puts result.document # Print the document-level parsed data # puts result.document.inference.prediction
######## Document ######## :Mindee ID: bc8f7265-8dab-49fe-810c-d50049605578 :Filename: default_sample.jpg Inference ######### :Product: mindee/bank_account_details v2.0 :Rotation applied: Yes Prediction ========== :Account Holder's Names: MME HEGALALDIA L ENVOL :Basic Bank Account Number: :Bank Code: 13335 :Branch Code: 00040 :Key: 06 :Account Number: 08932891361 :IBAN: FR7613335000400893289136106 :SWIFT Code: CEPAFRPP333 Page Predictions ================ Page 0 ------ :Account Holder's Names: MME HEGALALDIA L ENVOL :Basic Bank Account Number: :Bank Code: 13335 :Branch Code: 00040 :Key: 06 :Account Number: 08932891361 :IBAN: FR7613335000400893289136106 :SWIFT Code: CEPAFRPP333
These fields are generic and used in several products.
Each prediction object contains a set of fields that inherit from the generic
Field object will have the following attributes:
- value (
Boolean): corresponds to the field value. Can be
nilif no value was extracted.
- confidence (Float, nil): the confidence score of the field prediction.
- bounding_box (
nil): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
- polygon (
nil): contains the relative vertices coordinates (
Point) of a polygon containing the field in the image.
- page_id (
nil): the ID of the page, is
nilwhen at document-level.
- reconstructed (
Boolean): indicates whether or not an object was reconstructed (not extracted as the API gave it).
Aside from the previous attributes, all basic fields have access to a
to_s method that can be used to print their value as a string.
The text field
StringField only has one constraint: it's value is a
Fields which are specific to this product; they are not used in any other product.
Full extraction of BBAN, including: branch code, bank code, account and key.
BankAccountDetailsV2Bban implements the following attributes:
bban_bank_code(String): The BBAN bank code outputted as a string.
bban_branch_code(String): The BBAN branch code outputted as a string.
bban_key(String): The BBAN key outputted as a string.
bban_number(String): The BBAN Account number outputted as a string.
The following fields are extracted for Bank Account Details V2:
account_holders_names (StringField): Full extraction of the account holders names.
bban (BankAccountDetailsV2Bban): Full extraction of BBAN, including: branch code, bank code, account and key.
iban (StringField): Full extraction of the IBAN number.
swift_code (StringField): Full extraction of the SWIFT code.
Updated 11 days ago