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/20 16:19] – ctisseranddocumentation_technique_scripts [2025/05/20 16:38] (Version actuelle) – ctisserand
Ligne 82: Ligne 82:
 services.email.verify(input.data.email[0], false, false) services.email.verify(input.data.email[0], false, false)
 ``` ```
-## country+## email
 ``` ```
-services.country.country_exists(country: Any)+services.email.verify(email: Any, check_mx: Any = True, check_server_respond: Any = False)
 ``` ```
-From the name of a country, find all the real country that match the name+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
Ligne 105: Ligne 107:
 - siren: the SIREN number of the company - siren: the SIREN number of the company
  
-## email+## country
 ``` ```
-services.email.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 fournies en entrée du script # Données fournies en entrée du script
Ligne 365: Ligne 365:
  
 # Enums # Enums
-## MRZDocumentType 
-- TD1 
-- TD2 
-- TD3 
-- MRVA 
-- MRVB 
-- CIF 
-- DL_FR_V1 
-- CG_FR_V1 
- 
 ## EnrollmentStatusCodeEnum ## EnrollmentStatusCodeEnum
 - ACCOUNT_MISSING_EMAIL - ACCOUNT_MISSING_EMAIL
Ligne 410: 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 
 +- _VERSION 
 +- assert 
 +- bit 
 +- collectgarbage
 - coroutine - coroutine
-- assert +- debug 
-- tostring +- error 
-- tonumber +- math
-- print+
 - module - module
-- bit+- next 
 +- os 
 +  - date 
 +  - difftime 
 +  - time
 - package - package
-- error +- pairs 
-- debug+- pcall 
 +- print
 - rawequal - rawequal
-- unpack +- string
-- pairs+
 - table - table
-- next +- tonumber 
-- math +- tostring
-- _G +
-- _VERSION +
-- string+
 - type - type
 +- unpack
 - utf8 - utf8
-- collectgarbage 
-- os 
-  - date 
-  - time 
-  - difftime 
  
-# Extracted Data Classes +# Définition des classes utilisés pour les données pivots
-## PROOF_OF_AGE +
-``` +
-PROOF_OF_AGE( +
- services: dict[str | dict] | null,  +
- is_of_age: bool | null,  +
- minimum_age: int | null +
-) +
-```+
 ## BANK_DETAILS ## BANK_DETAILS
 ``` ```
Ligne 536: Ligne 518:
 ) )
 ``` ```
-## HEALTH_INSURANCE_CARD+## DIGITAL_IDENTITY
 ``` ```
-HEALTH_INSURANCE_CARD( +DIGITAL_IDENTITY(
- 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_DOCUMENT +
-``` +
-IDENTITY_DOCUMENT(+
  services: dict[str | dict] | null,   services: dict[str | dict] | null, 
  type: str | null,   type: str | null, 
Ligne 580: Ligne 549:
 ) )
 ``` ```
-### IDENTITY_DOCUMENT_EXTRA+### DIGITAL_IDENTITY_EXTRA
 ``` ```
-IDENTITY_DOCUMENT_EXTRA(+DIGITAL_IDENTITY_EXTRA(
  id_number: str | null,   id_number: str | null, 
  issuing_date: datetime | null,   issuing_date: datetime | null, 
Ligne 597: Ligne 566:
 ) )
 ``` ```
-## DIGITAL_IDENTITY+## HEALTH_INSURANCE_CARD
 ``` ```
-DIGITAL_IDENTITY(+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,   services: dict[str | dict] | null, 
  type: str | null,   type: str | null, 
Ligne 628: Ligne 610:
 ) )
 ``` ```
-### DIGITAL_IDENTITY_EXTRA+### IDENTITY_EXTRA
 ``` ```
-DIGITAL_IDENTITY_EXTRA(+IDENTITY_EXTRA(
  id_number: str | null,   id_number: str | null, 
  issuing_date: datetime | null,   issuing_date: datetime | null, 
Ligne 645: Ligne 627:
 ) )
 ``` ```
-## IDENTITY+## IDENTITY_DOCUMENT
 ``` ```
-IDENTITY(+IDENTITY_DOCUMENT(
  services: dict[str | dict] | null,   services: dict[str | dict] | null, 
  type: str | null,   type: str | null, 
Ligne 676: Ligne 658:
 ) )
 ``` ```
-### IDENTITY_EXTRA+### IDENTITY_DOCUMENT_EXTRA
 ``` ```
-IDENTITY_EXTRA(+IDENTITY_DOCUMENT_EXTRA(
  id_number: str | null,   id_number: str | null, 
  issuing_date: datetime | null,   issuing_date: datetime | null, 
Ligne 760: Ligne 742:
  dmx_city: str | null,   dmx_city: str | null, 
  dmx_date: null  dmx_date: null
 +)
 +```
 +## PROOF_OF_AGE
 +```
 +PROOF_OF_AGE(
 + services: dict[str | dict] | null, 
 + is_of_age: bool | null, 
 + minimum_age: int | null
 ) )
 ``` ```
Ligne 793: Ligne 783:
 ) )
 ``` ```
-# Classes +# Définition des objets utilisés dans les scripts 
-## PersonalDetails+## 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
  
-## IdentityExtractedDataExtra +## IdentityDocument 
-- id_number: str | null +- definition 
-- issuing_date: datetime | null +- type 
-- expiration_date: datetime | null +- name 
-- issuing_country: str | null +- line_size 
-- issuer: str | null +- nb_line
-- 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+
  
  
-## EnrollmentStatusCode +## IdentityExtractedDataExtra 
-## IdentityDocument +- id_number 
-- definition: list[dict[str | IdentityDocumentPart]] +- issuing_date 
-- type: MRZDocumentType +- expiration_date 
-- name: str +- issuing_country 
-- line_size: int +- issuer 
-- nb_line: int+- address 
 +- dmx_id_number 
 +- dmx_signature_status 
 +- mrz_line_1 
 +- mrz_line_2 
 +- mrz_line_3 
 +- nfc_compatible
  
  
-## DocumentWrapper +## PersonalDetails 
-- document: Document +- id 
-- name: str +- name 
-- iteration: int | None +- birth_name 
-- mode: DocumentWrapperModeEnum +- first_name 
-- engine: EngineTypes +- first_names 
-- type: list[DocumentTypeEnum] +- email 
-- content: dict | null +- address 
-- input_documents: list[Document] +- zip_code 
-- is_internal: bool +- city 
-- step_step_documents: list[StepStepDocument] +- country 
-- ignore_validation: bool +- phone_number 
-- tags: list[object] +- birth_date 
-- is_valid: bool | null +- gender 
-- document_provider: str | null +- birth_place 
-- enrollment_steps: list[EnrollmentStep]+- birth_country 
 +- nationality 
 +- identity_valid 
 +- enrollment
  
 +- pk: _empty
  
 # Exemple # Exemple
Ligne 931: Ligne 953:
 return enrollment_valid return enrollment_valid
 ``` ```
 +
 </markdown> </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