Guides

User Guide

Learn how to use assurnoo

Authentification & Sécurité

Endpoints et mécanismes pour l’authentification, la gestion des sessions et la sécurité opérationnelle de la plateforme. Contient aussi les contrôles de surveillance et de journalisation essentiels au bon fonctionnement.

Authentification & sessions

Permet aux utilisateurs de se connecter à l’API, d’obtenir un jeton d’accès (JWT) et d’obtenir/renouveler des tokens de rafraîchissement. Assure la gestion sécurisée des sessions et l’expiration des accès pour protéger les ressources.

Connexion et obtention des tokens

Expliquer comment un utilisateur s’authentifie avec son email et mot de passe, l’appel API nécessaire et les tokens renvoyés (access token JWT et refresh token). Inclut exemples de requêtes/réponses et erreurs courantes.

Access & Accounts

Manage authentication, sessions and access control for users and roles. Includes token lifecycle, session revocation and administration of user accounts and permissions.

Authentication & Session Management

Sign in to the API and maintain a secure session using JWT access tokens and refresh tokens. This lets users authenticate once, renew access without re-entering credentials, and protect routes according to role or public access.

Overview & Concepts

High-level explanation of the authentication and session model: short‑lived JWT access tokens, long‑lived refresh tokens, session persistence and revocation, public routes, and role-based access control.

Utilisateurs & Organisation

Fonctions de gestion des comptes, des rôles, des permissions et des espaces de travail pour organiser l’accès et les responsabilités. Inclut également l’interface et les aides destinées aux utilisateurs internes.

Gestion des utilisateurs et rôles

Gérer les comptes applicatifs (utilisateurs) et leur rôle/autorisation. Utile pour contrôler l’accès aux fonctionnalités et organiser les responsabilités internes.

Utilisation et renouvellement de l’access token

Décrit le cycle de vie de l’access token JWT, comment l’utiliser pour accéder aux ressources et la procédure pour obtenir un nouveau access token via le refresh token lorsque l’access token expire.

Documents & Electronic Signatures

Everything around preparing, sending and tracking documents for signature, plus related metadata and compliance. Covers templates, signers, fields, seals, audit trails and document lifecycle management.

User & Role Administration

Manage application users and their roles so administrators can control who can access what. This domain supports creating users, assigning roles, and viewing user details for access control.

Sign In & Token Issuance

How to authenticate with email and password, the request/response DTOs, and what you receive: short‑lived access (JWT) and refresh tokens. Includes wiring and examples for login endpoints.

Parcours client & Offres

Toutes les ressources liées à la conversion du prospect : contacts, questionnaires, parcours d’onboarding, offres, paiements et vérifications. Permet de piloter l’expérience commerciale du profilage à la souscription.

Contacts (prospects / clients)

Créer, consulter et mettre à jour des contacts (prospects ou clients) contenant les données d’état civil et coordonnées. Sert de base pour démarrer une demande (inquiry) et communiquer avec la personne.

Gestion et sécurité des refresh tokens

Couvre la persistance, l’expiration configurables et les mécanismes d’invalidation des refresh tokens (blacklist). Explique les flux de déconnexion/compromission et les réponses serveur aux tokens invalides ou blacklistés.

Onboarding & Subscriptions

Product-oriented flows for onboarding prospects to paid plans: profile capture, needs assessment, plan discovery, verification, payments and finalizing subscriptions. Includes both frontend multi‑step workflows and backend inquiry/application management.

Contacts (Prospect / Client) Management

Create, update and manage contact records (prospects and customers) containing personal and address data. Contacts are the foundational profile used in inquiries and signature workflows.

Refresh Flow, Token Lifecycle & Blacklisting

Detailed refresh flow: how to exchange a refresh token for a new access token, refresh token persistence and expiry, automatic rotation (if used), and blacklist/revoke mechanics for logout or remote invalidation.

Documents, Signature & Archivage

Gestion complète des documents, de la signature électronique, des modèles et des preuves légales (audits, sceaux, archivage). Inclut le stockage et l’orchestration des signataires, champs et workflows de signature.

Démarches / Inquiries (demandes d’étude assurance)

Créer et gérer des demandes d’étude (inquiries) liées à un contact : besoins, couverture souhaitée, composition familiale. Permet d’organiser le parcours commercial et la proposition d’offres.

Règles et bonnes pratiques d’implémentation

Résumé des règles de sécurité à respecter (JWT + refresh tokens, persistance et blacklist), recommandations pour le stockage côté client, rotation des tokens, gestion des durées d’expiration et stratégies d’erreur pour une implémentation robuste.

Storage & File Services

Durable storage and archival services for uploaded files and compliance copies. Covers S3-backed uploads, long-term archives and retrieval/expiry management.

Inquiry & Quotation Flow

Collect and manage inquiries (insurance needs) tied to contacts so users can create, update and progress a quotation or subscription. Inquiries capture coverage needs, budget and related details used to produce offers.

Guards, Strategies & Route Decorators

Runtime enforcement and wiring: JwtAuthGuard, JwtRefreshGuard and RolesGuard behavior; passport-like strategies (jwt.strategy.ts, jwt-refresh.strategy.ts); and decorators to mark public routes or required roles.

Notifications, Webhooks & Intégrations

Gestion des événements asynchrones, webhooks et canaux de notification (emails, rappels) pour orchestrer les flux entre services et tenir informés signataires et systèmes externes. Permet d’automatiser les synchronisations et alertes.

Parcours d’onboarding multi-étapes (profil → besoins → offres → souscription)

Interface guidée qui accompagne le visiteur pas à pas : saisie du profil, questionnaire besoins/budget, affichage d’offres, finalisation (documents, paiement, signature). Permet de transformer un prospect en souscripteur.

Créer et gérer un compte utilisateur

Procédures pour créer un utilisateur, lui assigner un rôle, et mettre à jour ses informations. Inclut bonnes pratiques pour l’attribution de rôles au moment de la création.

Developer Integrations & APIs

APIs, SDKs and external integrations that let systems programmatically interact with the platform. Includes webhook subscriptions, SDKs, API docs, pagination/error conventions and content integrations.

Document Management & Storage

Upload, store and manage documents required for inquiries or signature requests; documents are versioned and can be downloaded or attached to signature workflows. Useful for collecting identity documents, mandates or contract PDFs.

Overview & core concepts

High-level explanation of the User & Role Administration domain: its purpose, key concepts (users, roles, workspaces), and the rules that govern access and data constraints. Use this page to understand how roles, workspace associations, and immutable fields affect user lifecycle and authorization.

Plateforme, API & Outils développeurs

Documentation et outils pour les intégrateurs et développeurs : API publique, SDKs, clients front, initialisation de la base et métriques d’usage. Regroupe aussi les éléments nécessaires à l’exploitation et au reporting.

Questionnaire de besoins & budget

Recueillir les besoins de couverture et le budget du prospect via un questionnaire structuré pour recommander des offres adaptées. Utile pour personnaliser les propositions et filtrer les plans.

Lister et rechercher les utilisateurs

Comment consulter et filtrer la liste des utilisateurs (pagination, filtres par workspace, recherche). Exemples d’appels API et paramètres courants.

Operations, Monitoring & Admin

Operational features and administrative controls for running and observing the system. Includes health checks, monitoring, workspace scoping, configuration and operational tooling.

Electronic Signature (Signature Requests)

Create and manage electronic signature requests (via the YouSign integration) to collect legal signatures on documents. This allows creating requests, activating them, canceling, reactivating, and monitoring their lifecycle.

Create and onboard users

Step‑by‑step guidance for creating new user accounts, selecting roles during creation, and onboarding users. Includes validation rules for primary fields, recommended role selection patterns, and examples for bulk or single account setup.

Découverte et comparaison des offres (Plans)

Parcourir, comparer et sélectionner des plans d’assurance adaptés au profil et budget du prospect. Permet de visualiser garanties, niveaux et d’identifier l’offre recommandée.

Workspaces et appartenance des utilisateurs

Gérer l’appartenance des utilisateurs aux workspaces : association, retrait, et impact sur la portée des permissions et des ressources accessibles.

Frontend UI & Client Components

Client-side building blocks and UX patterns used by the onboarding and subscription UI. Includes reusable UI components, client services/queries and file upload UX.

Signers & Approver Management

Add, update and manage signers and approvers on signature requests so the right people sign or approve documents. It also supports sending OTPs and reminders to signers.

Manage user details & activation

How to update a user's profile (name, email, job title, locale, phone), manage activation status, and adjust role membership. Explains which fields can be updated, constraints on immutable fields, and how activation state affects access.

Téléversement & gestion des documents

Uploader, remplacer, télécharger et associer des fichiers (pièces d’identité, mandats, documents signables) aux inquiries ou demandes de signature. Utile pour rassembler les pièces nécessaires à la souscription et à la signature électronique.

Rôles et permissions

Explication des rôles, de leur relation avec les permissions, et des bonnes pratiques pour concevoir et modifier la politique d’accès. Inclut comment consulter ou modifier le rôle d’un utilisateur.

Document Fields & Form Fields Management

Define and manage interactive document fields (text, checkboxes, radio groups, signature areas) used during signing so signers can fill or sign in the right places. Fields are used to build the signing experience and collect structured signer input.

Roles, workspace membership & visibility

Details on role semantics, permission inheritance, viewing users and their roles, and associating users with workspaces. Covers assigning/removing workspace membership, how workspace scope limits access, and how to view user details and workspace associations.

Signature électronique (création & gestion des demandes)

Créer et piloter des demandes de signature électronique (YouSign) : composer les signataires, documents, options d’activation, rappels et expiration. Crucial pour sécuriser et valider des contrats et mandats.

Créer un contact

Guide pour créer une fiche contact (prospect ou client) : champ de profil, validations (email, téléphone E.164, date ISO, code postal numérique), champs requis (prénom, nom, email), CGU, et utilisation initiale comme base pour démarrer une demande (inquiry). Inclut l'appel API pour l'enregistrement.

Signer Document Requests & Signer Uploads

Request that signers upload documents (for identity verification or supporting documents) and manage those uploaded files. This supports workflows where signers provide attachments rather than the sender uploading everything.

Contacts — Overview & Concepts

High-level introduction to contact records (prospects and clients). Explains core fields, how contacts are used in inquiries and signature workflows, locale handling, phone formatting, and the role of workspace scoping.

Gestion des signataires

Ajouter, mettre à jour et administrer les signataires d’une demande de signature : envoyer OTP, rappels et permettre la signature. Permet d’orchestrer qui signe quoi et comment.

Mettre à jour un contact

Modifier les informations d'un contact existant (email, téléphone, adresse, statut, source). Exemples d'appels PUT/PATCH, validations applicables et bonnes pratiques pour l'édition sans perte de données.

Electronic Seals

Create and manage electronic seals (machine-applied seals) and their images for document sealing and audit purposes. Seals can be uploaded, associated to documents and audited.

Create Contacts

How to create new contact records via the API or UI. Documents required and optional fields (first name, last name, email, locale, phone, company, address), validation rules, and common error responses.

Champs/formulaires sur documents (textes, cases, signatures, radios)

Placer et gérer des champs (zones de signature, texte, checkbox, radio, mentions) sur des documents pour collecter des informations des signataires. Indispensable pour construire les formulaires signables.

Lister, rechercher et paginer les contacts

Comment parcourir la base de contacts : endpoints, pagination (curseur/limit ou skip/limit), filtres et recherche par nom, téléphone, email, source, statut, date. Conseils pour performances et navigation paginée.

Archives & Long-term Storage

Upload files to an archives module for long-term storage and retrieval; optionally set expiry, tags and workspace associations. Useful for exporting signed packages or storing compliance copies.

List & Search Contacts

Retrieve and filter contact lists. Shows paginated endpoints, query parameters for searching and filtering, pagination semantics, and best practices for performant queries.

Approvals (approbateurs) & workflow d’approbation

Gérer des approbateurs (personnes devant accepter) sur une demande de signature : ajout, mise à jour, suppression, rappel. Utile pour flux d’approbation interne avant signature finale.

Consulter le détail d'un contact et l'utiliser

Accéder à la fiche détaillée d'un contact : informations d'état civil, coordonnées, statut et source. Utiliser une fiche contact comme base pour créer une inquiry/devis et suivre le parcours du prospect/client.

Audit Trails & Compliance Downloads

Retrieve audit trails for signature or seal events to support compliance, dispute resolution or record keeping. Audit trails can be requested as JSON or downloadable blobs.

View, Update & Delete a Contact

Read and manage individual contact records. Covers retrieving a contact by ID, updating fields (with validation and trimming rules), and deleting a contact. Includes concurrency and error-handling guidance.

Followers (observateurs)

Ajouter et consulter des observateurs d’une demande de signature qui recevront des notifications ou pourront suivre l’avancement sans signer. Utile pour information/assurance ou suivi interne.

Supprimer et gérer les contacts obsolètes

Procédure pour supprimer un contact (API DELETE), critères d'obsolescence, impacts et précautions avant suppression. Exemples d'appel et bonnes pratiques de conservation/archivage.

Templates & Reusable Documents

Create and manage reusable templates for signature requests so common documents and signer placeholders can be reused. Templates speed up creating new signature requests with preconfigured fields and signers.

Workspace Scoping & Access

How workspace association affects contact ownership and access. Explains workspace_id usage when creating or querying contacts, multi-tenant considerations, access restrictions, and examples showing scoped vs global retrieval.

Templates de signature

Gérer et réutiliser des modèles (templates) de demandes de signature pour accélérer la création de demandes récurrentes avec documents/positions/fournisseurs déjà configurés.

Initier une demande d’étude

Créer une nouvelle inquiry liée à un contact existant : quand et comment lancer la demande, champs initiaux indispensables (contactId, type de couverture souhaitée, date souhaitée). Exemples de payload et bonnes pratiques pour associer correctement le contact.

Custom Experience & Branding

Customize the signing UI and emails with custom experiences (colors, logos, visibility flags and redirect URLs) to match branding and customer flows. Useful for white‑labeling and controlling signer UI elements.

Overview & Concepts

High-level concepts, entities and rules for the Inquiry & Quotation Flow: what an inquiry is, how it ties to a contact, key metadata and status values, boolean flags that affect downstream flows, and validation expectations for the multi-step form.

Expériences customisées & branding

Configurer l’expérience de signature (couleurs, logo, visibilité d’éléments, redirections) pour personnaliser l’interface signataire. Permet d’harmoniser l’expérience aux couleurs de la marque ou de campagnes.

Renseigner et mettre à jour les besoins

Compléter ou modifier les détails de l’inquiry : couverture souhaitée, budget, composition familiale (nombre d’enfants), numéro de sécurité sociale, date souhaitée. Quand certains champs deviennent requis selon les étapes de souscription.

Workspaces & Organization Scoping

Manage workspaces to partition resources and set default contexts for operations such as documents and signature requests. Workspaces help teams manage resources independently within the organization.

Create & Edit Inquiries

Step-by-step guidance for starting and editing inquiries: the inquiry form fields (coverage, desired date, family info, children count, budget, regional flags), required validation rules, and how to ensure an inquiry is linked to an existing contact at creation time.

Workspaces & organisation

Gérer des espaces de travail (workspaces) pour segmenter les ressources (documents, templates, utilisateurs) par périmètre organisationnel. Utile pour déléguer et isoler les données entre entités ou équipes.

Consulter et piloter le parcours commercial

Accéder à une inquiry pour suivre l’avancement commercial, historiser les échanges et préparer les propositions d’offres. Bonnes pratiques pour structurer le parcours et relier l’inquiry aux étapes de vente.

Webhooks & Event Subscriptions

Configure webhook subscriptions to receive realtime events (signature state changes, uploads) so your system can react to external events. Subscriptions are configurable with scopes, events list and retry behavior.

Progression & Subscription

How to move an inquiry through its lifecycle toward quotation and subscription: attaching offers, signing termination mandates, tracking status transitions, and rules for booleans that influence downstream subscription forms.

Webhooks & intégrations événementielles

Configurer des webhooks pour recevoir des notifications asynchrones (événements de signature, document, etc.). Permet d’automatiser les traitements côté serveur à la réception d’événements.

Documents, mandats et pièces jointes

Attacher et gérer les documents liés à une inquiry : types de pièces, mandats, règles de liaison via inquiry_id et processus d’upload. Exemples d’upload et métadonnées requises.

Usage & Consumption Reporting

View and export usage statistics (consumption) for API and application-level features to monitor usage and billing. The system provides consumption endpoints and exportable CSVs.

Retrieve, Documents & APIs

Reference for retrieving inquiry details, available API endpoints, document linking and storage, and updating an inquiry during the subscription phase (e.g., attaching signed mandates or proof documents). Includes examples of view requests and best practices for metadata.

Sceau électronique (Electronic Seal)

Gérer la création d’un sceau électronique appliqué à des documents (upload de document, image de sceau, audit trail). Utile pour apposer une preuve d’authenticité organisationnelle.

Vue d’ensemble du parcours d’onboarding

Récapitulatif du flux multi-étapes : objectifs, étapes clés (profil → besoins → offres → souscription), navigation et règles d'intégrité des données. Utile pour comprendre le comportement global et les intégrations (API, mutations, validation).

Email Notifications & Messaging

Send and customize emails for signature requests and other flows (Mailgun integration) for notifications and confirmations. Emails include custom texts and branding controlled by custom experiences.

Upload & Create Documents

How to send files (multipart) with metadata to create Document resources. Covers required fields (nature), optional parsing anchors, initials areas, passwords for protected files, and insert position when uploading directly to a signature request.

Archivage et export de fichiers

Archiver des fichiers dans un espace d’archivage et permettre leur téléchargement ultérieur (avec métadonnées, tags et date d’expiration). Utile pour conservation légale et conformité.

Saisie et validation du profil

Guide pratique pour le formulaire profil : champs (nom, date de naissance, adresse), validation client (profile-schema), UX des erreurs, sauvegarde du contact et modal d’édition depuis la souscription.

Front-end Onboarding & Multi-step Subscription Flow

Guided multi-step onboarding for selecting health insurance: collect profile data, questionnaire, show plan offers and finalize subscription with documents, payment and signature. It provides a stepper-style UI with validation and local state across steps.

Attach & Link Documents to Requests

Attach previously uploaded documents (or include document IDs at creation) to signature requests or inquiries. Explains linking workflows, required document natures, ordering/insert positions, and how anchors affect placement of signature fields.

Audit trails & preuves de signature

Accéder aux pistes d’audit (audit trails) générées lors des opérations de signature pour assurer traçabilité et conformité. Essentiel pour preuve légale des actions et pour diagnostics.

Questionnaire besoins et budget

Structuration du questionnaire (besoins, budget), règles de validation (inquiry-schema), enregistrement des réponses et synchronisation avec le contact/inquiry. Bonnes pratiques pour taux de complétion et gestion des étapes dépendantes.

Questionnaires & Budget / Needs

Collect structured answers about a user’s needs and budget through questionnaires to recommend plans. Questionnaires power coverage gauges and drive offer personalization.

Download & Export Documents

Retrieve single documents as blobs or download all documents attached to a signature request as a bulk ZIP. Includes API patterns for streaming, content-types, and tips for handling large exports.

Consommation & rapports (usage)

Consulter les métriques d’utilisation (consommation d’API, signatures, sceaux) et exporter des rapports. Permet le suivi des quotas et la facturation interne/tiers.

Parcourir, comparer et sélectionner des offres

Affichage des offres, filtres et comparaison, modal de détails et sélection du plan. Impact de la sélection sur le statut du contact et appels API associés (mutations).

Offers & Plan Selection

Present insurance plan offers, allow browsing, comparing and selecting a plan to subscribe. The UI shows plan cards, comparison modals and supports pagination and selection persistence.

Replace, Delete & Versioning

Manage document lifecycle: replace files, delete documents from requests, and understand versioning semantics. Covers constraints for protected/locked files and how replacements affect anchors, page counts and checksums.

Demandes de documents par signataire (Signer Document Requests)

Demander à des signataires de téléverser des documents spécifiques (ex: justificatifs), gérer ces requêtes et récupérer les fichiers uploadés par les signataires.

Finalisation de la souscription (documents, paiement, signature)

Étapes finales : collecte de documents, vérifications, autorisation de paiement et déclenchement de la signature électronique. Validation finale (final-schema) et passage à l’état de souscripteur.

Payments & Authorization

Authorize and process payments required to finalize subscriptions. The front-end supports an authorization step and an expandable payment form to collect timely payment information.

Document Metadata, Security & Processing

Reference for document properties and metadata operations: update nature, insert positions, password and initials area; understand tracked properties like total pages, anchors, checksums and locked/protected state, including processing caveats (values may be null until processed).

Métadonnées de demandes (metadata)

Attacher, lire et mettre à jour des paires clé/valeur (metadata) à une signature request pour stocker des informations métier (ex: external_id, tags). Pratique pour relier la request à des systèmes externes.

Structure et lancement du questionnaire

Comprendre la structure JSON des questionnaires, comment la récupérer et démarrer le parcours prospect. Inclut la logique de visibilité conditionnelle des questions et le schéma de stockage des questionnaires.

Identity & Document Verification

Verify user identity and documents (ID, bank, health card) using verification providers so subscriptions meet identification compliance. The front-end triggers verification mutations and shows progress to the user.

Create Signature Requests

Create signature requests from templates or uploaded documents. Define request name, attach documents, add signers (optional ordered signing), and set reminders, expiration and delivery options. Includes steps to save drafts and activate requests to notify signers.

Vérifications d’identité & justificatifs (intégrations)

Vérifier l’identité d’un prospect via pièces (ID), vérifier les coordonnées bancaires et la carte vitale/health card. Utilisé lors de la finalisation pour réduire la fraude et automatiser la conformité KYC.

Saisie, navigation et sauvegarde locale

Bonnes pratiques pour guider l'utilisateur question par question, gérer l'UX (progression, erreurs temporaires) et sauvegarder les réponses localement avant validation finale.

File Storage (S3) & Upload Backend

Store files in S3-backed storage for documents, verification attachments and archives. The backend exposes upload endpoints and links documents to S3 object keys so files persist reliably.

Manage Request Lifecycle

Manage signature requests throughout their lifecycle: activate, cancel (with reason and optional note), and reactivate expired requests by setting a new expiration. Explain which operations are permitted in each status and common error cases (e.g., cannot activate a deleted request).

Paiement & autorisation

Autoriser et exécuter le paiement lié à la souscription : collecter les informations de paiement et autoriser le débit. Partie indispensable pour finaliser la souscription commerciale.

Validation et persistance côté serveur

Validation front via le schema questionnaire-budget-schema, affichage des erreurs, et persistance des réponses en base via les mutations contact + inquiry. Exemples d'appels et gestion des erreurs multi-mutations.

Health & Application Monitoring (Health Checks & Throttling)

Infrastructure-level monitoring and rate-limiting to keep the API secure and healthy. Health checks let operators confirm app readiness; throttling protects against abuse.

Monitor and Inspect Requests

List, filter and inspect signature requests to follow progress. Use filters by status, source, date and signer; fetch full request details, event history and per-signer status to track drafts, ongoing flows, completed signatures, cancellations and expirations.

Emails & notifications

Envoyer des emails transactionnels (invitations, notifications de signature, rappels) via Mailgun ou la configuration d’envoi. Permet d’informer signataires et followers des actions à mener.

Jauges de couverture et questions dérivées

Concevoir et piloter les jauges de niveau de couverture : interactions, mise à jour visuelle, et impact sur les questions affichées (logique dérivée). Modèles d'état et synchronisation UI/ données.

Developer SDK & YouSign Integration

Low-level SDK integration with the YouSign API that powers signature, document and workspace operations. Developers can call these services programmatically to operate the signing lifecycle.

Reminders, Expiration & Delivery

Configure automated reminders, set expiration dates, and choose delivery modes. Covers allowed reminder intervals and maximum occurrences, date format requirements, and default expiration behavior so requests remain valid and signers are prompted correctly.

Administration des webhooks & notifications internes

Configurer la réception d’événements externalisés (ex: état de signature) pour automatiser le traitement backend et synchroniser les statuts dans votre système.

Parcourir les plans

Guide pour naviguer dans la liste des plans, comprendre la structure des PlanCard et optimiser le défilement pour une découverte rapide des offres.

UI Components & Form Controls

Reusable UI atoms, molecules and modals that compose the front-end experience for onboarding, plan selection and subscription. These building blocks provide inputs, selects, radio groups, modals and plan cards.

Add & Manage Signers

Create signers on signature requests (from scratch, from an existing contact, or from a user account), update their contact details and optional signature fields, and remove signers when needed. Covers input validation (E.164 phone format) and how signer records are stored on the request.

UI & aides utilisateur (modals, validation, navigation)

Composants d’interface permettant à l’utilisateur d’interagir (formulaires, modals, boutons, sélecteurs). Améliore l’expérience et la saisie guidée des données.

Filtrage 100% santé et rendu visuel

Comportement de la bascule 100% santé : comment elle filtre les offres, change la palette visuelle et adapte le rendu des cartes pour mettre en avant les offres conformes.

Signature Request Metadata & Custom Fields

Attach arbitrary metadata to signature requests to store custom key/value information used in webhooks or redirects. Metadata provides a flexible way to tie business context to a request.

Signer Authentication & OTPs

Configure signer authentication modes (none, OTP via email or SMS), change a signer's authentication via patch, and trigger one-time passcodes. Explains OTP delivery (email vs SMS), E.164 phone requirements, how authentication choice alters the signing flow, and system rate-limits affecting OTPs.

Support utilisateur (contact flottant & aide)

Fournir un accès rapide au support via un bouton flottant (icône téléphone) et des éléments d’aide pendant le parcours. Facilite la conversion en aidant l’utilisateur au bon moment.

Comparer les offres

Mode d'emploi du comparateur : ouvrir le tableau modal, lire et interpréter les niveaux et garanties pour identifier rapidement l'offre recommandée.

Followers & Read-Only Observers

Add followers to a signature request so non-signing people can watch the progress or access read-only links. Followers are useful for notifying stakeholders without granting signing rights.

Approvers & Approval Workflow

Manage approvers on signature requests: add or remove approvers, send reminders to approvers, and understand approver notifications and rate-limiting. Describes when approvers act relative to signers and how approver actions affect request status.

Sécurité, configuration & infrastructure

Paramétrer et exploiter les mécanismes globaux (CORS, helmet, compression, throttling, logging) et la configuration d’intégrations (S3, Mailgun, YouSign). Assure robustesse et conformité opérationnelle.

Sélection, persistance et impacts commerciaux

Procédure de sélection d'un plan, mise à jour d'état (selectedPlanId), persistance via API et conséquences possibles (mutation de contact et changement de statut commercial).

Operational Utilities & Dev Tools

Developer and operational utilities for configuration, SDK publishing and project tooling that support building and running the app. These are mostly developer-facing but impact deployability and quality.

Monitoring Signer Status & Reminders

Retrieve signer lists and individual signer status, interpret lifecycle states (initiated, notified, signed, declined, etc.), and send reminders to signers. Explains which actions are available at each status and how reminders interact with lifecycle and notification limits.

Authentification

Permet aux utilisateurs autorisés de se connecter à l'application et d'obtenir des jetons d'accès (JWT) pour utiliser les API. Offre aussi la possibilité de renouveler un access token via un refresh token afin de rester connecté sans ressaisir ses identifiants.

Téléversement de documents

Comment téléverser des fichiers (pièces d’identité, mandats, documents signables) depuis le poste client vers la plateforme. Exemples d'appels, format multipart/form-data, gestion du champ nature (attachment vs signable_document) et bonnes pratiques pour l'association à une request ou une signatureRequest.

User Administration

Manage application user accounts used to access the backend. Administrators can create, view, update, and list users and assign roles so that staff or system accounts can access features appropriate to their responsibilities.

Fields Overview & Concepts

Core concepts, field types and global rules you must know before creating forms. Explains text, checkbox, radio groups, signature areas, read-only text and mentions, field scoping (document vs signer), coordinate system, page numbering, sizing rules (text heights) and radio-group behavior.

Gestion des comptes utilisateurs

Permet aux administrateurs de créer, lister, consulter et mettre à jour des comptes applicatifs (utilisateurs) avec attribution d'un rôle. Utile pour gérer l'accès et les responsabilités dans le back-office.

Remplacement et conservation d'un document

Procédure pour remplacer un document existant dans une request sans changer son emplacement logique. Appel d'API, gestion du même documentId, impacts sur les versions et conseils pour conserver l'historique et la validité des documents signables.

Role & Permission Management

Define and browse roles that are assigned to users to control access levels across the system. Roles let administrators group permissions and apply role-based guards to protect endpoints.

Add Fields (Create)

Step-by-step guide to adding fields to a document. How to specify page, x/y coordinates (points/px), width/height, type (text, checkbox, radio, signature), and optional properties such as max length, default values, optional/required flag, font, and signer assignment.

Gestion des rôles et permissions

Permet de consulter et gérer les rôles disponibles dans l'application pour contrôler l'accès aux fonctionnalités. Utile pour organiser les niveaux d'accès des utilisateurs et protéger les ressources sensibles.

Téléchargement des documents

Télécharger un document individuel ou l'ensemble des pièces d'une demande. Exemples d'appels pour récupérer un blob/zip, paramètres disponibles (version=current|completed, archive={boolean}) et recommandations pour le streaming et la sécurisation des téléchargements.

Contact / Prospect Profile Management

Create and manage contact profiles for prospects or customers (personal data and consent). Contacts are the central person entities that inquiries and documents are linked to—useful for onboarding and tracking application progress.

Update & Delete Fields

How to modify and remove existing fields. Patch field coordinates, label/question, font, optional/required state, and radio-group membership. Delete a field by ID and considerations for maintaining form integrity when removing or changing fields.

Demandes / Études (Inquiries)

Créer et gérer des demandes d'étude (inquiries) associées à un contact — recueillir besoins, budget, membres de la famille, date souhaitée et mandats. Permet de suivre l'avancement d'une intention de souscription.

Suppression et métadonnées des documents

Gestion de la suppression des fichiers et des métadonnées associées (nature, associations aux requests). Règles d'usage pour supprimer une pièce, effets sur les demandes de signature et recommandations pour l'archivage plutôt que suppression définitive.

Inquiry (Application) Management

Create and update insurance inquiries (applications) linked to a contact; capture needs, budget, family members, plan preferences and mandate/resiliation details. Inquiries represent the user's application progress and are the central object for subscription completion.

List Fields & Form Preview

Retrieve and render the fields present on a document to build a signing preview. Tips for fetching all fields, ordering by page/position, rendering radio groups and mentions, and distinguishing read-only vs editable fields for the signer UI.

Questionnaires & Profilage

Fournit et gère les questionnaires utilisés pour capter les besoins et le budget des prospects (intégration Coog), afin de personnaliser les offres proposées. Permet aux utilisateurs d'affiner leurs réponses et au système de construire des recommandations.

Créer une demande de signature (payload et signataires)

Composer et valider le contenu d’une demande de signature : documents, signataires (simultanés ou ordered_signers), options d’activation, métadonnées et bonnes pratiques avant envoi. Inclut exemples de payload et contraintes de format.

Document Upload & Management

Upload and manage documents tied to an inquiry (ID cards, bank statements, health cards, contracts, termination mandates). This lets users provide required paperwork for verification and subscription completion; documents are stored and tracked with statuses.

Advanced Field Types, Validation & Best Practices

Deep dive into complex field behaviors and validation: signature placement, radio group design, complex mention behavior, required/optional validation flows, font sizing, accessible form design, and rules for ensuring reliable signer input capture.

Parcours multi-étapes (Onboarding & Souscription)

Expérience utilisateur guidée en plusieurs étapes (profil, besoins, offres, souscription, paiement, signature). Conduit un prospect du remplissage du profil jusqu'à la finalisation d'une souscription.

Activation, annulation et réactivation des demandes

Actions de cycle de vie : lancer l’envoi d’une demande, annuler une demande (avec motif) et réactiver une demande expirée. Règles liées aux statuts (quelles actions sont permises selon draft/ongoing/expired/...).

Identity (ID) Verification

Automatically verify identity documents (ID card, passport, etc.) using an external verification provider to parse and validate data. This expedites onboarding and reduces manual checks by extracting structured identity data from uploaded files.

Overview & Concepts

High-level explanation of signer document requests: what they are, how they relate to signature requests and signers, and the core rules that govern uploads and scoping.

Offres et Plans

Permet aux utilisateurs de parcourir, comparer et sélectionner des plans d'assurance santé proposés. Utile pour choisir la couverture la mieux adaptée en fonction des besoins et du budget.

Rappels, expiration et règles de délai

Configurer les reminders et la date d’expiration des demandes : format attendu, comportement par défaut (échéance à 6 mois si non fournie), gestion des relances et bonnes pratiques pour la rétention et la sécurité.

Bank & Health Card Verification

Verify bank documents and health insurance cards using automated external verification to ensure payment and health data are valid. This reduces fraud and speeds up subscription completion.

Create & Configure Document Requests

How to create signer document requests and configure which signers are required or optional to upload. Includes API fields, payload examples, and how to assign signers when creating or updating a request.

Documents & Téléversements

Permet aux utilisateurs d'uploader des pièces justificatives (pièce d'identité, RIB, carte vitale, mandat de résiliation, etc.) liées à une inquiry et de suivre leur statut. Ces documents sont stockés et référencés pour vérification et signature.

Lister et filtrer les demandes

Requêtes et critères pour obtenir et filtrer les signatureRequests par statut, date, signataire, document, etc. Conseils pour pagination, performance et auditabilité des actions.

E-signature (Signature Requests)

Prepare, manage and activate electronic signature requests using YouSign; upload documents to sign, add signers and their signature fields, then activate the request to collect signatures. This completes legal acceptance and contract signing digitally.

Signer Uploads — Retrieve, Download & Delete

Endpoints and examples for retrieving signer uploads (paginated), downloading specific uploaded files, and deleting documents or entire request uploads when needed. Includes scoping details by signature request and signer.

Vérification d'identité & pièces

Permet la vérification automatique des pièces envoyées (pièce d'identité, RIB, carte vitale) via un provider externe (Datakeen). Garantit l'authenticité des documents et extrait des informations utiles (nom, date de naissance...).

Créer et ajouter des signataires

Comment ajouter des signataires à une demande : depuis un contact existant, depuis un utilisateur ou en créant un signataire 'from scratch' (prénom / nom / email). Inclut bonnes pratiques sur l’assignation d’un rôle/signataire à une page/document.

File Storage (S3-backed)

Persist uploaded files to a central object storage (S3) so documents are durable and retrievable by the application. Users benefit from reliable storage for their submitted documents.

Permissions, Validation & Best Practices

Guidance on who can upload, validation rules to enforce (file types, size, optional vs required), error handling, and recommended patterns for sender and signer UX when requesting and handling uploaded documents.

Paiement

Gérer l'autorisation et l'exécution des paiements pour finaliser une souscription. Les utilisateurs peuvent saisir les données de carte et déclencher une autorisation/paiement sécurisé.

Modifier et supprimer un signataire

Mettre à jour les informations d’un signataire (nom, email, rôle, ordre de signature) et retirer un signataire d’une demande. Inclut validation des modifications et impacts sur l’acheminement de la demande.

Questionnaires & Needs Assessment

Deliver and manage questionnaires used during needs assessment and budgeting (pulled from an external questionnaire provider or stored locally). This helps capture the applicant's coverage preferences to tailor plan offers.

Concepts & Rules

Fundamental concepts, data model and rules for electronic seals: identifiers, timestamps, signature levels (electronic vs advanced), certificate ID requirements, and how audit trails are represented. Use this as the reference before uploading or creating seals.

Signature électronique

Gèrer la création et le déroulé d'une demande de signature électronique via YouSign : initialisation, upload de documents à signer, ajout de signataires et activation de la demande. Permet de finaliser contractuellement la souscription à distance.

Authentification et OTP

Paramètres et flux d’authentification des signataires : envoi d’OTP par email ou SMS, options pour désactiver l’OTP selon configuration, et gestion des tentatives/expiration.

Plans & Offers Browser

Browse insurance plans and offers, inspect details, and select a plan to progress to subscription. This helps users compare and choose the most appropriate coverage package.

Upload & Manage Seal Files

How to upload seal images and seal documents (multipart upload), list stored images/documents, retrieve details and download image/document blobs. Includes guidance on identifiers, metadata and best practices for file formats and sizes.

Gestion des tokens de rafraîchissement (sessions)

Gérer les refresh tokens utilisés pour prolonger la session utilisateur : stocker, retrouver et blacklister un refresh token en cas de déconnexion ou de révocation de session.

Rappels et configuration des relances

Envoyer des rappels aux signataires, comprendre les limites et la configuration des rappels via reminder_settings (fréquence, nombre maximal, modèle de message). Bonnes pratiques pour réduire les oublis.

Subscription & Mandate (Contract Finalization)

Collect final subscription information including personal/contract details and termination mandates for transferring contracts. This is the last step before payments/signing to onboard a customer into a plan.

Create & Configure Electronic Seals

Create electronic seals by linking a seal document, optional image and defining field placements and signature level. Covers field coordinate/anchor placement, signature level options (electronic vs advanced), providing certificate IDs for advanced seals, and validation rules.

Santé du système (Health Check) et monitoring

Endpoints de vérification de l'état d'exécution de l'application (connectivité HTTP et base de données). Utile pour l'opération et la supervision (readiness / liveness checks).

Signer au nom d’un signataire (API côté serveur)

Forcer une signature via l’API depuis le serveur (server-side signing) : cas d’usage, prérequis d’autorisation, traçabilité/audit et l’appel API pour réaliser la signature au nom d’un signataire.

Payment & Authorization

Authorize and process payments for chosen plans using a payment gateway. The UI supports entering card details, authorizing a payment before final processing, and reporting status for completed or failed transactions.

Audit Trails & Compliance Downloads

Access and download audit trails and sealed documents for compliance and record-keeping. Explains available audit trail formats, how to request blobs for download, retention considerations, and how audit data maps to seal and document identifiers.

Stockage de fichiers (S3)

Service de persistance des fichiers téléversés (S3 compatible). Les utilisateurs bénéficient d'un stockage sécurisé et scalable pour les pièces justificatives et documents de signature.

Aperçu et liste des champs

Consulter rapidement tous les champs placés sur un document : types, positions, pages et propriétés. Inclut comment récupérer la liste via l'API et bonnes pratiques pour vérifier l'état des champs avant envoi aux signataires.

Onboarding Multi-step Workflow (Frontend)

A guided multi-step onboarding wizard that walks users from profile creation through needs assessment, offer selection, subscription, payment, and signature. It orchestrates state across steps, validations and API calls so users complete their subscription smoothly.

Getting started with Custom Experiences

Introduction to custom experiences: core concepts, when to use white‑labeling, and the basic rules you must follow when creating or updating experiences.

Administration des questionnaires externes (Coog)

Récupère et expose des questionnaires et routes commerciales fournis par le fournisseur Coog, permettant d'alimenter les étapes de profilage et de vente. Utile pour maintenir les questionnaires centralisés et à jour.

Créer des champs (signature, texte, checkbox, radio, mention, read-only)

Guide complet pour ajouter des champs sur un document : payload CreateField, exemples pour chaque type (signature, texte, checkbox, radio, mention, read-only) et validations côté API. Explique les règles de positionnement et de taille à appliquer lors de la création.

File Upload User Experience

Front-end UX for selecting, previewing, removing and uploading files (ID, bank, health card) as part of subscription. It provides users clear feedback (badges/status) and the ability to manage attachments before final submission.

Design & Branding (Colors and Logos)

How to set colors and upload or remove logos to match your brand. Includes color format requirements, logo upload mechanics, sizing recommendations and how to associate a logo with an experience.

Gestion des statuts & workflow client

Suivre l'état d'un contact tout au long du parcours (situation, besoins, offres, souscription, signature, échec paiement, terminé, client). Permet aux équipes de suivre et filtrer par étape.

Mettre à jour position, taille et propriétés

Modifier des champs existants pour ajuster position, dimension ou propriétés métier (obligatoire, étiquette, valeur par défaut, style). Couvrir le comportement attendu des coordonnées en points et contraintes de taille lors des mises à jour.

Admin API Documentation & Health Monitoring

Access machine-readable API documentation (Swagger) and run health checks to verify service and database availability. Useful for integrators and operators to inspect endpoints and ensure the system is healthy.

UI Controls & Visibility

Control signer UI elements for simplified or guided flows: disable landing pages, hide side panels, adjust discoverability and selectively mute notifications.

API publique & documentation (Swagger)

Fournit une documentation OpenAPI/Swagger des routes exposées par l'application pour exploration et développement. Utile pour les intégrateurs et développeurs qui consomment l'API.

Types de champs & règles avancées (radio, checkbox, read-only, mentions)

Détails techniques et règles spécifiques par type de champ : création et nommage des radio groups, comportement des checkboxes, contraintes pour les champs read-only (auto-sizing), et bonnes pratiques pour les mentions et labels. Scénarios d'utilisation et erreurs fréquentes à éviter.

Refresh Token Store & Revocation (Session Security)

Server-side storage and lifecycle management of refresh tokens enabling session revocation and secure token rotation. This ensures sessions can be invalidated remotely and limits reuse of refresh tokens.

Redirects & Email Presentation

Configure post-signing redirects (success, error, decline) and customize how emails present your brand. Covers URL handling, fallback behaviors and email presentation options.

Logs, configuration & environnements

Gérer la configuration de l'application et le logging (request id, niveau) pour assurer l'observabilité et un comportement différent selon l'environnement (local, dev, prod).

Aperçu des approbations et concepts clés

Introduction au workflow d’approbation : rôles des approbateurs, statuts possibles (initiated, notified, approved, rejected), liens d’approbation avec expiration et impact du paramètre ordered_signers. Idéal pour comprendre le modèle avant d’implémenter les actions API.

Pagination, Generic Responses & Error Handling

Consistent API response shapes for paginated lists, generic data responses, and unified error handling to present predictable results to clients. This improves developer experience and simplifies UI integration.

Workspace Overview & Scoping

High-level guide to workspaces: what they are, how they partition organization resources, and how to list and select a workspace to scope API operations.

Create & Update Workspaces

How to create new workspaces, retrieve workspace details, and patch workspace properties (display name, external name). Includes guidance for deleting a workspace and transferring/mapping resources during deletion.

YouSign SDK & client généré

Gérer les approbateurs (ajout, modification, suppression)

Guide pratique pour ajouter, mettre à jour et supprimer des approbateurs sur une demande de signature. Inclut les champs attendus, validations, et exemples d’appels API.

Admin Questionnaire & Content Integration (Coog)

Server-side integration with an external questionnaire/sales-route provider (Coog) to fetch updated questionnaires and sales route definitions; administrators can manage or sync questionnaire content used by the onboarding flow.

Default Workspace & Scoping Behavior

Instructions for marking a workspace as the account default, and details on how the default workspace affects operation contexts (documents, signature requests, etc.).

Client-side API wrappers & React Query hooks

Rappels et notifications aux approbateurs

Comment envoyer des rappels et gérer les notifications d’approbation : usage de l’endpoint de rappel, conditions d’envoi, et comportement attendu selon le statut de l’approbateur.

System Configuration & Environment Settings

Centralized configuration for runtime behavior (database, S3, Mailgun, JWT, YouSign and Datakeen). Administrators and operators can configure environment variables to adapt deployments across environments.

Workspace Users & Permissions

Manage workspace membership: add and remove users, and understand permission boundaries (organization-level permissions that typically limit workspace operations).

Base / initialisation de la base de données

Règles, contraintes et bonnes pratiques d’intégration

Règles à respecter pour ne pas perturber le workflow : préserver l’ordre si ordered_signers est activé, gérer l’expiration des liens, stratégies de reprise en cas d’échec et recommandations pour éviter des états incohérents.

Developer Tools: SDKs & Swagger Integration

Provide SDK wrappers and generated client models (e.g., YouSign SDK) and expose OpenAPI documentation so integrators can programmatically interact with subsystems with typed models and examples.

Overview & Concepts

High-level introduction to webhook subscriptions: what events and scopes are, how subscriptions work, sandbox mode, secrets for verification, and the delivery model so you understand the building blocks before you create subscriptions.

Introduction et concepts clés

Vue d'ensemble des Custom Experiences : objectifs, composants (couleurs, logo, éléments UI, redirections) et règles applicables (nettoyage des champs texte, validations d'URL, impact des options de désactivation). Utile pour comprendre le modèle de données et les bonnes pratiques avant d'utiliser l'API.

Health Checks & Application Bootstrap

Start the application with logging, interceptors and health endpoints to ensure safe boot and observability. Operators can monitor the app for runtime health and connectivity to dependencies.

Create & Manage Subscriptions

Step‑by‑step guidance for creating, listing, retrieving, updating and deleting webhook subscriptions. Includes required fields (HTTPS endpoint, events, scopes) and examples of common update flows.

Créer et mettre à jour une Custom Experience

Comment créer une nouvelle Custom Experience et mettre à jour une expérience existante (couleurs, nom, options de désactivation, redirections). Paramètres attendus (name, colors, options) et exemples d'appels API (POST /customExperiences, PATCH /customExperiences/{id}). Conseils de validation et de tests.

Client-side Services & Queries

Security & Verification

How to keep webhook delivery secure: generating and rotating secret keys, verifying signatures on incoming payloads, endpoint requirements (HTTPS) and sanitization rules for description fields.

Gérer les logos

Uploader et supprimer le logo associé à une Custom Experience. Exemple d'appel multipart pour l'upload et considérations pratiques (format, résolution, remplacement). Endpoints détaillés : PATCH /customExperiences/{id}/logo et DELETE /customExperiences/{id}/logo.

Delivery, Retries & Sandbox

Delivery semantics and reliability: how auto-retry works (exponential back-off up to eight attempts), how to enable/disable auto-retry and sandbox mode, and when to use sandbox for integration testing.

Personnalisation UI : couleurs, éléments et redirections

Configurer l'apparence visible par le signataire : palette de couleurs, désactivation d'éléments (landing page, side panel, email logo...), et redirections de fin (success/error/decline). Explications sur l'effet des options de désactivation sur l'interface et contraintes sur les URLs (https obligatoires).

Best Practices & Troubleshooting

Practical recommendations and troubleshooting tips: selecting events and scopes, validating endpoints, interpreting delivery logs, diagnosing signature verification failures, and cleanup guidance for unused subscriptions.

Concepts et règles

Présentation des principes de base des workspaces : isolation des ressources, délégation par périmètre organisationnel, règle du workspace par défaut, et exigences liées à la suppression (migration des ressources). Utile pour comprendre le modèle avant d'utiliser les actions API.

Onboarding Flow Overview

High-level walkthrough of the stepper-style onboarding journey: profile → inquiry → needs/budget questionnaire → plans → subscription → payment & signature. Explains UI patterns (stepper, floating contact icon, comparison modal), the role of theming and offer switches (e.g. isSante), and how validation gates progression. Good starting point for designers and engineers who need the big picture before diving into implementation details.

Lister et récupérer des workspaces

Actions pour explorer les workspaces existants : obtenir la liste complète et récupérer les détails d'un workspace spécifique par son identifiant.

State, Context and Persistence

Architecture and patterns for keeping onboarding state consistent across pages. Covers the page-level context implementation (contexts/page.context.tsx), local page context shape (personal data, selections, file refs), strategies for serializing/deserializing context across route changes, and when to persist to backend via API mutations (create contact, submit inquiry). Includes guidance on syncing local state with server canonical state and edge cases (refresh, back/forward navigation).

Créer et mettre à jour un workspace

Créer de nouveaux workspaces et modifier leurs propriétés (nom, description, paramètres de visibilité, etc.). Bonnes pratiques pour nommage, conventions et champs modifiables.

Forms & Validation (Zod + react-hook-form)

Concrete implementation patterns for each onboarding step using react-hook-form + Zod. Explains schema placement (lib/schemas: final-schema.ts, inquiry-schema.ts, profile-schema.ts, questionnaire-budget-schema.ts), per-step validation enforcement, error display patterns, conditional fields (family data, coverage levels), and tips for composing schemas and reusing partials. Covers testability and validation-driven navigation gating.

Marquer un workspace par défaut

Procédure pour définir (ou changer) le workspace par défaut. Explication des impacts (quel workspace est utilisé par défaut pour les nouvelles ressources) et des contraintes (un seul workspace par défaut).

File Uploads & Verification Steps

End-to-end patterns for handling required document uploads and verification (ID, bank, health card) within the subscription flow. Includes client-side file validation (types, sizes), integration with S3/API constraints, how to store file references in page context, UX for verification status, and blocking rules when required documents are missing or invalid. Also covers resume/retry flows and security considerations for sensitive documents.

Supprimer un workspace et migrer les ressources

Processus de suppression d'un workspace, options pour migrer les ressources vers un workspace cible et validations nécessaires avant suppression. Inclut les scénarios d'échec et les recommandations pour la migration sécurisée des données.

Plan Selection, Subscription, Payment & Signature

Detailed guide for the offer discovery and checkout portion: browsing and filtering offers, interactive selection, plan comparison modal, final subscription step (upload documents, authorize payment), electronic signature integration, and finalization. Covers wiring UI selections into subscription payloads, payment authorization flows, and finishing steps (serializing final-schema.ts, sending subscription mutation, and next-step redirects).

Introduction & concepts

Vue d'ensemble des webhooks et du modèle événementiel : comment fonctionnent les notifications asynchrones (événements de signature, document, etc.), règles d'or à respecter (endpoints HTTPS), et quand utiliser des webhooks vs polling.

Overview — Questionnaires & Budget/Needs

High-level introduction to the budget & needs questionnaires: what they collect, how answers drive coverage gauges and offer personalization, and the end-to-end flow from opening the step to saving results.

Créer et configurer une subscription

Guide pas à pas pour créer une souscription webhook : choix de l'endpoint, sélection des événements et des scopes, validation de l'URL et bonnes pratiques de configuration.

Rendering Questions & Input Components

Implementation guidance for rendering questionnaire items and choices, UX patterns for radio/select/input fields, accessibility considerations, and handling real-time UI updates while the user answers.

Lister, consulter et gérer les subscriptions

Opérations CRUD et gestion du cycle de vie : lister les webhooks existants, récupérer les détails d'une subscription, mettre à jour (activer/désactiver) et supprimer une subscription.

Dynamic Logic & Derived Gauges

How to compute coverage/needs gauge levels from answers, rules for showing/hiding derived questions, how gauge widgets react in real time, and how derived values drive offer personalization.

Sécurité, vérification des payloads et retry automatique

Comment gérer la clé secrète, valider l'intégrité des payloads reçus, et configurer l'auto-retry (comportement de back-off et limites, jusqu'à 8 tentatives). Inclut recommandations de stockage et rotation de clé.

Validation, Schemas & Normalization (Zod)

Details on questionnaire schema design and validation with Zod: required-field enforcement, numeric field validation and normalization rules, error handling, and best practices for client- and server-side checks.

Introduction & concepts

Présentation du sceau électronique : objectifs, modèles de signature (electronic vs advanced), rôle du certificate_id, et règles techniques générales (multipart/form-data, audit trail). Idéal pour comprendre quand et pourquoi utiliser un sceau organisationnel.

Persistence & Submission

APIs and data model guidance for saving questionnaire responses: how submissions update contact and inquiry records, transaction boundaries, idempotency considerations, and computing derived budget/needs levels on submit.

Uploader et gérer les fichiers

Procédures pour envoyer les fichiers nécessaires au scellage : upload de documents à sceller, upload et gestion des images de sceau (liste, suppression). Exemples de multipart/form-data et erreurs courantes.

Plan Cards & Browsing

How plan cards are rendered and how users browse the available offers. Covers card layout, coverage summaries, navigation patterns (horizontal selector vs paginated cards), and the logic that determines which plan is preselected when a user scrolls or pages.

Créer et configurer un sceau électronique

Guide pas-à-pas pour assembler un sceau : lier document_id et image_id, définir les champs d'apposition, choisir le niveau de signature, et soumettre la requête de création du sceau. Inclut exemples de payload et mention des obligations liées au certificate_id pour les signatures avancées.

Filtering & 100% Santé Toggle

Controls and rules for filtering offers, with a focus on the classic vs 100% santé experience. Explains the isSante filter toggle, how UI elements change (imagery, badges), and how filter state affects the presented set of plans.

Téléchargements & piste d'audit

Comment récupérer les documents scellés et leurs audit trails pour archivage ou vérification : formats disponibles, téléchargement en blob, bonnes pratiques de conservation et intégrité des preuves.

Plan Comparison Modal

Design and behavior of the plan comparison modal. Includes opening patterns, layout of coverage tables, multi-plan comparisons, responsive behavior, and accessibility considerations for presenting detailed coverage information.

Créer et configurer une demande de document

Explication pas-à-pas de la création d'une demande de document destinée à un ou plusieurs signataires : champs requis (titre), champ optionnel, format de la liste signer_ids, bonnes pratiques pour le libellé et la portée de la requête.

Selection & Persistence

How users select a preferred plan and how that selection is persisted. Details the onboarding context storage, confirmation flow that writes back to the contact or inquiry, and how submission marks the contact/inquiry status as progressed to subscription.

Gérer les signataires d'une demande

Ajouter ou associer des signataires existants à une demande de document, détails sur les identifiants à utiliser, comportements attendus et validations côté API.

UX Patterns, Edge Cases & Best Practices

Guidance on UX patterns, error handling and best practices for the Offers & Plan Selection domain. Covers recommended badges, visual cues, handling missing or changing plans, performance considerations, and ensuring selection persistence across navigation and pagination.

Lister et télécharger les documents fournis

Comment récupérer la liste des fichiers uploadés par un signataire, parcourir les métadonnées retournées et télécharger un document précis. Inclut exemples de réponses, gestion des erreurs et recommandations de sécurité pour le téléchargement.

Concepts & Requirements

High-level overview of identity and document verification: what we verify, the role of third-party providers, required documents, acceptance rules, and constraints on uploads. Useful for architects and product owners to understand compliance boundaries and failure modes.

Suppression et cycle de vie des demandes et fichiers

Conséquences de la suppression d'une demande de document, options pour supprimer des fichiers fournis par des signataires, règles de conservation et recommandations pour auditer ou conserver des copies avant suppression.

Document Uploads (Subscription Step)

How to collect and store verification documents during the subscription flow: required attachments per verification type, client-side validations (size/type/format), S3 upload patterns, and UX guidance for retry/error handling when attachments are missing or invalid.

Vue d'ensemble des métadonnées de demandes

Introduction aux metadata attachées aux signature requests : concepts, cas d'usage (external_id, tags), format de stockage (dictionnaire clé→valeur) et règles de validation (types acceptés). Cette page présente les endpoints disponibles et explique comment les metadata servent à corréler la demande avec des systèmes externes.

Verification Flows & Status Handling

Client- and server-side flow for starting verifications, sending attachments to providers, tracking progress, and reacting to results. Covers calling verification APIs for ID, bank, and health-card checks, polling vs webhook models, interpreting status codes, required follow-up actions, and continuing subscription processing when verification succeeds.

Ajouter et mettre à jour des metadata

Guide pratique pour créer ou remplacer les paires clé/valeur d'une signature request. Exemples de payloads pour POST et PUT, comportements attendus (écrasement vs fusion selon l'endpoint), et validations de type (boolean, number, string).

Datakeen Provider Integration & Tests

Implementation details for the Datakeen provider integration: service locations, payload/attachment requirements, parsing Datakeen responses (card side, card type, name, dob, verification status), error handling, and the unit/spec coverage to validate integration behavior.

Lire les metadata d’une demande

Comment récupérer les metadata existantes d'une signature request. Description de la réponse JSON, exemples (récupération simple, filtrage côté client) et conseils pour utiliser les metadata afin de synchroniser ou corréler des objets avec des systèmes externes.

S3 Configuration & Initialization

Centralized configuration and bootstrapping for S3 access: where to set bucket, region and credentials, and how the backend initializes the S3 client at runtime.

Supprimer des metadata

Procédure pour supprimer les metadata associées à une signature request. Détail de l'endpoint DELETE, effets attendus (suppression totale du dictionnaire ou comportement par défaut), et recommandations de sécurité et d'audit lors de la suppression.

Uploading Files via Server Endpoints

How to accept client uploads (multipart/form-data), forward them to S3 via the backend, and return stored metadata/paths. Includes handler constraints (size/type), the upload flow, and relevant server files.

Vérification d'identité (pièces & selfie)

Guide complet pour téléverser pièces d'identité et lancer une vérification d'identité : envoi multipart des fichiers (ID front/back, selfie), soumission de la vérification et interprétation des statuts (succeeded / rejected). Inclut exemples d'appels, erreurs fréquentes et bonnes pratiques pour la capture des documents.

Vérification bancaire (RIB & coordonnées)

Procédure pour vérifier les coordonnées bancaires et RIB : format attendu, payloads, envoi de fichiers bancaires si nécessaire, endpoint POST /verify/bank, gestion des réponses et recommandations anti-fraude lors de la liaison compte-utilisateur.

Associating Files with Documents & Flows

How uploaded files are referenced inside application objects (documents, signature requests, verification flows), how metadata/path IDs are stored, and patterns for linking storage records to domain models.

Vérification carte santé & justificatifs médicaux

Comment vérifier une carte vitale ou tout justificatif médical : formats acceptés, champs à extraire, endpoint POST /verify/health, contraintes de confidentialité et conservation des preuves médicales conformément aux règles de conformité.

Downloading Files & Presigned URLs

Serving downloads securely: using server-provided paths, generating presigned URLs, and best-practice patterns for direct S3 access vs proxied downloads.

Asynchronicité, statuts & webhooks

Explication des flux asynchrones : états possibles (pending, succeeded, rejected), conception et sécurisation des webhooks, stratégies de polling, gestion des délais et reprise après erreur. Exemples de payloads de webhook et recommandations pour l'UX côté client pendant l'attente.

Implementation Details & Tests

Developer-focused reference for the S3 provider module and service, initialization code, and test coverage. Includes pointers to source files and test/spec conventions used in the project.

Envoi de fichiers, format multipart & sécurité

Spécifications techniques pour l'envoi de fichiers : multipart/form-data, limites de taille, types MIME acceptés, nommage des champs, validation côté serveur, chiffrement en transit/au repos, conservation des données et exigences KYC/CPD pour la protection des données sensibles.

Getting started — SDK initialization & configuration

How to add and configure the YouSign SDK in your project. Covers synchronous and asynchronous module initialization patterns, required credentials and base URL, factory-based configuration, runtime async configuration and the SDK entry points (api.module.ts, configuration.ts, index.ts, variables.ts). Includes examples for Nest/Node bootstrapping and common configuration pitfalls.

Protections HTTP et middlewares

Activer et configurer les protections HTTP globales (helmet, compression) pour durcir les en-têtes, optimiser les réponses et réduire la surface d’attaque. Bonnes pratiques d’intégration et tests en dev/prod.

Service reference — Auto-generated TypeScript wrappers

Detailed reference for the auto-generated TypeScript service clients (ApproverService, DocumentService, SignatureRequestService, TemplateService, WorkspaceService, etc.). How to call list/get/create/update/delete methods, handle pagination and collection formats, interpret standardized response wrappers, and integrate the SDK's HttpService. Guidance on converting between RxJS Observables and Promises and handling errors.

CORS, throttling et contrôle d’accès

Configurer les politiques CORS, définir des limites de débit globales (ThrottlerModule) pour prévenir les abus et adapter les limites par environnement ou par route.

Models & TypeScript schemas

Schema-first documentation of all TypeScript models generated from the YouSign API. Explains the model directory layout (sdk/yousign/model/*), typed request/response shapes, DTOs, union types for polymorphic fields, and best practices for using the models to build strongly-typed flows and validation layers in your application.

Intégrations cloud : S3, Mailgun, YouSign, Datakeen

Charger et centraliser les configurations pour S3, Mailgun, YouSign et Datakeen ; gestion des clients, flux asynchrones et validation des clés externes nécessaires au bon fonctionnement.

Webhooks, audit trail & async flows

Patterns and examples for integrating YouSign webhooks and audit trail downloads into your application. Includes webhook verification and security, handling asynchronous events, consuming audit trail exports, retry strategies, background processing, and using the SDK's async initialization patterns in serverless or multi-stage environments.

Variables d’environnement & démarrage

Procédures pour définir et valider les variables d’environnement critiques, utiliser ConfigModule pour l’injection sécurisée, et commandes npm pour lancer l’application en dev, prod ou watch.

Packaging, release & CI helpers

How to package, release and maintain the YouSign SDK artifacts in your projects. Covers the provided packaging helper scripts (git_push.sh), versioning, build steps, publishing tips, and CI/CD patterns for keeping the generated SDK and models in sync with API changes. Includes examples for automated regeneration and test hooks.

Atoms & UI Hooks

Reference for the smallest reusable UI pieces and client helpers: visual atoms (Badge, FloatingPhoneIcon), input atom behaviors, and utility hooks that drive responsive and date-focused input UX. Use this page to understand props, accessibility, styling tokens and how useDateInput and useIsMobile change behavior on mobile vs desktop.

Logging, monitoring et observabilité

Configurer le LoggerModule, collecter les métriques et intégrer des outils de monitoring pour assurer la robustesse opérationnelle et faciliter le diagnostic des incidents.

Connexion utilisateur

Guide pas à pas pour l'écran de connexion : navigation vers la page, saisie des identifiants et processus d'authentification initial (vérification côté serveur). Explique les erreurs courantes (identifiants invalides) et bonnes pratiques UX pour la connexion.

Form Controls & react-hook-form Integration

Detailed guide for the form input atoms and how to wire them into react-hook-form and Zod validation. Covers Input (number, email, tel, text, date), Select, RadioGroup, and the Terms checkbox with examples for controlled and uncontrolled usage, registration patterns, validation strategies, and error handling.

Gestion des jetons (JWT & Refresh)

Présentation du cycle de vie des jetons : génération d'un access token JWT et d'un refresh token à la connexion, stockage recommandé côté client, et bonnes pratiques de sécurité (durée de vie, scoped claims).

Molecules for Onboarding Flows

How to compose atoms into onboarding-specific molecules. This page documents InquiryForm, NeedsLeft/NeedsRight, OffersLeft/OffersRight, PaymentLeft/PaymentRight, ProfileForm, SignatureLeft/SignatureRight, and SubscriptionLeft/SubscriptionRight — including expected props, internal state patterns, and integration points with the overall onboarding context.

Flux de rafraîchissement

Document technique du mécanisme de refresh : comment appeler l'endpoint de rafraîchissement, format attendu, réponses possibles et gestion des erreurs (token expiré, blacklisté). Inclut exemples d'appels et stratégies de retry.

Modals & Modal Lifecycle

Complete reference for modal components (OffersDetailModal, SubscriptionProfileModal), focusing on open/close lifecycle, animations, isClosing state management, accessibility, and best practices for validating user input before mutating backend state. Includes examples for editing profile details and comparing offers within a modal.

Contrôle d'accès et guards

Explication des guards utilisés par l'API : vérification du JWT pour endpoints protégés, validation des refresh tokens, et contrôle par rôles. Inclut comportement en cas d'absence de jeton valide et politique de blacklist.

Plan Cards, File Uploads & Selection Flow

Guidance on organisms and interaction-heavy components: PlanCard organism with SVG icons (ambulance, dental, glasses, stethoscope), badge composition, floating icons, file upload preview UX (select/preview/remove, progress/status, retry), and how to wire plan selection into the onboarding flow. Covers controlled props, callbacks, and local UI-only state that must be propagated to pages or context.

Aperçu — Gestion des comptes utilisateurs

Présentation générale du domaine : objectifs, navigation vers le panneau de gestion, résumé des capacités (création, listing, consultation, mise à jour) et qui peut effectuer ces opérations.

Overview: Signature Request Metadata

What metadata is, why attach key/value pairs to signature requests, and how metadata ties business context to requests via webhooks and redirects.

Créer un utilisateur

Guide pas à pas pour ajouter un nouveau compte applicatif : navigation vers « Nouveau utilisateur », champs requis (email, mot de passe, prénom, nom, rôle), envoi du formulaire et gestion des erreurs (email dupliqué, permissions).

API: Add, Retrieve, Update & Delete Metadata

Concrete API patterns and examples for submitting, retrieving, patching/putting, and deleting metadata on a signature request.

Lister et rechercher les utilisateurs

Comment parcourir la liste des comptes : pagination, paramètres limit/skip, recherche par texte, bonnes pratiques d'UX pour la navigation et le filtrage, et cas d'utilisation courants.

Consume Metadata in Webhooks & Redirects

How metadata appears in webhook payloads and redirect URLs, and patterns for using it to perform contextual routing and business logic during webhook processing.

Consulter et modifier un utilisateur

Voir la fiche d'un utilisateur, éditer ses informations et son rôle, validations côté client/serveur, flux de sauvegarde et messages d'erreur (notamment conflit d'email), et règles d'autorisation applicables.

Best Practices, Types & Naming Rules

Guidance on value types, key naming to avoid collisions with reserved webhook keys, lifecycle considerations, and practical tips for reliable use of metadata.

Permissions et règles de validation

Règles de sécurité et de validation : contrôle d'accès basé sur le rôle, contraintes d'unicité des emails, comportement en cas d'erreur, et recommandations pour les logs/audits des actions administratives.

Commit Message Standards & Developer Scripts

Enforce consistent commit messages and provide developer-facing scripts that rely on environment credentials. Documents the commitlint configuration, how to run commitlint locally and in CI, and the conventions that keep changelogs and releases predictable.

Profil et contact

Collecte et sauvegarde des données personnelles, acceptation des CGU et création du contact. Page axée sur la saisie sécurisée du profil, validation client (schémas Zod) et blocage de la progression tant que les champs obligatoires ne sont pas validés. Permet retour pour correction avant d'avancer.

Database Initialization & Transaction Helpers

Database bootstrap and transactional helpers for reliable, idempotent initialization and atomic service operations. Covers docker entrypoint init scripts for extensions, createQueryRunner utilities, and patterns for transaction-scoped repository usage.

Questionnaire besoins & budget

Parcours dynamique de qualification des besoins et du budget via questionnaires adaptatifs. Gère la création et la mise à jour d'une inquiry liée au contact, logique conditionnelle des questions, validations côté client et possibilité de revenir en arrière pour affiner les réponses.

SDK Publishing & Centralized Configuration

Guidance for publishing generated SDKs, centralized config helpers, and automation scripts. Includes the git_push helper workflow, creating Configuration instances for SDK clients, and authentication/parameter requirements for publishing.

Affichage, comparaison et sélection d'offres

Présentation des offres et plans pertinents selon le profil et l'inquiry, outils de comparaison (prix, garanties, options) et sélection du plan final. Inclut règles de validation avant sélection et navigation linéaire avec possibilités de retour aux étapes précédentes.

Shared Core Entities, Repositories & Service Utilities

Reusable base classes and service helpers that standardize CRUD, soft-delete, timestamps, and transaction-aware repository usage across the codebase. Documents base.entity, base.interface, base.service and the create/find/update/delete helpers.

Souscription et pièces justificatives

Saisie des informations contractuelles, configuration des conditions spécifiques au contrat et téléversement des pièces justificatives (ID, RIB, carte vitale, etc.). Gestion des statuts de documents requis, validations d'étape et blocage jusqu'à complétude des pièces obligatoires.

Create a user

How to create new application accounts: required fields, assigning roles, validation rules, and the create action lifecycle (submit → persisted). Includes checks that role values match existing roles.

Paiement et signature électronique

Flux de paiement intégré (pré-autorisation ou paiement final) suivi du lancement et de la finalisation de la signature électronique des documents contractuels. Inclut gestion des états de paiement, sécurité des transactions, intégration PSP et orchestration du service de signature pour clôturer la souscription.

List and search users

List user accounts with pagination and search. Describes query parameters (limit/skip, search), expected paginated response shape, filtering tips, and performance considerations.

Parcourir les offres

Guide pour naviguer la liste des plans disponibles : affichage sous forme de cartes, gestion de pagination ou scroll infini, et comportement de persistance de la sélection dans le contexte de la page.

View and update a user

Retrieve a single user's full record and perform partial updates (name, email, password, role). Explains the view action, partial-update semantics, required role consistency, and response expectations.

Détails du plan (modal)

Que contient la fiche détaillée d'un plan et comment elle s'ouvre : ouverture en modal depuis une carte, informations affichées (prix, garanties), et actions disponibles depuis le modal.

Security and password handling

Security best practices for user administration: password hashing and storage, what is and isn't returned by APIs, and operational guidance for administrators (rotation, resets, least privilege for roles).

Comparer et sélectionner

Méthodes et bonnes pratiques pour comparer niveaux de couverture, repérer les plans recommandés et choisir le plan qui correspond le mieux aux besoins et au budget.

Contact Profile Overview

Concepts and data model for contact/prospect profiles: what a contact record contains, required fields, consent (cgu), enum fields (status, source), validation rules, and how contacts link to inquiries and documents during onboarding and application tracking.

Confirmation et suite de la souscription

Étapes finales après le choix d'un plan : confirmer la sélection, répercussions sur le prix et les informations de souscription, et navigation vers les étapes suivantes.

Create a Contact

How to create a new contact profile: required form fields, enforcing CGU consent at creation, client-side and server-side validation, expected request/response behavior, and error cases for invalid inputs.

Vue d'ensemble — Documents & Téléversements

Présentation générale du domaine : objectifs, entités (inquiry, document), cas d'usage (pièce d'identité, RIB, carte vitale, mandat de résiliation), et schéma de fonctionnement global (upload → stockage → vérification → signature). Inclut les règles principales et les responsabilités front / back.

Update Contact Details

Editing existing contact records: which fields are editable (address, phone, email, city, postal code, status, source), validation rules on update, enforcing allowed enum values, and saving/updating workflows.

Téléversement côté client (UX/API)

Guide pour l'étape Souscription : sélection de la pièce à téléverser, construction de FormData, affichage d'aperçu, suivi de l'état d'upload côté UI, et gestion locale (remplacement / suppression avant envoi). Exemples d'intégration et bonnes pratiques UX (progress bars, validations frontales).

Search and List Contacts

Listing and searching contacts with pagination and filters: supported search filters (name, email, phone, source, status, date), sorting/ordering parameters, pagination behavior, performance considerations, and how to review result sets.

Stockage backend et métadonnées (S3 + BDD)

Architecture serveur : réception multipart/form-data, validation des fichiers (extensions/tailles), envoi vers S3, schéma des métadonnées en base (chemin S3, type, taille, propriétaire, foreign key inquiry, statut, horodatages). Considérations sur résilience, versioning et conservation.

View Contact Details

Retrieve and inspect a single contact by ID: endpoint behavior, returned personal data and status, how consent is represented, timestamps and audit fields, and privacy considerations for displaying personal data.

Suivi du statut et cycle de vie des documents

Description du modèle de statuts (uploadé, en cours de vérification, validé, rejeté), transitions possibles, obligations UI (indicateurs, historique), endpoints pour consulter et mettre à jour le statut, et notifications/ webhooks pour événements critiques.

Inquiry Overview & Lifecycle

High-level summary of what an inquiry (application) is, its role as the central object for subscription completion, and the typical lifecycle from contact → inquiry creation → updates → downstream flows (documents, identity, payment, signing). Intended as the starting point for integrators and product teams.

Validation, erreurs et sécurité

Règles de validation (extensions, tailles), gestion des rejets (messages d'erreur, motifs), flux de remplacement/retry, suppression sur demande, contrôle d'accès et stockage sécurisé (ACL S3, chiffrement, accès presigné), et exigences légales/archivage.

Create an Inquiry

How to create a new inquiry tied to an existing contact. Explains required prerequisites (contactId), payload structure for coverage, needs, budget and family information, examples of API requests and expected responses, and common error cases.

Aperçu — Vérification d'identité & pièces

Présentation du service de vérification (via Datakeen) : objectifs, portée (pièce d'identité, RIB, carte vitale), modèles d'intégration et règles clés (dépendance à un service externe, correspondance des données extraites).

Update Inquiry (Partial Updates)

Guidance for modifying parts of an existing inquiry. Covers supported partial updates (needs, socialSecurityNumber, familyMember, terminationMandate), how to submit updates, concurrency considerations, and persistence behavior.

Intégration API et envoi de fichiers

Guide technique pour l'envoi des pièces au provider : endpoints API, payloads attendus, authentification, formats de fichier supportés, mécanisme d'upload depuis l'interface de souscription et gestion des erreurs réseau/temps d'attente.

Inquiry Data Model & Validation

Detailed reference for inquiry fields and types: structured data for needs, budget, family member arrays, plan selections, dateOfBirth, enumerated coverage values, and validation rules/formats. Includes allowed values, example JSON schemas, and tips for client-side validation.

Résultats : données extraites et statuts

Interpréter le retour structuré de Datakeen : types de documents détectés, champs extraits (nom, date de naissance, IBAN...), niveaux de confiance, statuts (valide/non valide) et règles de correspondance avec les données saisies.

Using Inquiry ID & Retrieval

How to use the inquiry id for downstream flows and integrations: retrieving inquiry details, uploading documents, identity verification, payment and signing steps. Includes sample GET responses and mapping of inquiry state to next actions.

Gestion des échecs et flux de correction

Procédures UX et techniques quand la vérification échoue : messages à l'utilisateur, étapes de correction et ré-envoi, règles de validation côté produit, et logique de retry/backoff vis-à-vis du provider externe.

Overview & Concepts

High-level explanation of the document upload and management domain: what documents are supported, how they relate to an inquiry, and the lifecycle and statuses tracked for each document.

Exigences de fichiers et bonnes pratiques de capture

Spécifications techniques et recommandations pour garantir une reconnaissance fiable : formats acceptés, résolution et qualité minimum, cadrage, éclairage, exemples d'images acceptables ou non, et contraintes spécifiques pour RIB et carte vitale.

Client Upload Flow (UI)

Step-by-step guide for the front-end upload experience: selecting a document type, choosing a file, multipart/form-data submission, showing upload progress, and handling success/error responses.

Formulaire de paiement côté client

Guide pour implémenter le formulaire de saisie carte côté client : champs requis, validation front-end, contraintes de format et bonnes pratiques pour éviter le stockage des données sensibles.

Document Types, Validation & Restrictions

Reference for supported document type constants, allowed MIME/file extensions, size limits and validation rules applied on both client and server to prevent invalid uploads.

Autorisation de paiement (pré-autorisation)

Décrire le flux de pré-autorisation : quand déclencher l'autorisation, appels API au fournisseur de paiement, gestion des réponses et états à conserver avant la confirmation finale.

Manage & Inspect Uploaded Documents (UI)

How users view uploaded documents, monitor statuses, preview attachments, and remove or re-upload files from the inquiry UI — including UX patterns for in-progress, error, and verified states.

Exécution du paiement (transaction finale)

Procédure pour transformer une pré-autorisation en paiement effectif : étapes de confirmation, appels de transaction finale, réception du retour transactionnel et enregistrement des références.

Backend Storage, Metadata & Lifecycle

Backend responsibilities: handling multipart uploads, writing file content to S3, persisting document metadata linked to an inquiry, status transitions, soft-delete semantics, and optional cleanup/deletion flows.

Gestion des erreurs et conformité

Catalogue des erreurs possibles (refus, timeouts, données invalides), stratégies de reprise et affichage utilisateur, règles de conformité PCI et recommandations pour ne pas stocker de données sensibles.

Overview & Concepts

High-level introduction to the E-signature (Signature Requests) domain: key concepts, lifecycle, and rules. Explains what a signature request is, when to use YouSign, the required order of operations (create → upload → add signers → activate), and important constraints such as signer/field immutability after activation and SDK validation requirements.

Prise en main : créer une demande de signature

Guide pas-à-pas pour initialiser une demande de signature via le SDK YouSign : nom, description et métadonnées. Explique le cycle de vie d'une demande et quand préparer les éléments avant activation.

Create a Signature Request

How to initialize a new signature request: required inputs, naming conventions, server-side flow, and the YouSign API call. Includes example request/response patterns, validation checks, permission considerations, and troubleshooting tips for request creation failures.

Téléversement des documents à signer

Procédure d'upload des contrats et pièces jointes associés à une demande : formats supportés, contraintes, upload via SDK et validations. Indique l'obligation d'avoir au moins un document avant activation.

Upload Documents to a Request

Instructions for uploading one or more documents into an existing signature request. Covers backend relay to YouSign document service, supported file types, size limits, multi-file handling, metadata, and best practices to ensure documents are prepared for field placement.

Gérer les signataires et les champs de signature

Comment ajouter et configurer les signataires (nom, email, rôle), définir l'ordre, et placer les champs de signature/initiales/texte sur les documents via le SDK. Bonnes pratiques pour préparer les signataires avant envoi.

Activation et envoi de la demande

Étapes finales pour activer une demande de signature et déclencher l'envoi aux signataires. Couverture des conséquences (notifications), vérifications pré-activation et exemples d'appels SDK.

Fiabilité, erreurs et bonnes pratiques SDK

Conseils pour gérer la disponibilité du service YouSign, stratégies de retry, idempotence, gestion des erreurs SDK, monitoring et reprise après incident. Règles et impacts opérationnels à connaître.

Authentification et configuration

Configurer l'accès serveur à Coog : gestion de la clé API, mécanisme d'authentification, obtention et stockage sécurisé du token, rafraîchissement et bonnes pratiques pour exécuter l'authentification en tâche serveur.

Récupération et gestion des questionnaires

Obtention de la liste des questionnaires disponibles, récupération d'un questionnaire spécifique, normalisation des réponses et de la structure vers le modèle interne CoogQuestionnaireModel, et préparation pour affichage côté client.

Parcours commercial (sales routes) Coog

Récupération des sales routes fournies par Coog, mapping vers les flux de vente internes et intégration dans les étapes de profilage et de vente pour piloter le parcours client.

Disponibilité, fallback et gestion des erreurs

Stratégies en cas d'indisponibilité de Coog : caches, données statiques de secours, retry/backoff, surveillance et alerting, et règles pour garantir la continuité des parcours lorsqu'il est impossible de récupérer dynamiquement les questionnaires.

Initialisation et configuration du SDK

Comment intégrer et configurer le client YouSign dans votre application : structure du module d'API (api.module.ts), fichier de configuration (configuration.ts) et bonnes pratiques pour initialiser et reconfigurer dynamiquement le SDK selon l'environnement ou le compte.

Utiliser les clients API générés

Guide d'utilisation des clients TypeScript générés pour appeler les endpoints YouSign (approver, archive, auditTrail, consumption, contact, customExperience, document, electronicSeal, field, follower, metadata, signatureRequest, signer, signerDocumentRequest, template, user, webhook, workspace). Exemple d'appels via HttpService avec Observable et gestion des AxiosResponse.

Modèles TypeScript et interfaces générés

Explication des modèles et interfaces générés (fichiers sous sdk/yousign/model) : navigation dans la structure, typages clés, comment les utiliser pour la validation, l'autocomplétion et la sérialisation/désérialisation des payloads.

Téléchargement et gestion des blobs

Patrons et exemples pour télécharger des ressources binaires depuis YouSign : audit trails, documents et archives. Gestion des flux, conversion de réponses Axios en fichiers téléchargeables et recommandations pour la mise en cache et le streaming.

Uploads multipart et outils d'intégration

Comment uploader des fichiers multipart/form-data (documents, images de sceau) vers YouSign, gérer les champs associés et les erreurs. Présentation des outils et scripts d'intégration fournis (git_push.sh, index re-exports) pour automatiser les mises à jour du SDK.