search_customers is a JSON-RPC method provided by SPMM™ Web Service working under BINETIX® AGE™ node. Searches and evaluates an input string with customer data encoded in SWIFT Information Service Character Set, and returns the evaluated result as structured JSON object with variety of fields. The Evaluation Process requires the meaning parts (lines) of the input string to be preliminary separated by on of the following ASCII separators despite the character set of the content: •TAB (0x9) - Horizontal Tab •LF (0x10) - Line Feed •VT (0x11) - Vertical Tab •CR (0x13) - Carriage Return •FS (0x28) - File Separator •GS (0x29) - Group Separator •RS (0x30) - Record Separator •US (0x31) - Unit Separator •| (0x124) - Vertical bar
For reference, the SWIFT Information Service Character Set, or the new "Z" Character set (SR 2018), consist of: a b c d e f g h i j k l m n o p q r s t u v w x y z The Search Process is executing a complex blend of phonetic algorithms and FTS queries to external data sources, in order to determine how the evaluated data correspond to the factual client's data stored on production Client Registry. Ultimately, this function aggregates the findings from the Evaluation Process with all relevant records crawled by the Search Process and performs Risk Assessment to determine and verify the data consistency against the identified customers from the data sources, if any. The overall work-flow is illustrated below::  |
|
Result Data
|
This JSON object contains fields and sub-fields generated as a result of the Evaluation and Search Processes. All findings, relevant to the final result, including all possible duplications, will be included into the Data Object as dedicated fields. Detailed description of the fields provided by the Evaluation process can be found here. The fields below are populated only when relevant records are found in the Client Registry: 1)clients_datasource - refers to the external data source where the FTS queries are commenced. 2)clients_dataset is a list of JSON objects with the most relevant records found within the Client Registry. Each of those records has the following fields: a.client_id - reference ID to the Client's Registry. Usually this is the unique identifier to the clients data. b.client_number - reference number to external data-source or authority. c.client_address - contains the full description of the client's address. d.client_account - contains the result of evaluated IBAN data. e.client_account_value - contains the raw account data found in the Client Registry (without any evaluation). f.individual_name - contains the full name of the client. g.individual_id - contains the result of evaluated TIN data. h.individual_id_value - contains the raw data of the client ID (without any evaluation). i.organization_name j.organization_id_eik - contains the result of evaluated EIK data. k.organization_id_value - contains the raw data of the client EIK (without any evaluation). l.fts_rate - refers to the relative FTS rate provided by the selected data-source. m.more - this optional field may contain a JSON object with variety of data-source specific fields extracted during the Search Process. Keep in mind, however, that the format description of these external fields is data-source dependent and therefore is out of the scope of the current specification. 3)clients_records_found contains the total number of records found in the data-set; 4)clients_records_limit contains the maximum threshold of records eventually to be found in the data-set. This limit is configurable integer value (see Configuration article). 5)clients_fts_rate is the average value of all fts rates found in the database. For better consistency, this value is represented always in percentage [%] despite the type of the FTS engine (data source). Depending on the FTS data-source, the records could contain equal FTS rates which will not affect the calculation of their average value. For example, in case all records have the same FTS rate, then the average value will be calculated as 100%, meaning that the found records are equally relevant to the overall success in the final search result. 6)risk_assessment is a special object which contains a summery of all findings and aggregations collected during the Search Process. a.risk_index - this is a dynamically calculated floating-point value that relatively indicates the impact of variety negative risk factors onto the overall consistency between the input string sequence and the aggregated findings in the final result. b.risk_level - in accordance with the value of the calculated Risk Index, the Risk Level could have one of the following values: i.ok ii.very_low iii.low iv.medium v.high vi.very_high c.no_account - this tag shows that no account is detected within the input string d.invalid_iban - this tag shows that the IBAN provided within the input string has issues e.no_address - this tag shows that no address information is detected within the input string f.no_individual - this tag shows that no personal data is detected within the input string g.no_company - this tag show that no corporate data is detected within the input string h.no_client_address - this tag shows that the primary client found in the Client's Registry has no address information i.unexpected_account - this tag shows that the account information provided with the input string differs from the account information found in the primary client's record. j.unexpected_individual - this tag shows that the name of evaluated individual full name differs significantly from the Individual's full name found in the primary client's record. The comparison level is calculated in % and controlled by fuzzy_individual_rate. k.unexpected_company - this tag shows that the name of evaluated company name differs significantly from the Company's name found in the primary client's record. The comparison level is calculated in % and controlled by fuzzy_company_rate. l.no_clients - this tag shows that no relevant clients are found in the Client's registry based in the FTS query and the input string m.many_clients - this tag shows that on ground of the commenced FTS queries two or more relevant records are found in the Client's Registry. n.fts_threshold - this tag shows that the calculated FTS client rate (see clients_fts_rate) is equal or below the specified threshold in the configuration. Take into consideration that any tag associated with the Risk Assessment refers to particular Risk Category and may have different impact factor. The optimal balance between the risk categories and the impact factors is fully configurable. By default, the following risk categories are defined: •emergency - with highest impact factor •alert •critical •warning •notice - with lowest impact factor |
https://localhost:8061/binetix/spmm |
{ |
{ |
