FR Bank Account Details

FR Bank Account Details

The PHP SDK supports the Mindee V1 Bank Account Details API.

Product Specifications

Specification	Details
Endpoint Name	bank_account_details
Recommended Version	v2.0
Supports Polling/Webhooks	❌ No
Support Synchronous HTTP Calls	✔️ Yes
Geography	🇫🇷 France

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

<?php

use Mindee\Client;
use Mindee\Product\Fr\BankAccountDetails\BankAccountDetailsV2;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file
$apiResponse = $mindeeClient->parse(BankAccountDetailsV2::class, $inputSource);

echo $apiResponse->document;

Sample Output (rST)

########
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

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

• value (float|string): corresponds to the field value. Can be null if no value was extracted.

• confidence (float): the confidence score of the field prediction.

• boundingBox ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (Point[]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.

• pageId (integer): the ID of the page, always null when at document-level.

• reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

A Point simply refers to a list of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __toString method that can be used to print their value as a string.

StringField

The text field StringField implements the following:

• value (string): represents the value of the field as a string.

• rawValue (string): the value of the string as it appears on the document.

Specific Fields

Fields which are specific to this product; they are not used in any other product.

Basic Bank Account Number Field

Full extraction of BBAN, including: branch code, bank code, account and key.

A BankAccountDetailsV2Bban implements the following attributes:

• bbanBankCode (string): The BBAN bank code outputted as a string.

• bbanBranchCode (string): The BBAN branch code outputted as a string.

• bbanKey (string): The BBAN key outputted as a string.

• bbanNumber (string): The BBAN Account number outputted as a string.

Attributes

The following fields are extracted for Bank Account Details V2:

Account Holder's Names

accountHoldersNames : Full extraction of the account holders names.

echo $result->document->inference->prediction->accountHoldersNames->value;

Basic Bank Account Number

bban (BankAccountDetailsV2Bban): Full extraction of BBAN, including: branch code, bank code, account and key.

echo $result->document->inference->prediction->bban->value;

IBAN

iban : Full extraction of the IBAN number.

echo $result->document->inference->prediction->iban->value;

SWIFT Code

swiftCode : Full extraction of the SWIFT code.

echo $result->document->inference->prediction->swiftCode->value;