Skip to content

Changelog

First version of /v1: organization, usage, clients, checks, cases, alerts, events, webhook endpoints, embed sessions and deep links.

  • Launch a case’s analyses: POST /v1/cases/{id}/checks launches every analysis of a case in one call, as LexOpti’s « Lancer les analyses » button does on the case page: every client of the case with its related parties, and the case’s parties, charged to the dossier as the app charges it. Each client’s launch is a check of your application, listed in the answer’s checks; the parties’ runs are the case’s own status. Idempotency-Key required; incomplete_identity, quota_exceeded, subscription_inactive and case_closed refuse it before anything is launched. The quickstart now launches its case this way. The SDK adds cases.launchChecks.

  • Prefill the sign-in and the sign-up: the lexopti_hint parameter of the authorization request (the SDK encodes it, encodePartnerHint) carries the member’s address, name and organization; the sign-in starts with their address, the sign-up with the rest, every field still theirs to check; the SIREN is prefilled but never locked (connect a member).

  • Enrol your members: POST /v1/members/enrolments (an owner or admin of the organization, an application installed for the organization) creates the account of a person of the organization and decides their membership; in nominative mode they only type their code from your button; in delegated mode, enabled by LexOpti at the organization’s request, they do nothing: your software names the acting member with the X-LexOpti-Acting-User header, embedded screens included, and every trail says the identity is asserted by your application. GET and DELETE /v1/members/enrolments, events member.enrolled and member.joined (enrol your members).

  • Preliminary screening: each client your application creates through the API gets a free screening against the official freeze and sanctions lists LexOpti ingests itself (the French national freeze register, the EU financial sanctions list, the US OFAC SDN list), renewed for free at each new publication of these lists while the organization has an offer and the client is not under ongoing vigilance (never in a sandbox). Client resources add preliminary_screening (status, pending, outcome, match_count, screened_at, checked_at, last_error, or null), GET /v1/clients/{id}/preliminary-screening returns the current result and the latest request (the lists searched with their publication dates and attribution, the matches with their official references and links), and the new event client.preliminary_screening_completed tells a settled or changed result. Your application decides the other screenings: POST /v1/clients/{id}/preliminary-screening (lexopti:write, an Idempotency-Key, 202) asks for the screening of any client your token reaches, a client created in LexOpti and linked to your reference included (409 preliminary_screening_pending while one runs, 503 preliminary_screening_unavailable without the feature); linking a client or editing one your application did not create asks for nothing, and a client it created through the API is screened again when it changes a screened identity field. The result reaches your application alone: the members of the organization see nothing of it in LexOpti. The SDK adds clients.getPreliminaryScreening and clients.requestPreliminaryScreening. In a sandbox, SANCTION gives a possible match and ERREUR a failure, at once (preliminary screening).

  • Identity fields, documented and checked: every request field of the API reference now says what it is, its format and an example, and every request shows a ready-to-copy body, also in its curl and PHP samples (whose curl Authorization header now reads the $LEXOPTI_TOKEN variable). A new page lists the identity fields and what a check needs (identity fields). Countries (birth_country, nationalities, registration_country, address.country) must be ISO 3166-1 alpha-2 codes, upper-cased by LexOpti, as the MCP server and the embedded components already required: a name such as France now answers validation_failed, where it was stored and never matched in screening. nationalities holds 10 codes at most, and identity text fields 255 characters.

  • Glossary and plain-language reference: a glossary explains the business terms (vigilance and risk levels, risk assessment and its axes, PEP, beneficial owner, case or « dossier », credits, preliminary screening, enrolment and delegated mode…). The reference rewrites the descriptions that assumed them, links to the glossary, explains every value of case.status and alert.change, and calls a case a case everywhere, « dossier » remaining only in dossier_required and GET /v1/usage’s dossiers. Documentation only: no field or behaviour changes.

  • Every profession in the documentation: the portal and the reference describe LexOpti for all the professions it serves, lawyers, notaries, accountants, estate agents and other regulated professionals: they speak of organizations and members, explain what depends on the profession (the words of LexOpti’s screens, the case natures, the party roles, the questionnaire: every profession, one API), and their examples vary the professions. Documentation only: firm, /v1/firms and every other identifier stay as they are.

  • Create the organization of a new customer: with your application’s own token (client credentials, scope lexopti:firms, only for an application approved for production), POST /v1/firms prepares an organization (a firm) for its manager to claim: LexOpti e-mails them a single-use claim link (7 days), which opens its normal sign-up with the organization filled in, every usual check run on what the manager confirms; nothing exists in LexOpti before. GET /v1/firms/{id} follows it (pending, claimed, expired after 30 days, voided when the SIREN joined LexOpti another way), POST /v1/firms/{id}/claim-link renews its link. A SIREN already a client answers firm_exists. Adding lexopti_claim to your authorization brings the manager back connected. The organization is attributed to your application once its offer runs (create the organization of a new customer).

  • Create a case: POST /v1/cases creates a case for existing clients (by id or by your external_ref), with its natures among the profession’s (case natures), its parties (people or companies, their role and your reference) and your reference of the case, as LexOpti’s « Nouveau dossier » screen does and charged as it charges it; launch_checks launches its analyses with it when that costs nothing more. POST /v1/cases/preview tells the cost first, writing nothing. Idempotency-Key required; quota_exceeded, subscription_inactive, external_ref_conflict and validation_failed refuse it before anything is written. The case adds types (every nature; type is the first). The MCP server adds lexopti_preview_case and lexopti_create_case: the member confirms the cost in LexOpti’s form, or, without a form, creates the proposed case in LexOpti (create a case from your record).

  • Sandbox credits, never drawn: a sandbox’s cases, checks and parties are priced and charged as a real organization’s, but its 1,000 free credits are never drawn and its movements stay empty. The quota_exhausted trigger now leaves the sandbox without credits (what costs answers quota_exceeded) until the new quota_restored trigger or a reset (test triggers).

  • Partner programme: an organization created after coming through your application (the OAuth journey of a member without an account, or your referral link /login?tab=sign-up&partner=<public id>) is attributed to it, first partner only, new organizations only, never a sandbox. The developer console adds a Partner statement tab: the organizations you brought, their attribution date and the aggregated amounts of their paid invoices, excluding tax, with the commission of your agreement (partner programme).

  • A member without an account: LexOpti’s sign-in page offers to create an account, and the authorization your software started resumes once the sign-up is done (45 minutes, same browser), back to your callback with the code and your state. Nothing changes in your request (a member without an account).

  • Billing by dossier: a check is charged to the client’s dossier as LexOpti charges it (one credit opens a dossier of up to five people or companies for twelve months): POST /v1/checks takes an optional case_id, a client with no open case gets its business relationship dossier, and several open cases answer dossier_required with their list. A refusal is quota_exceeded (the credits cannot pay it) or subscription_inactive (no offer runs). GET /v1/usage now shows credits and dossiers (credits, dossiers, subscription_active), and quota.exhausted is sent when the last credit is spent, with no period. A sandbox holds 1,000 free credits, given back by a reset. The MCP preview shows the dossier and its credits (insufficient_credits replaces over_quota).

  • Sandbox test triggers: POST /v1/sandbox/triggers makes a vigilance alert, a vigilance level change, the last credit spent or a revoked access happen in a sandbox, through the same writes as in a real organization, so your endpoints receive production’s very webhooks. Anywhere else it answers 403 sandbox_required. The SDK adds sandboxTriggers.create (test triggers).

  • Sandbox example data: a new sandbox, and every sandbox after a reset, holds example clients and cases for each magic input, already screened, with their parties and alerts (example data).

  • Logs and webhooks in the developer console: each application’s /v1 requests of the last 30 days (filters, search by Request-Id) and its webhook deliveries in every organization, with each attempt, the body sent and Replay (logs and webhooks).

  • Update a client: PATCH /v1/clients/{id} changes a person’s or company’s identity with the app’s own rules (an analysed client keeps its required fields, incomplete_identity; a screened field changed under ongoing vigilance relaunches its analysis, charged to its dossiers, quota_exceeded otherwise). It completes an identity a check refused. lexopti:write, idempotent by its meaning (the same body changes nothing). The type, levels, vigilance and reference are not changed there. <lexopti-client>’s prefill now proposes changes to the client it shows, reviewed and saved by the member (embedding).

  • Report and documents: GET /v1/cases/{id}/report serves the case’s report as a PDF through a signed URL valid 5 minutes, with its version (also ETag) and the file’s sha256: the partners’ version, which never includes the suspicion axis and computes its scores without it. GET /v1/cases/{id}/documents lists the case file’s documents, each with a signed URL. lexopti:read.

  • Webhooks catalog: new events client.created, client.updated, client.vigilance_level_changed, case.updated, report.generated, decision.pending, quota.exhausted, subscription.inactive and access.revoked, the last delivery to your endpoints when your application loses its access to an organization, which then disables them (disabled_reason: access_revoked) instead of stopping silently (events). The OpenAPI document declares the event types and disabled_reason as x-extensible-enum: new values may come, ignore those you do not handle.

  • SDK, newer event types: webhooks.verify accepts a delivery of an event type it does not know yet (access.revoked on an older build, any type LexOpti adds later) and returns its type as sent: a genuine delivery never fails verification. WebhookEventType types it (the known types, webhook.test, or any string): handle the types you know and ignore the others.

  • Party references: a case’s parties carry entity_id and external_ref, your id of that person or company, set with PUT /v1/cases/{id}/parties/{party_id}/external-ref and found with GET /v1/cases?party_external_ref=… (your own ids).

  • Mobile and native apps: an application can be registered as a native app (RFC 8252), a public client without a secret, PKCE required, redirected to http://127.0.0.1 or http://[::1] on any port, a reverse-domain private-use scheme or a claimed HTTPS URI, never localhost. A new guide covers it, and the embedded components in a webview (mobile and native apps).

  • PHP examples: runnable PHP for the OAuth flow with refresh token rotation, a /v1 call with pagination and Idempotency-Key, and webhook verification, run against the API in LexOpti’s tests (PHP examples).

  • Request ids: every answer of /v1 carries a Request-Id header, generated by LexOpti, and every problem the same id as request_id. Quote it to LexOpti support (request ids).

  • Cases, enriched: GET /v1/cases and GET /v1/cases/{id} add clients (every client with your reference, main for the main one), parties (the other parties, with their role, codes by profession), risk_level (validated by a member), classification_state and pending_alert_count. The client_id filter of GET /v1/cases now also finds the cases where the client is not the main one. Two new events: case.created and case.risk_level_changed (read a client’s cases). The MCP tool lexopti_get_case_summary returns the same fields.

  • Classification, read only: GET /v1/clients/{id}/classification and GET /v1/cases/{id}/classification return the TRACFIN classification as saved: state, score, level, validated_at, validated_by, the answers by question id and missing_answers. A new event, classification.validated, is sent at each validation by a member (read a client’s classification). The MCP server adds lexopti_get_classification.

  • Partner references: clients and cases carry external_ref, your application’s own id for them (null without one, and never another application’s). Set it with POST /v1/clients or PUT /v1/clients/{id}/external-ref and PUT /v1/cases/{id}/external-ref, remove it with DELETE on the same paths, and find a record with the external_ref filter of GET /v1/clients and GET /v1/cases. A reference already in use answers 409 external_ref_conflict. Event and webhook data add client_external_ref and case_external_ref (your own ids).

  • Embedded lists and LexOpti itself: POST /v1/embed-sessions now opens the clients, cases and app components, for <lexopti-clients>, <lexopti-cases> and <lexopti-app> (dashboard, lists, client and case pages and the new-client form, in LexOpti’s reduced navigation, path for the screen it opens on). A list keeps the features keys of the page its rows open, app both pages’ tabs; edit also holds their creation entries (the lists and LexOpti itself).

  • A new client from your page: POST /v1/embed-sessions now opens the new-client component, for <lexopti-new-client>: LexOpti’s new-client form, filled from your page’s prefill property (the shape of POST /v1/clients, each field checked, never in a URL), the client created only when the member clicks create and linked to the element’s external-ref in its creation, as external_ref is; an id already linked shows its client instead. <lexopti-client external-ref="…"> shows the client your id names, or offers to create it. The event lexopti-client-created ({ clientId, externalRef }) is now sent (a new client from your page).

  • A new case from your page: POST /v1/embed-sessions now opens the new-case component, for <lexopti-new-case>: LexOpti’s own “New case” screen, filled from your page’s prefill property (its title, natures among the profession’s and parties, each an existing client by its id or your reference, or an identity to create, with its role; each field checked, never in a URL), the case created only when the member clicks create and linked to the element’s external-ref in its creation; an id already linked shows its case instead. <lexopti-case external-ref="…"> shows the case your id names, or offers to create it. <lexopti-app> opens its new-case form inside it (with edit). The event lexopti-case-created ({ caseId, externalRef }) is now sent (a new case from your page).

  • Playground, live: the embedded components playground now shows the chosen component itself, in one of your sandboxes: authorize the portal as in the API reference, and the page opens each session with POST /v1/embed-sessions and your token, as your server would, and logs the events. The portal’s application embeds from its own pages and in sandbox organizations only: anywhere else, POST /v1/embed-sessions answers 403 sandbox_required, a new error code.

  • SDK: webhooks.verify also accepts webhook.test, the delivery POST /v1/webhook-endpoints/{id}/test sends, which it used to refuse. Its result, WebhookEvent, now types type as the event types or "webhook.test": an exhaustive switch on event.type must handle the test.

  • Sandboxes: up to 5 per application, each named and with the profession it simulates. A reset now empties the sandbox in place: the organization id, your consent, tokens and webhook endpoints stay, so you reconnect nothing; the old client, case and check ids answer 404, pending deliveries are cancelled, and a sandbox is reset once a minute at most (sandbox).