Outils pour utilisateurs

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Prochaine révision		Révision précédente
documentation_technique_scripts [2025/05/19 15:56] – créée admindocumentation_technique_scripts [2025/05/20 16:38] (Version actuelle) – ctisserand
Ligne 1: Ligne 1:
-TC+====== Documentation pour écrire un script custom (LUA) ====== 
 + 
 +<markdown> 
 +# Squelette du script 
 +``` 
 +-- script title 
 +--- FR = script name in french 
 +--- EN = script name in english 
 +-- ... 
 +-- parameters 
 +--# param1: string | FR = parameter name in french | EN = parameter name in english | ... 
 +--# param2: boolean = True | FR = parameter name in french | EN = parameter name in english | ... 
 +-- ... 
 +-- modules 
 +--% module1 | FR = module name in french | EN = module name in english | ... 
 +--% module1 = True | FR = module name in french | EN = module name in english | ... 
 +-- ... 
 + 
 +-- business code 
 + 
 + 
 +return true or false 
 +``` 
 +# Titre du script 
 +``` 
 +--- country_alpha2 = title 
 +--- country_alpha2 = title 
 +... 
 +``` 
 +example 
 + 
 +``` 
 + 
 +--- EN = My title 
 +--- FR = Mon titre 
 +--- ES = Mi título 
 +``` 
 +Si la langue cible n'est pas disponible, EN est utilisé, sinon le premier disponible est utilisé 
 + 
 +# Paramètres 
 +``` 
 +--% module | country_alpha2 = name | country_alpha2 = name 
 +--% module2 = bool | country_alpha2 = name | country_alpha2 = name 
 +... 
 +``` 
 +params_name: 
 +Nom de variable compatible LUA 
 + 
 +Un paramètre est une variable accessible dans le script de la même facon qu'un paramètre de fonction d'un langage de programmation 
 + 
 +Il ne sert pas a définir les tests (cf. Module), ils servent a définir le comportement du code 
 + 
 +# Modules (référence pour les script) 
 +``` 
 + 
 +--# abc | FR = name | EN = name 
 +--# def = true | ES = name | AU = name 
 +... 
 +``` 
 +un module n'est PAS une variable accessible, c'est une référence pour les tests 
 + 
 +Il définissent les tests qui seront enregistrés dans le rapport archivé 
 + 
 +Une référence peut être utilisée plusieurs fois dans le script, le résultat final sera un OU logique entre tous les retours de la référence 
 + 
 +Le nom final d'une référence est consitué de tous ces composants nécéssaires + le nom de la référence 
 + 
 +exemple 
 + 
 +1. un script travaillant sur `IDENTITY_DOCUMENT` avec une référence nommé `name` et `first_name` aura comme noms de références `IDENTITY_DOCUMENT.name` et `IDENTITY_DOCUMENT.first_name` 
 +2. un script travaillant sur `IDENTITY_DOCUMENT` et la donnée name avec une référence nommé `name` et `first_name` aura comme noms de références `IDENTITY_DOCUMENT.name.name` et `IDENTITY_DOCUMENT.name.first_name` 
 +3. un script travaillant sur `X` et `Y` et la donnée `i` rt `j` avec une référence nommé `name` et `first_name` aura comme noms de références `X.Y.i.j.name` et `X.Y.i.j.first_name` 
 + 
 +# Services 
 +Un service permet l'appel à des compsants externes pour certains traitements particuliers 
 + 
 +Ci-dessous la liste des services disponibles ainsi que leur documentation extraite automatiquement 
 + 
 +Exemple:  
 + 
 +``` 
 +services.email.verify(input.data.email[0], false, false) 
 +``` 
 +## email 
 +``` 
 +services.email.verify(email: Any, check_mx: Any = True, check_server_respond: Any = False) 
 +``` 
 +Verify the regex and domain of an email 
 + 
 +- email: the email address 
 +- check_mx: Check if an MX entry exist for this domain. True by default 
 +- check_server_respond: if check_mx is True, check if the server respond. False by default 
 + 
 +## inpi 
 +``` 
 +services.inpi.by_siret(siret: str) 
 +``` 
 +Get the information on a company from INPI 
 + 
 +- siret: the SIRET number of the company 
 + 
 +``` 
 +services.inpi.by_siren(siren: str) 
 +``` 
 +Get the information on a company from INPI 
 + 
 +- siren: the SIREN number of the company 
 + 
 +## country 
 +``` 
 +services.country.country_exists(country: Any) 
 +``` 
 +From the name of a country, find all the real country that match the name 
 + 
 +- country: Name of the country to search 
 + 
 +# Données fournies en entrée du script 
 +Les données fournies par le moteur sont dans le champ `input` 
 + 
 +- data: dict[field_name, list[str]] 
 +  - field_name: str -> name of the field. only available for the field details in Validator.data 
 +- any value in DocumentTypeEnum 
 + 
 +``` 
 +local name = input.data.name 
 +``` 
 +# Données pouvant être fournies en sortie du script 
 +Les données fournies au moteur sont dans le champ `output` 
 + 
 +- identity: PersonalDetails 
 +- valid: dict[doc_name, doc_status] 
 +  - doc_name: str -> can be obtain in DocumentWrapper.name 
 +  - doc_status: bool -> true if the document is to be consider valid for the rest of the enrollment, nil if no information is available else false 
 + 
 +``` 
 +output.identity.name = real_name 
 +output.valid[doc.name] = true 
 +``` 
 +# Functions utilisables dans le script 
 +## check 
 +``` 
 +check( 
 + doc: PersonalDetails | MRZDocument | DocumentWrapper 
 + field: str | list[str] 
 + fn: bool (list[str] | Any) 
 + ref: str 
 + parse: bool = False 
 + hide: bool = False 
 + all_values: bool = False 
 +) 
 +``` 
 +Verify the validity of a field with the function given 
 +- doc: a DocumentWrapper, PersonalDetails or MRZDocument to get the value from 
 +- field: standardize field name or a list of standardize field name to get from the document 
 +- fn: the function to verify the validity of the data 
 +- ref: a description to indicate the verification done for the report 
 +- parse: True to try to parse the data before giving it to the function, False to have a string. If a PersonalDetails is or MRZDocument is given the value is already parsed 
 +- hide: True to hide this verification from the report 
 +- all_values: If False, the first value to return true is used, else every value must return true 
 + 
 +## check_concat 
 +``` 
 +check_concat( 
 + doc: DocumentWrapper 
 + field: str | list[str] 
 + fn: bool (list[str] | Any) 
 + ref: str 
 + hide: bool = False 
 + parse: bool = False 
 + allow_missing_field: bool = False 
 +) 
 +``` 
 +Verify the validity of the concatenation of multiple field with the function given 
 +- doc: a DocumentWrapper to get the value from 
 +- field: standardize field name or a list of standardize field name to get from the document 
 +- fn: the function to verify the validity of the data 
 +- ref: a description to indicate the verification done for the report 
 +- hide: True to hide this verification from the report 
 +- parse: True to try to parse the data before giving it to the function, False to have a string 
 +- allow_missing_field: True to allow the fields to not be found, else an error will be raised if a field is not found in the document 
 + 
 +## compare 
 +``` 
 +compare( 
 + doc1: PersonalDetails | MRZDocument | dict 
 + field1: str | list[str] 
 + doc2: DocumentWrapper | dict 
 + field2: str | list[str] 
 + fn: float (str | str) 
 + tr: int 
 + ref: str 
 + parse: bool = False 
 + hide: bool = False 
 +) 
 +``` 
 +Compare 2 fields from 2 different document 
 +- doc1: a PersonalDetails or MRZDocument to get the value from 
 +- field1: standardize field name or a list of standardize field name to get from the document doc1 
 +- doc2: a DocumentWrapper to get the value from 
 +- field2: standardize field name or a list of standardize field name to get from the document doc2 
 +- fn: the function to verify the validity of the data 
 +- tr: the minimum value to consider this verification valid 
 +- ref: a description to indicate the verification done for the report 
 +- parse: True to try to parse the data of doc2 before giving it to the function, False to have a string 
 +- hide: True if the verification is valid 
 + 
 +## contains 
 +``` 
 +contains( 
 + _list: list[Any] 
 + item: Any 
 +) 
 +``` 
 +Test if y is contains in x 
 +- _list: Any list 
 +- item: the item to find 
 + 
 +## correct 
 +``` 
 +correct( 
 + ref: str = "" 
 + doc: DocumentWrapper 
 + field: str | list[str] 
 + fn: str (str) 
 + ref: str = "" 
 + hide: bool = False 
 +) 
 +``` 
 +Correct a field in a document following the function given. The result of the correction replace the old value 
 +- ref: unique reference of the correction 
 +- doc: a DocumentWrapper to get the value from 
 +- field: standardize field name or a list of standardize field name to get from the document 
 +- fn: the function to correct the value < str fn(str) > 
 +- ref: a description to indicate the correction done for the report 
 +- hide: True to hide this correction from the report 
 + 
 +## create_date_mask 
 +``` 
 +create_date_mask( 
 + d: str 
 + date_format: Any = "%y%m%d" 
 +) 
 +``` 
 +Create a valid mask for the date given (ex: 1990 -> YYYY, 901212 -> YYMMDD) 
 +- d: the date as a string 
 +- date_format: the format of the date to parse 
 + 
 +## custom_info 
 +``` 
 +custom_info( 
 + infos: list[tuple[str | Any]] 
 + is_valid: Any 
 + ref: Any 
 + threshold: Any = None 
 + score: Any = None 
 +) 
 +``` 
 +Write a bloc to indicate the state of a custom verification 
 +- infos: List of name, value used for this verification 
 +- is_valid: The end result of the verification 
 +- ref: a description to indicate the verification done for the report 
 +- threshold: if used, indicate the threshold used for this verification 
 +- score: if used, indicate the score obtain with this verification 
 + 
 +## error_type 
 +``` 
 +error_type( 
 + error: Exception 
 +) 
 +``` 
 +Get the name of a python exception 
 +- error: The exception to have the name from 
 + 
 +## fuzzy 
 +``` 
 +fuzzy( 
 + x: str 
 + y: str 
 + ignore_special_chars: bool = True 
 +) 
 +``` 
 +Do a string compare with the algorithme fuzzy search 
 +- x: The first string 
 +- y: The second string 
 +- ignore_special_chars: True to transform inputs into an ASCII variant 
 + 
 +## generator 
 +``` 
 +generator( 
 + co: list[Any] 
 +) 
 +``` 
 +Make a python coroutine usable. Available: #(...), .first(), .all() 
 +- co: Python coroutine to use 
 + 
 +## get_value 
 +``` 
 +get_value( 
 + doc: DocumentWrapper 
 + field: str | list[str] 
 + parse: bool = False 
 +) 
 +``` 
 +Get the value of a field in a document 
 +- doc: a DocumentWrapper to get the value from 
 +- field: standardize field name or a list of standardize field name to get from the document 
 +- parse: True to try to parse the result, False to have a string 
 + 
 +## is_available 
 +``` 
 +is_available( 
 + doc: DocumentWrapper 
 + field: str 
 +) 
 +``` 
 +Determine if the field is available in a document 
 +- doc: a DocumentWrapper to get the value from 
 +- field: standardize field name to get from the document 
 + 
 +## list 
 +``` 
 +list( 
 + x: list[Any] 
 +) 
 +``` 
 +convert a list from lua to python 
 +- x: a LUA compatible list 
 + 
 +## parse_date 
 +``` 
 +parse_date( 
 +  
 +) 
 +``` 
 + 
 + 
 +## save_error 
 +``` 
 +save_error( 
 + codes: list[tuple[EnrollmentStatusCodeEnum | str] | ErrorCodeException | EnrollmentStatusCode] 
 +) 
 +``` 
 + 
 +- codes: save an instance of EnrollmentStatusCode or ErrorCodeException or (EnrollmentStatusCodeEnum, text) 
 + 
 +## throw 
 +``` 
 +throw( 
 + code: EnrollmentStatusCodeEnum 
 + msg: str = "" 
 +) 
 +``` 
 +Raise a python ErrorCodeException containing an EnrollmentStatusCode created with the code and message given 
 +- code: One of EnrollmentStatusCodeEnum possibility 
 +- msg: A text to join with the code 
 + 
 +## to_lua 
 +``` 
 +to_lua( 
 + x: Any 
 +) 
 +``` 
 +convert an object from python to LUA 
 +- x: a python compatible object 
 + 
 +# Enums 
 +## EnrollmentStatusCodeEnum 
 +- ACCOUNT_MISSING_EMAIL 
 +- MDL_RESPONSE_INVALID 
 +- MDL_CHALLENGE_NOT_MET 
 +- MDL_INPUT_INVALID 
 +- VLD_NAME_DOES_NOT_MATCH 
 +- VLD_FIRST_NAME_DOES_NOT_MATCH 
 +- VLD_ADDR_DOES_NOT_MATCH 
 +- VLD_ZIP_CODE_DOES_NOT_MATCH 
 +- VLD_CITY_DOES_NOT_MATCH 
 +- VLD_BIRTH_DATE_DOES_NOT_MATCH 
 +- VLD_BIRTH_PLACE_DOES_NOT_MATCH 
 +- VLD_BIRTH_COUNTRY_DOES_NOT_MATCH 
 +- VLD_NATIONALITY_DOES_NOT_MATCH 
 +- VLD_GENDER_DOES_NOT_MATCH 
 +- VLD_ID_INVALID 
 +- VLD_DUPLICATE_ID 
 +- VLD_POA_INVALID 
 +- VLD_DOCUMENT_INVALID 
 +- VLD_USER_DATA_INVALID 
 +- VLD_VALIDATION_KO 
 +- VLD_SYNTAX_ERROR 
 +- VLD_SCRIPT_ERROR 
 +- EIM_WRONG_CREDENTIAL 
 +- EIM_WRONG_REQUEST 
 +- EIM_SECURITY_FAILED 
 +- EIM_RESPONSE_KO 
 +- EIM_TIMEOUT 
 +- ERL_TIMEOUT 
 +- ERL_DELETE 
 +- SEC_DATA_INJECTION 
 +- SVC_RESPONSE_INVALID 
 +- UNKNOWN_ERROR 
 +- WARNING 
 + 
 +## MRZDocumentType 
 +- TD1 
 +- TD2 
 +- TD3 
 +- MRVA 
 +- MRVB 
 +- CIF 
 +- DL_FR_V1 
 +- CG_FR_V1 
 + 
 +# Lua modules allowed 
 +- _G 
 +- _VERSION 
 +- assert 
 +- bit 
 +- collectgarbage 
 +- coroutine 
 +- debug 
 +- error 
 +- math 
 +- module 
 +- next 
 +- os 
 +  - date 
 +  - difftime 
 +  - time 
 +- package 
 +- pairs 
 +- pcall 
 +- print 
 +- rawequal 
 +- string 
 +- table 
 +- tonumber 
 +- tostring 
 +- type 
 +- unpack 
 +- utf8 
 + 
 +# Définition des classes utilisés pour les données pivots 
 +## BANK_DETAILS 
 +``` 
 +BANK_DETAILS( 
 + services: dict[str | dict] | null,  
 + iban: str | null,  
 + full_name: str | null,  
 + bic: str | null,  
 + dmx_full_name: str | null,  
 + dmx_iban: str | null,  
 + dmx_bic: str | null 
 +) 
 +``` 
 +## CAR_REGISTRATION 
 +``` 
 +CAR_REGISTRATION( 
 + services: dict[str | dict] | null,  
 + mrz_document_format: str | null,  
 + mrz_issuing_country: str | null,  
 + mrz_type: str | null,  
 + mrz_valid: str | null,  
 + mrz_line1: str | null,  
 + mrz_line2: str | null,  
 + mrz_document_number: str | null,  
 + mrz_id_vehicle_number: str | null,  
 + mrz_registration_date: date | null,  
 + mrz_national_type: str | null,  
 + mrz_vehicle_body: str | null,  
 + mrz_brand: str | null,  
 + mrz_denomination: str | null,  
 + mrz_last_digit: str | null,  
 + mrz_formula_number: str | null,  
 + A: str | null,  
 + B: date | null,  
 + C1: str | null,  
 + C3: str | null,  
 + C41_n_owners: str | null,  
 + C41_co_owner: str | null,  
 + D1: str | null,  
 + D2: str | null,  
 + D21: str | null,  
 + D3: str | null,  
 + E: str | null,  
 + F1: str | null,  
 + F2: str | null,  
 + F3: str | null,  
 + G: str | null,  
 + G1: str | null,  
 + H: str | null,  
 + I: date | null,  
 + J: str | null,  
 + J1: str | null,  
 + J2: str | null,  
 + J3: str | null,  
 + K: str | null,  
 + P1: str | null,  
 + P2: str | null,  
 + P3: str | null,  
 + P6: str | null,  
 + Q: str | null,  
 + S1: str | null,  
 + S2: str | null,  
 + U1: str | null,  
 + U2: str | null,  
 + V7: str | null,  
 + V9: str | null,  
 + X1: date | null,  
 + Y1: str | null,  
 + Y2: str | null,  
 + Y3: str | null,  
 + Y4: str | null,  
 + Y5: str | null,  
 + Y6: str | null,  
 + Z1: str | null,  
 + Z2: str | null,  
 + Z3: str | null,  
 + Z4: str | null 
 +) 
 +``` 
 +## DIGITAL_IDENTITY 
 +``` 
 +DIGITAL_IDENTITY( 
 + services: dict[str | dict] | null,  
 + type: str | null,  
 + name: str | null,  
 + email: str | null,  
 + phone_number: str | null,  
 + birth_name: str | null,  
 + first_name: str | null,  
 + first_names: list[str] | null,  
 + address: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + country: str | null,  
 + birth_date: date | null,  
 + birth_date_mask: str | null,  
 + gender: str | null,  
 + birth_place: str | null,  
 + birth_country: str | null,  
 + nationality: str | null,  
 + dmx_first_names: list[str] | null,  
 + dmx_name: str | null,  
 + dmx_nationality: str | null,  
 + dmx_gender: str | null,  
 + dmx_type: str | null,  
 + dmx_birth_country: str | null,  
 + extra: IdentityExtractedDataExtra | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +### DIGITAL_IDENTITY_EXTRA 
 +``` 
 +DIGITAL_IDENTITY_EXTRA( 
 + id_number: str | null,  
 + issuing_date: datetime | null,  
 + expiration_date: datetime | null,  
 + issuing_country: str | null,  
 + issuer: str | null,  
 + address: str | null,  
 + dmx_id_number: str | null,  
 + dmx_signature_status: str | null,  
 + mrz_line_1: str | null,  
 + mrz_line_2: str | null,  
 + mrz_line_3: str | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +## HEALTH_INSURANCE_CARD 
 +``` 
 +HEALTH_INSURANCE_CARD( 
 + services: dict[str | dict] | null,  
 + full_name: str | null,  
 + amc: str | null,  
 + csr: str | null,  
 + adherent_number: str | null,  
 + convention: str | null,  
 + starting_date: date | null,  
 + ending_date: date | null 
 +) 
 +``` 
 +## IDENTITY 
 +``` 
 +IDENTITY( 
 + services: dict[str | dict] | null,  
 + type: str | null,  
 + name: str | null,  
 + email: str | null,  
 + phone_number: str | null,  
 + birth_name: str | null,  
 + first_name: str | null,  
 + first_names: list[str] | null,  
 + address: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + country: str | null,  
 + birth_date: date | null,  
 + birth_date_mask: str | null,  
 + gender: str | null,  
 + birth_place: str | null,  
 + birth_country: str | null,  
 + nationality: str | null,  
 + dmx_first_names: list[str] | null,  
 + dmx_name: str | null,  
 + dmx_nationality: str | null,  
 + dmx_gender: str | null,  
 + dmx_type: str | null,  
 + dmx_birth_country: str | null,  
 + extra: IdentityExtractedDataExtra | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +### IDENTITY_EXTRA 
 +``` 
 +IDENTITY_EXTRA( 
 + id_number: str | null,  
 + issuing_date: datetime | null,  
 + expiration_date: datetime | null,  
 + issuing_country: str | null,  
 + issuer: str | null,  
 + address: str | null,  
 + dmx_id_number: str | null,  
 + dmx_signature_status: str | null,  
 + mrz_line_1: str | null,  
 + mrz_line_2: str | null,  
 + mrz_line_3: str | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +## IDENTITY_DOCUMENT 
 +``` 
 +IDENTITY_DOCUMENT( 
 + services: dict[str | dict] | null,  
 + type: str | null,  
 + name: str | null,  
 + email: str | null,  
 + phone_number: str | null,  
 + birth_name: str | null,  
 + first_name: str | null,  
 + first_names: list[str] | null,  
 + address: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + country: str | null,  
 + birth_date: date | null,  
 + birth_date_mask: str | null,  
 + gender: str | null,  
 + birth_place: str | null,  
 + birth_country: str | null,  
 + nationality: str | null,  
 + dmx_first_names: list[str] | null,  
 + dmx_name: str | null,  
 + dmx_nationality: str | null,  
 + dmx_gender: str | null,  
 + dmx_type: str | null,  
 + dmx_birth_country: str | null,  
 + extra: IdentityExtractedDataExtra | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +### IDENTITY_DOCUMENT_EXTRA 
 +``` 
 +IDENTITY_DOCUMENT_EXTRA( 
 + id_number: str | null,  
 + issuing_date: datetime | null,  
 + expiration_date: datetime | null,  
 + issuing_country: str | null,  
 + issuer: str | null,  
 + address: str | null,  
 + dmx_id_number: str | null,  
 + dmx_signature_status: str | null,  
 + mrz_line_1: str | null,  
 + mrz_line_2: str | null,  
 + mrz_line_3: str | null,  
 + nfc_compatible: bool | null 
 +) 
 +``` 
 +## INCOME_TAX 
 +``` 
 +INCOME_TAX( 
 + services: dict[str | dict] | null,  
 + type: str | null,  
 + full_name_1: str | null,  
 + full_name_2: str | null,  
 + due_date: date | null,  
 + reference: str | null,  
 + year: str | null,  
 + tax_payer_id_number_1: str | null,  
 + tax_payer_id_number_2: str | null,  
 + taxable_income_reference: int | null,  
 + signature_status: str | null 
 +) 
 +``` 
 +## KBIS 
 +``` 
 +KBIS( 
 + services: dict[str | dict] | null,  
 + name: str | null,  
 + address: str | null,  
 + directions: list[dict],  
 + issuing_date: date | null,  
 + registration_date: date | null,  
 + siren: str | null,  
 + legal_form: str | null 
 +) 
 +``` 
 +## PAY_SLIP 
 +``` 
 +PAY_SLIP( 
 + services: dict[str | dict] | null,  
 + siret: str | null,  
 + ape: str | null,  
 + nir: str | null,  
 + hire_date: date | null,  
 + period: date | null,  
 + gross_income: float | null,  
 + net_income: float | null,  
 + net_taxable_income: float | null,  
 + full_name: str | null,  
 + address: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + company_address_1: str | null,  
 + company_address_2: str | null,  
 + company_address_3: str | null 
 +) 
 +``` 
 +## PROOF_OF_ADDRESS 
 +``` 
 +PROOF_OF_ADDRESS( 
 + services: dict[str | dict] | null,  
 + full_name: str | null,  
 + address_1: str | null,  
 + address_2: str | null,  
 + address_3: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + date: null,  
 + dmx_full_name: str | null,  
 + dmx_address_street: str | null,  
 + dmx_address_complement: str | null,  
 + dmx_zip_code: str | null,  
 + dmx_city: str | null,  
 + dmx_date: null 
 +) 
 +``` 
 +## PROOF_OF_AGE 
 +``` 
 +PROOF_OF_AGE( 
 + services: dict[str | dict] | null,  
 + is_of_age: bool | null,  
 + minimum_age: int | null 
 +) 
 +``` 
 +## PROPERTY_TAX 
 +``` 
 +PROPERTY_TAX( 
 + services: dict[str | dict] | null,  
 + name: str | null,  
 + first_name: str | null,  
 + address_1: str | null,  
 + address_2: str | null,  
 + address_3: str | null,  
 + zip_code: str | null,  
 + city: str | null,  
 + year: str | null 
 +) 
 +``` 
 +## SOCIAL_SECURITY 
 +``` 
 +SOCIAL_SECURITY( 
 + services: dict[str | dict] | null,  
 + full_name: str | null,  
 + social_security_number: str | null,  
 + delivery_date: date | null,  
 + expiration_date: date | null,  
 + birth_date: date | null,  
 + full_name_right_holder: str | null,  
 + social_security_number_right_holder: str | null,  
 + rgx_first_name: list[str],  
 + rgx_surname: list[str],  
 + rxg_birth_date: list[date],  
 + rgx_social_security_number: list[str] 
 +) 
 +``` 
 +# Définition des objets utilisés dans les scripts 
 +## DocumentWrapper 
 +- document 
 +- name 
 +- iteration 
 +- mode 
 +- engine 
 +- type 
 +- content 
 +- input_documents 
 +- is_internal 
 +- step_step_documents 
 +- ignore_validation 
 +- tags 
 +- is_valid 
 +- document_provider 
 +- enrollment_steps 
 + 
 + 
 +## EnrollmentStatusCode 
 +- id 
 +- code 
 +- message 
 +- step 
 +- external_method_step 
 +- enrollment 
 +- validation 
 +- document 
 + 
 +- pk: _empty 
 + 
 +## ErrorCodeException 
 + 
 +- status_code: EnrollmentStatusCode 
 + 
 +## IdentityDocument 
 +- definition 
 +- type 
 +- name 
 +- line_size 
 +- nb_line 
 + 
 + 
 +## IdentityExtractedDataExtra 
 +- id_number 
 +- issuing_date 
 +- expiration_date 
 +- issuing_country 
 +- issuer 
 +- address 
 +- dmx_id_number 
 +- dmx_signature_status 
 +- mrz_line_1 
 +- mrz_line_2 
 +- mrz_line_3 
 +- nfc_compatible 
 + 
 + 
 +## PersonalDetails 
 +- id 
 +- name 
 +- birth_name 
 +- first_name 
 +- first_names 
 +- email 
 +- address 
 +- zip_code 
 +- city 
 +- country 
 +- phone_number 
 +- birth_date 
 +- gender 
 +- birth_place 
 +- birth_country 
 +- nationality 
 +- identity_valid 
 +- enrollment 
 + 
 +- pk: _empty 
 + 
 +# Exemple 
 +```lua 
 +--- EN = Extract and verify the bank details 
 +--- FR = Extraire et vérifier le RIB 
 +--% iban_country | FR = Vérifier la validité du code pays de l'IBAN | EN = Check if IBAN country is valid 
 +--% iban = True | FR = Vérifier que l'IBAN est correctement formé | EN = Verify that the IBAN is correctly formed 
 + 
 +local uc= "ABCDEFGHIJKLMNOPQRSTUVWXYZ" 
 +local pc= "abcdefghijklmnopqrstuvwxyz" 
 +local corrs = {} 
 +for i = 1, #uc do 
 +    corrs[uc:sub(i,i)] = i + 9 
 +    corrs[pc:sub(i,i)] = i + 9 
 +end 
 +local function verify_iban(iban) 
 +    -- How to MOD97 
 +    -- https://www.iban.fr/calcul-chiffre-de-controle.html 
 +    iban = iban:gsub("% ","") 
 +    local iban_prep = iban:sub(5) .. iban:sub(0,2) .. "00" 
 +    local verif = iban:sub(3,4) 
 +    local mod97_str = {} 
 +    for i = 1, #iban_prep do 
 +        local c = iban_prep:sub(i,i) 
 +        if c ~= " " then 
 +            if corrs[c] ~= nil then 
 +                table.insert(mod97_str, corrs[c]) 
 +            else 
 +                table.insert(mod97_str, c) 
 +            end 
 +            if #(mod97_str) == 10 then 
 +                local num = tonumber(table.concat(mod97_str)) % 97 
 +                local num_str = string.format("%02d",num) 
 +                mod97_str = { } 
 +                for j = 1, #num_str do 
 +                    table.insert(mod97_str,num_str:sub(j,j)) 
 +                end 
 +            end 
 +        end 
 +    end 
 +    local num = tonumber(table.concat(mod97_str)) % 97 
 +    return verif + num - 98 == 0 
 +end 
 + 
 +local function verify_bank_details(bank_details) 
 +    if bank_details.ignore_validation then 
 +        return true 
 +    end 
 +    local full_name = get_value(bank_details, "FULL_NAME").first() 
 +    local iban = get_value(bank_details, "IBAN").first() 
 +    local bic = get_value(bank_details, "BIC").first() 
 +    local dmx_full_name = get_value(bank_details, "DMX_FULL_NAME").first() 
 +    local dmx_iban = get_value(bank_details, "DMX_IBAN").first() 
 +    local dmx_bic = get_value(bank_details, "DMX_BIC").first() 
 + 
 +    BANK_DETAILS( 
 +            bank_details, 
 +            iban, 
 +            full_name, 
 +            bic, 
 +            dmx_full_name, 
 +            dmx_iban, 
 +            dmx_bic 
 +    ) 
 +    local enrollment_valid = true 
 +    local iban_key = dmx_iban ~= nil and "DMX_IBAN" or "IBAN" 
 +    local iban = get_value(bank_details, iban_key).first() 
 +    enrollment_valid = check(bank_details, iban_key, verify_iban, "iban") and enrollment_valid 
 +    if iban ~= nil then 
 +        local country = services.country.country_exists(iban:sub(1, 2)) 
 +        enrollment_valid = custom_info({ { "country", country } }, country ~= nil, "iban_country") and enrollment_valid 
 +    else 
 +        enrollment_valid = false 
 +    end 
 +    output.valid[bank_details.name] = enrollment_valid 
 +    return enrollment_valid 
 +end 
 + 
 +local enrollment_valid = false 
 +for _, group_of_docs in pairs(to_lua(input.BANK_DETAILS)) do 
 +    local errors = {} 
 +    local group_bd_valid = false 
 +    local lua_group_of_docs = to_lua(group_of_docs) 
 +    for _, bank_details in pairs(lua_group_of_docs) do 
 +        local bd_valid = verify_bank_details(bank_details) 
 +        group_bd_valid = group_bd_valid or bd_valid 
 +    end 
 +    enrollment_valid = enrollment_valid or group_bd_valid 
 +end 
 +return enrollment_valid 
 +``` 
 + 
 +</markdown>

This website uses cookies. By using the website, you agree with storing cookies on your computer. Also, you acknowledge that you have read and understand our Privacy Policy. If you do not agree, please leave the website.

Plus d’informations