Outils pour utilisateurs

Différences

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

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
documentation_technique_scripts [2025/05/19 16:28] – ctisseranddocumentation_technique_scripts [2025/05/20 16:38] (Version actuelle) – ctisserand
Ligne 1: Ligne 1:
-# Demonstration+====== Documentation pour écrire un script custom (LUA) ====== 
 + 
 +<markdown> 
 +# Squelette du script
 ``` ```
 -- script title -- script title
Ligne 19: Ligne 22:
 return true or false return true or false
 ``` ```
-# Titre+# Titre du script
 ``` ```
 --- country_alpha2 = title --- country_alpha2 = title
Ligne 35: Ligne 38:
 Si la langue cible n'est pas disponible, EN est utilisé, sinon le premier disponible est utilisé Si la langue cible n'est pas disponible, EN est utilisé, sinon le premier disponible est utilisé
  
-# Paramètre+# Paramètres
 ``` ```
 --% module | country_alpha2 = name | country_alpha2 = name --% module | country_alpha2 = name | country_alpha2 = name
Ligne 48: Ligne 51:
 Il ne sert pas a définir les tests (cf. Module), ils servent a définir le comportement du code Il ne sert pas a définir les tests (cf. Module), ils servent a définir le comportement du code
  
-# Module+# Modules (référence pour les script)
 ``` ```
  
Ligne 59: Ligne 62:
 Il définissent les tests qui seront enregistrés dans le rapport archivé Il définissent les tests qui seront enregistrés dans le rapport archivé
  
-Une référence peut être utilisé plusieur fois dans le script, le résultat final sera un OU logique entre tout les retour de la référence+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 composant nécéssaire + le nom 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 exemple
Ligne 70: Ligne 73:
  
 # Services # Services
-## country+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:  
 ``` ```
-country_exists(country: Any)+services.email.verify(input.data.email[0], false, false)
 ``` ```
-From the name of a country, find all the real country that match the name+## email 
 +``` 
 +services.email.verify(email: Any, check_mx: Any = True, check_server_respond: Any = False) 
 +``` 
 +Verify the regex and domain of an email
  
-- country: Name of the country to search+- 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 ## inpi
 ``` ```
-by_siret(siret: str)+services.inpi.by_siret(siret: str)
 ``` ```
 Get the information on a company from INPI Get the information on a company from INPI
Ligne 87: Ligne 101:
  
 ``` ```
-by_siren(siren: str)+services.inpi.by_siren(siren: str)
 ``` ```
 Get the information on a company from INPI Get the information on a company from INPI
Ligne 93: Ligne 107:
 - siren: the SIREN number of the company - siren: the SIREN number of the company
  
-## email+## country
 ``` ```
-verify(email: Any, check_mx: Any = True, check_server_respond: Any = False)+services.country.country_exists(country: Any)
 ``` ```
-Verify the regex and domain of an email+From the name of a country, find all the real country that match the name
  
-- email: the email address +- country: Name of the country to search
-- 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+
  
-# Données fournis en entré du script +# Données fournies en entrée du script 
-Les données fournit par le moteur sont dans le champ `input`+Les données fournies par le moteur sont dans le champ `input`
  
 - data: dict[field_name, list[str]] - data: dict[field_name, list[str]]
Ligne 113: Ligne 125:
 local name = input.data.name local name = input.data.name
 ``` ```
-# Données pouvant etre fournis en sortie du script +# Données pouvant être fournies en sortie du script 
-Les données fournit au moteur sont dans le champ `output`+Les données fournies au moteur sont dans le champ `output`
  
 - identity: PersonalDetails - identity: PersonalDetails
Ligne 125: Ligne 137:
 output.valid[doc.name] = true output.valid[doc.name] = true
 ``` ```
-# Functions +# Functions utilisables dans le script 
-## save_error+## check
 ``` ```
-save_error(codes: list[tuple[EnrollmentStatusCodeEnum | str] | ErrorCodeException | EnrollmentStatusCode])+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
  
-- codes: save an instance of EnrollmentStatusCode or ErrorCodeException or (EnrollmentStatusCodeEnum, text) +## check_concat
- +
-## list+
 ``` ```
-list(x: list[Any])+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 
 +)
 ``` ```
-convert a list from lua to python +Verify the validity of the concatenation of multiple field with the function given 
-- x: a LUA compatible list+- 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
  
-## throw+## compare
 ``` ```
-throw(code: EnrollmentStatusCodeEnum, msg: str = "")+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 
 +)
 ``` ```
-Raise a python ErrorCodeException containing an EnrollmentStatusCode created with the code and message given +Compare 2 fields from 2 different document 
-- code: One of EnrollmentStatusCodeEnum possibility +- doc1: a PersonalDetails or MRZDocument to get the value from 
-- msg: A text to join with the code+- 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
  
-## generator+## contains
 ``` ```
-generator(co: list[Any])+contains( 
 + _list: list[Any] 
 + item: Any 
 +)
 ``` ```
-Make a python coroutine usable. Available: #(...), .first(), .all() +Test if y is contains in x 
-- co: Python coroutine to use+- _list: Any list 
 +- item: the item to find
  
-## parse_date+## correct
 ``` ```
-parse_date()+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
-## 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)+create_date_mask( 
 + d: str 
 + date_format: Any = "%y%m%d" 
 +)
 ``` ```
-Verify the validity of a field with the function given +Create a valid mask for the date given (ex: 1990 -> YYYY, 901212 -> YYMMDD) 
-- doc: a DocumentWrapper, PersonalDetails or MRZDocument to get the value from +- d: the date as a string 
-- field: standardize field name or a list of standardize field name to get from the document +- date_format: the format of the date to parse
-- 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+
  
 ## custom_info ## custom_info
 ``` ```
-custom_info(infos: list[tuple[str | Any]], is_valid: Any, ref: Any, threshold: Any = None, score: Any = None)+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 Write a bloc to indicate the state of a custom verification
Ligne 185: Ligne 263:
 - score: if used, indicate the score obtain with this verification - score: if used, indicate the score obtain with this verification
  
-## correct+## error_type
 ``` ```
-correct(ref: str = "", doc: DocumentWrapper, field: str | list[str], fn: str (str), ref: str = "", hide: bool = False)+error_type( 
 + error: Exception 
 +)
 ``` ```
-Correct a field in a document following the function given. The result of the correction replace the old value +Get the name of a python exception 
-- ref: unique reference of the correction +- error: The exception to have the name from
-- 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+
  
-## contains+## fuzzy
 ``` ```
-contains(_list: list[Any], item: Any)+fuzzy( 
 + x: str 
 + y: str 
 + ignore_special_chars: bool = True 
 +)
 ``` ```
-Test if y is contains in x +Do a string compare with the algorithme fuzzy search 
-- _list: Any list +- x: The first string 
-- item: the item to find+- y: The second string 
 +- ignore_special_chars: True to transform inputs into an ASCII variant
  
-## is_available+## generator
 ``` ```
-is_available(doc: DocumentWrapper, field: str)+generator( 
 + co: list[Any] 
 +)
 ``` ```
-Determine if the field is available in a document +Make a python coroutine usable. Available: #(...), .first(), .all() 
-- doc: a DocumentWrapper to get the value from +- co: Python coroutine to use
-- field: standardize field name to get from the document+
  
-## check_concat+## get_value
 ``` ```
-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)+get_value( 
 + doc: DocumentWrapper 
 + field: str | list[str] 
 + parse: bool = False 
 +)
 ``` ```
-Verify the validity of the concatenation of multiple field with the function given+Get the value of a field in a document
 - doc: a DocumentWrapper to get the value from - doc: a DocumentWrapper to get the value from
 - field: standardize field name or a list of standardize field name to get from the document - 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 +- parse: True to try to parse the result, False to have a string
-- 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+
  
-## get_value+## is_available
 ``` ```
-get_value(doc: DocumentWrapper, field: str | list[str], parse: bool = False)+is_available( 
 + doc: DocumentWrapper 
 + field: str 
 +)
 ``` ```
-Get the value of a field in a document+Determine if the field is available in a document
 - doc: a DocumentWrapper to get the value from - doc: a DocumentWrapper to get the value from
-- field: standardize field name or a list of standardize field name to get from the document +- field: standardize field name to get from the document
-- parse: True to try to parse the result, False to have a string+
  
-## fuzzy+## list
 ``` ```
-fuzzy(x: str, y: str, ignore_special_chars: bool = True)+list( 
 + x: list[Any] 
 +)
 ``` ```
-Do a string compare with the algorithme fuzzy search +convert a list from lua to python 
-- x: The first string +- x: a LUA compatible list
-- y: The second string +
-- ignore_special_chars: True to transform inputs into an ASCII variant+
  
-## compare+## parse_date
 ``` ```
-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)+parse_date( 
 +  
 +)
 ``` ```
-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 
  
-## to_lua+ 
 +## save_error
 ``` ```
-to_lua(x: Any)+save_error( 
 + codes: list[tuple[EnrollmentStatusCodeEnum | str] | ErrorCodeException | EnrollmentStatusCode] 
 +)
 ``` ```
-convert an object from python to LUA 
-- x: a python compatible object 
  
-## error_type+- codes: save an instance of EnrollmentStatusCode or ErrorCodeException or (EnrollmentStatusCodeEnum, text) 
 + 
 +## throw
 ``` ```
-error_type(error: Exception)+throw( 
 + code: EnrollmentStatusCodeEnum 
 + msg: str = "" 
 +)
 ``` ```
-Get the name of a python exception +Raise a python ErrorCodeException containing an EnrollmentStatusCode created with the code and message given 
-- error: The exception to have the name from+- code: One of EnrollmentStatusCodeEnum possibility 
 +- msg: A text to join with the code
  
-## create_date_mask+## to_lua
 ``` ```
-create_date_mask(d: str, date_format: Any = "%y%m%d")+to_lua( 
 + x: Any 
 +)
 ``` ```
-Create a valid mask for the date given (ex: 1990 -> YYYY, 901212 -> YYMMDD) +convert an object from python to LUA 
-- d: the date as a string +- x: a python compatible object
-- date_format: the format of the date to parse+
  
 # Enums # Enums
-## MRZDocumentType 
-- TD1 
-- TD2 
-- TD3 
-- MRVA 
-- MRVB 
-- CIF 
-- DL_FR_V1 
-- CG_FR_V1 
- 
 ## EnrollmentStatusCodeEnum ## EnrollmentStatusCodeEnum
 - ACCOUNT_MISSING_EMAIL - ACCOUNT_MISSING_EMAIL
Ligne 327: Ligne 400:
 - WARNING - WARNING
  
-# Other +## MRZDocumentType 
-``` +- TD1 
-services: object +- TD2 
-``` +- TD3 
-``` +- MRVA 
-output: object +- MRVB 
-``` +- CIF 
-``` +- DL_FR_V1 
-MRZ_TYPES: dict[MRZDocumentType | IdentityDocument] +- CG_FR_V1 
-```+
 # Lua modules allowed # Lua modules allowed
-- pcall +- _G 
-- coroutine+- _VERSION
 - assert - assert
-- tostring 
-- tonumber 
-- print 
-- module 
 - bit - bit
-- package +- collectgarbage 
-- error+- coroutine
 - debug - debug
-- rawequal +- error
-- unpack +
-- pairs +
-- table +
-- next+
 - math - math
-- _G +- module 
-- _VERSION +- next
-- string +
-- type +
-- utf8 +
-- collectgarbage+
 - os - os
   - date   - date
-  - time 
   - difftime   - difftime
 +  - time
 +- package
 +- pairs
 +- pcall
 +- print
 +- rawequal
 +- string
 +- table
 +- tonumber
 +- tostring
 +- type
 +- unpack
 +- utf8
  
-# Extracted Data Classes +# Définition des classes utilisés pour les données pivots
-## PROOF_OF_AGE +
-``` +
-AgeProofExtractedData(services: dict[str | dict] | null, is_of_age: bool | null, minimum_age: int | null) +
-```+
 ## BANK_DETAILS ## BANK_DETAILS
 ``` ```
-BankDetailsExtractedData(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)+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
 ``` ```
-CarRegistrationExtractedData(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)+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 
 +)
 ``` ```
-## HEALTH_INSURANCE_CARD+## DIGITAL_IDENTITY
 ``` ```
-HealthInsuranceExtractedData(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)+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 
 +)
 ``` ```
-## IDENTITY_DOCUMENT+### DIGITAL_IDENTITY_EXTRA
 ``` ```
-IdentityExtractedData(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( 
 + 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_EXTRA+## HEALTH_INSURANCE_CARD
 ``` ```
-IdentityExtractedData(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( 
 + 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 
 +)
 ``` ```
-## DIGITAL_IDENTITY+## IDENTITY
 ``` ```
-IdentityExtractedData(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( 
 + 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+### IDENTITY_EXTRA
 ``` ```
-IdentityExtractedData(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_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+## IDENTITY_DOCUMENT
 ``` ```
-IdentityExtractedData(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( 
 + 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_DOCUMENT_EXTRA
 ``` ```
-IdentityExtractedData(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_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
 ``` ```
-IncomeTaxExtractedData(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)+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
 ``` ```
-KbisExtractedData(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)+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
 ``` ```
-PaySlipExtractedData(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)+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
 ``` ```
-ProofOfAddressExtractedData(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_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
 ``` ```
-PropertyTaxExtractedData(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)+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
 ``` ```
-SocialSecurityExtractedData(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])+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] 
 +)
 ``` ```
-# Classes+# 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 ## ErrorCodeException
  
 - status_code: EnrollmentStatusCode - status_code: EnrollmentStatusCode
  
-## PersonalDetails 
 ## IdentityDocument ## IdentityDocument
-- definition: list[dict[str | IdentityDocumentPart]] +- definition 
-- type: MRZDocumentType +- type 
-- name: str +- name 
-- line_size: int +- line_size 
-- nb_line: int+- nb_line
  
  
-## DocumentWrapper +## IdentityExtractedDataExtra 
-- document: Document +- id_number 
-- name: str +- issuing_date 
-- iteration: int | None +- expiration_date 
-- mode: DocumentWrapperModeEnum +- issuing_country 
-- engine: EngineTypes +- issuer 
-- type: list[DocumentTypeEnum] +- address 
-- content: dict | null +- dmx_id_number 
-- input_documents: list[Document] +- dmx_signature_status 
-- is_internal: bool +- mrz_line_1 
-- step_step_documents: list[StepStepDocument] +- mrz_line_2 
-- ignore_validation: bool +- mrz_line_3 
-- tags: list[object] +- nfc_compatible
-- is_valid: bool | null +
-- document_provider: str | null +
-- enrollment_steps: list[EnrollmentStep]+
  
  
-## EnrollmentStatusCode +## PersonalDetails 
-## IdentityExtractedDataExtra +- id 
-- id_number: str | null +- name 
-- issuing_date: datetime | null +- birth_name 
-- expiration_date: datetime | null +- first_name 
-- issuing_country: str | null +- first_names 
-- issuer: str | null +- email 
-- address: str | null +- address 
-- dmx_id_number: str | null +- zip_code 
-- dmx_signature_status: str | null +- city 
-- mrz_line_1: str | null +- country 
-- mrz_line_2: str | null +- phone_number 
-- mrz_line_3: str | null +- birth_date 
-- nfc_compatible: bool | null+- gender 
 +- birth_place 
 +- birth_country 
 +- nationality 
 +- identity_valid 
 +- enrollment
  
 +- pk: _empty
  
 # Exemple # Exemple
Ligne 570: Ligne 954:
 ``` ```
  
 +</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