Concepts
Cette page explique le modèle de l’API : pour qui votre logiciel agit, ce qui change avec la profession du professionnel, comment un client devient analysé, la différence entre les deux niveaux qu’il lit, et pourquoi certaines décisions ne passent jamais par l’API. Les champs et les opérations sont dans la référence de l’API.
Un membre, une organisation
Section intitulée « Un membre, une organisation »Une organisation est la structure d’un professionnel assujetti, comme un cabinet d’avocats, une étude notariale, un cabinet d’expertise comptable ou une agence immobilière (GET /v1/organization) : tout ce que vous lisez ou écrivez lui appartient. Votre application n’agit jamais pour la structure tout entière, mais pour l’un de ses membres, les personnes de la structure qui utilisent LexOpti : celui qui a choisi l’organisation en autorisant votre application. Chaque jeton est lié à ce membre et à cette organisation et porte exactement les droits du membre : un membre en lecture seule ne fait que lire, quelles que soient les portées, et un membre qui quitte la structure met fin à votre accès avec lui (authentification).
C’est ce qui permet au journal d’audit de la structure de dire qui a fait quoi, et par quelle application. Une intégration utilisée par plusieurs structures tient une connexion par membre et par organisation.
Toutes les professions, une seule API
Section intitulée « Toutes les professions, une seule API »LexOpti sert plusieurs professions assujetties : avocats, notaires, experts-comptables, agents immobiliers et autres professionnels assujettis. L’API est la même pour toutes, avec les mêmes ressources, les mêmes champs et les mêmes codes. Ce qui dépend de la profession de l’organisation :
- Les mots des écrans de LexOpti. La structure y est un « Cabinet » pour les avocats et les experts-comptables, une « Agence » pour les agents immobiliers, une « Étude » pour les notaires et une « Structure » sinon ; un dossier y est une « affaire » pour les avocats et un « dossier » pour les autres professions. L’API dit toujours
organizationetcase, et ce portail organisation (ou structure), membre et dossier : dans vos propres écrans, employez les mots de vos utilisateurs. - Les natures des dossiers et les rôles des parties qu’un membre peut choisir (rôles des parties, natures des dossiers).
- Le questionnaire de risque, dont
policynomme la version (lire la classification d’un client).
Clients et analyses
Section intitulée « Clients et analyses »Un client est une relation d’affaires avec une personne ou une société. Créer un client ne fait qu’enregistrer une identité : rien n’est analysé et rien n’est consommé.
L’analyse (check) est une étape distincte, pour deux raisons. Elle est facturée, au dossier : une analyse est facturée au dossier du client (case_id, ou son seul dossier ouvert, ou à défaut son dossier de relation d’affaires, ouvert pour elle), comme LexOpti la facture. Un crédit ouvre un dossier de cinq personnes ou sociétés au plus pendant douze mois, chaque tranche de cinq de plus coûte un crédit, et relancer dans l’année et les places du dossier est gratuit. Et elle demande une identité assez complète pour analyser sans confondre deux personnes : une analyse d’une personne sans date de naissance ni nationalité répond incomplete_identity.
Une analyse contrôle le client et ses parties liées sur toutes les sources : sanctions, personnes politiquement exposées, gels d’avoirs, registres, BODACC et presse. Les sources répondent à des vitesses différentes, donc une analyse est asynchrone : running jusqu’à la réponse de chaque source, puis completed, ou failed quand une source n’a pas pu être interrogée. Votre logiciel en apprend la fin par un événement plutôt qu’en attendant.
La consommation (GET /v1/usage) montre les crédits et les dossiers de l’organisation. Une analyse que ses crédits ne peuvent pas payer est refusée (quota_exceeded) ; sans offre en cours, les crédits sont gelés et les analyses refusées (subscription_inactive), tout restant lisible.
Deux niveaux : vigilance et risque
Section intitulée « Deux niveaux : vigilance et risque »Le niveau de vigilance (vigilance_level : simplified, standard ou enhanced) est déduit par LexOpti des résultats d’analyse. Le niveau de risque (risk_level) est un jugement : le niveau qu’un membre a validé dans LexOpti après la classification du client.
La loi met ce jugement à la charge du professionnel, qui reste responsable de ses obligations de vigilance (sécurité et conformité). L’API lit donc un niveau de risque mais n’en fixe jamais, et une décision d’acceptation ne passe jamais par elle. Quand vous affichez les deux niveaux, ne présentez jamais le niveau de vigilance comme la décision du professionnel.
Alertes et dossiers
Section intitulée « Alertes et dossiers »Quand une source change au sujet d’un client ou d’une partie en vigilance continue, LexOpti lève une alerte. Elle reste pending jusqu’à son examen par un membre : reviewed, dismissed ou confirmed. Votre logiciel peut enregistrer cet examen pour le membre, avec ses droits.
Un dossier (case) est une opération ou une mission (une vente, une cession de titres, un contentieux, une mission comptable…) d’un ou plusieurs clients. Par l’API, vous créez un dossier pour des clients existants, avec ses natures et ses parties, comme l’écran « Nouveau dossier » de LexOpti et facturé comme il le facture (POST /v1/cases, dont POST /v1/cases/preview donne d’abord le prix : créer un dossier depuis votre fiche), et vous liez les dossiers et leurs parties à vos propres identifiants (PUT /v1/cases/{id}/external-ref, PUT /v1/cases/{id}/parties/{party_id}/external-ref). Le membre les traite dans LexOpti, ou dans votre page par les composants embarqués (<lexopti-new-case>, <lexopti-case>, <lexopti-app>), qui sont les écrans mêmes de LexOpti : il y crée un dossier, modifie son titre, ses clients, ses parties, ses sujets complémentaires et ses responsables (l’action edit), lance ses analyses (launch-check), répond à sa classification et la valide (tracfin2), examine ses résultats d’analyse, génère son rapport et la commente (comments), dans la mesure où la session garde ces parties et où les droits du membre le permettent. Un dossier n’est ni clôturé, ni rouvert, ni supprimé depuis votre page. Un dossier a son propre niveau de risque (risk_level), celui qu’un membre a validé avec sa classification, à côté du niveau de vigilance de ses analyses.
Rôles des parties
Section intitulée « Rôles des parties »En plus de ses clients, un dossier liste ses autres parties (l’autre partie, un financeur…), chacune avec un role : un code stable en français, le mot de la profession. Chaque profession propose ses propres rôles quand un membre ajoute une partie ; un rôle qu’elle ne propose plus reste affiché sur une partie plus ancienne, et de nouveaux rôles peuvent s’ajouter : affichez un rôle inconnu comme autre.
role |
Signification | Proposé aux |
|---|---|---|
vendeur, acquereur |
Vendeur, acquéreur | avocats, notaires, immobilier, autres professions |
cedant, cessionnaire |
Cédant, cessionnaire | avocats, notaires, experts-comptables, immobilier |
bailleur, locataire |
Bailleur, locataire | avocats, immobilier |
preteur |
Prêteur | avocats, notaires, experts-comptables |
emprunteur, caution |
Emprunteur, caution | avocats, notaires |
tiers_payeur |
Tiers payeur ou financeur | toutes les professions |
contrepartie |
Contrepartie | experts-comptables, autres professions |
donateur, donataire, heritier_legataire |
Donateur, donataire, héritier ou légataire | notaires |
intervenant |
Intervenant | notaires |
partie_adverse |
Partie adverse | avocats |
mandataire, representant_legal |
Mandataire, représentant légal | toutes les professions |
intermediaire |
Intermédiaire ou apporteur d’affaires | immobilier, autres professions |
associe |
Associé | avocats, notaires, experts-comptables |
constituant, fiduciaire, beneficiaire |
Constituant, fiduciaire, bénéficiaire | avocats |
autre |
Autre | toutes les professions |
demandeur, defendeur, appelant, intime, mandant, tiers |
Demandeur, défendeur, appelant, intimé, mandant, tiers | plus proposés, affichés sur les parties plus anciennes |
Natures des dossiers
Section intitulée « Natures des dossiers »Un dossier a une ou plusieurs natures (types dans POST /v1/cases, type et types dans le dossier), des codes stables en français : celles que la profession de l’organisation propose dans l’écran « Nouveau dossier » de LexOpti, ou custom avec son intitulé libre (type_label, de 2 à 160 caractères), que toutes les professions proposent. Une nature que la profession ne propose pas répond validation_failed. GET /v1/organization dit pour quelle organisation agit un jeton ; sa profession est celle que la structure a choisie dans LexOpti.
| Profession | Natures proposées (outre custom) |
|---|---|
| Avocats | immobilier : vente_immobiliere, gestion_locative, copropriete, vente_judiciaire, fonds_commerce, droit_bail ; sociétés : creation_societe, fusion_societe, cession_titres, gouvernance, societe_preponderance_immo, fonds_dotation ; fiscal et financier : fiscalite, procedures_admin_fiscales_douanieres, mandat_representation_fiscale, prets_conventions_financieres, gestion_portefeuille, gestion_actifs, ouverture_comptes ; pénal : procedure_penale, caution_penale ; civil et commercial : responsabilite, recouvrement_creances, procedures_civiles, procedures_commerciales, contrats_commerciaux, ventes_mobilieres_corporelles ; famille et successions : successions, famille, protection_patrimoniale ; travail : contrat_travail, contentieux_travail ; sport : contrats_sportifs ; propriété intellectuelle : propriete_intellectuelle ; assurances : assurance_intermediation |
| Immobilier | ventes : vente_immobiliere, vente_terrain, vente_neuf_vefa, vente_prestige, vente_viager, vente_demembrement, vente_judiciaire, echange_immeubles, mandat_recherche_achat ; immobilier d’entreprise : immobilier_entreprise_vente, location_professionnelle ; location : location_habitation, location_prestige, location_saisonniere, mandat_recherche_location ; fonds de commerce : fonds_commerce, location_gerance, droit_bail ; parts de sociétés : cession_parts_societe ; temps partagé : temps_partage ; gestion : gestion_locative, copropriete ; pour compte propre : marchand_biens_achat_revente, promotion_immobiliere |
| Experts-comptables | comptable : tenue_comptable, presentation_comptes, examen_limite, audit_contractuel, procedures_convenues, compilation_comptes, attestation_particuliere, examen_previsionnel, mission_legale_cse ; fiscal : declarations_fiscales, declaration_ir_ifi, assistance_controle_fiscal, credit_impot_remboursement, conseil_fiscal ; social : paie_social, conseil_social ; juridique : creation_societe_apports, operations_capital, cession_parts_actions, secretariat_juridique, montage_restructuration, dissolution_liquidation, consultation_juridique ; financement : pilotage_gestion, business_plan_financement, audit_acquisition_evaluation, levee_fonds, subventions_aides_publiques ; flux : mandat_paiement, recouvrement_creances, gestion_administrative ; particuliers : transmission_patrimoine |
| Notaires, autres professions | custom seulement |
Certaines natures sont hors du périmètre de la lutte contre le blanchiment, ou à sa limite (gestion locative, locations sous le seuil légal) : LexOpti les propose comme son écran et le dit au membre.
Des références, pas des copies
Section intitulée « Des références, pas des copies »LexOpti est le dossier que le professionnel doit conserver (CMF L561-12). Votre logiciel y garde des références : le lien entre votre fiche et la nôtre, et au plus les niveaux que vous affichez. Les webhooks ne portent que des identifiants, et vous lisez le détail par l’API quand vous en avez besoin : ce que vous affichez reste à jour et dans ce que le membre a le droit de voir.
Vos propres identifiants
Section intitulée « Vos propres identifiants »Donnez à un client ou à un dossier votre propre identifiant, son external_ref (par exemple crm:contact:1042), et vous n’avez plus à conserver le nôtre : passez-le à POST /v1/clients, ou définissez-le ensuite avec PUT /v1/clients/{id}/external-ref (PUT /v1/cases/{id}/external-ref pour un dossier), puis retrouvez l’enregistrement avec GET /v1/clients?external_ref=crm:contact:1042 (ou GET /v1/cases?external_ref=…).
- C’est une chaîne opaque de 1 à 255 caractères parmi
A-Z a-z 0-9 : . _ -, unique par application, organisation et type : deux structures peuvent utiliser les mêmes identifiants, un client et un dossier aussi. Gardez-en un identifiant technique opaque, jamais une donnée personnelle : ni nom, ni date de naissance, ni e-mail. - Un enregistrement a au plus une référence de votre application : en définir une autre la remplace, et
DELETEsur le même chemin la retire. Une référence qui désigne déjà un autre enregistrement répond 409external_ref_conflict; à la création, le client n’est alors pas créé. - Elle appartient à votre application : une autre application connectée à la même organisation ne la voit jamais (
external_refvautnullpour elle) et ne peut pas retrouver un enregistrement par elle. - Les événements et les webhooks désignent les enregistrements par
client_idetcase_id, et ajoutentclient_external_refetcase_external_refquand vous les avez définis. - Un enregistrement supprimé emporte sa référence, et réinitialiser le bac à sable efface toutes les références.
- Une partie d’un dossier qui n’est pas cliente (l’autre partie, un prêteur, un vendeur…) prend aussi votre identifiant :
PUT /v1/cases/{id}/parties/{party_id}/external-ref. La référence désigne la personne ou la société, pas sa place dans un dossier : elle figure sur cette partie dans tous les dossiers dont elle est (parties[].external_ref), etGET /v1/cases?party_external_ref=crm:contact:77liste ces dossiers. Une référence désigne une seule partie par application et organisation.