Modification du libellé d’un document de consentement

  • Mis à jour le May 12, 2026
  • Publié le Apr 27, 2026
  • 10 Minute(s) lue(s)
Prev Next

Java SDK

Un document de consentement est un document utilisé pour confirmer qu'une personne accepte les termes de la transaction et souhaite poursuivre la procédure.

OneSpan Sign inclut automatiquement l'accord de consentement aux divulgations électroniques et aux signatures dans toutes ses transactions. Tous les signataires doivent accepter les termes de cet accord avant de pouvoir accéder aux documents de transaction.

Cette section explique comment modifier la formulation du document de consentement électronique.

Le libellé du document de consentement peut être mis à jour des manières suivantes :

  1. De manière indépendante, par transaction. Cela vous permet de modifier manuellement la formulation du document de consentement pour une transaction spécifique, quel que soit le langage réel de la transaction.

  2. Automatiquement, pour correspondre au langage de la transaction. Dans cette optique, le libellé du document de consentement est automatiquement mis à jour si le langage de la transaction est modifié.

Utilisez cette méthode lorsque vous souhaitez changer la langue du document de consentement par défaut indépendamment de la langue de la transaction.

Voici quelques exemples de code qui peuvent vous aider à faire cela :

// Create payload to localize existing consent document
ConsentLocalizationPayload localizationPayload = new ConsentLocalizationPayload.Builder()
    .withLanguage(LocaleConverter.convertToString(Locale.FRENCH))
    .build();
  
try {
    // Executes a single POST against the localize-consent REST endpoint 
    ConsentLocalizationData consentLocalizationData = eslClient.getPackageService().localizeDefaultConsentDocument(packageId, localizationPayload);
} catch (EslServerException exception) {

            // Example of handling the most common request errors  
            ServerError serverError = exception.getServerError();
            
            // Handle HTTP 409 with a common business case: The consent document cannot be updated because the associated transaction includes at least 1 signer who has already accepted consent.
            if (HttpStatus.SC_CONFLICT == serverError.getCode()) {
                log.warn("Document Consent modification is not allowed for the specified transaction: " + serverError.getMessage());
            }
            // Handle HTTP 422 with possible reasons:
            else if (HttpStatus.SC_UNPROCESSABLE_ENTITY == serverError.getCode()) {
                // - No consent template configuration for the requested language
                if ("error.unprocessableEntity.defaultConsent.i18nConfiguration.notFound".equals(serverError.getMessageKey())) {
                    log.warn(serverError.getMessage() + " To enable consent configuration for the specified language contact our Support Team.");
                }
                // - No default document consent for the requested transaction
                // - Operation is requested for a non-default document consent
                else {
                    log.warn(serverError.getMessage());
                }
            }
}

Une fois réussi à être complété, le processus renvoie l'état linguistique à la fois pour le paquet et le document de consentement. Si le processus n'est pas mené à bien avec succès, voici une liste d'erreurs possibles :

Code

Clé de message

Description de l'erreur

400

error.validation.defaultConsent.unsupportedLanguage

Valeur de langage invalide/non prise en charge

401

N/A

Erreur non autorisée

403

error.forbidden.cannotEditDeletePkg

Erreur d'accès refusé

404

error.validation.packageDoesNotExist

Erreur de transaction non trouvée

409

error.conflit.defaultConsentement.accepté

Le consentement par défaut au document ne peut pas être mis à jour : la transaction compte au moins un signataire avec un consentement accepté

422

  1. error.unprocessableEntity.defaultConsent.i18nConfiguration.notFound

  2. error.unprocessableEntity.defaultConsent.notExist

  3. error.unprocessableEntity.defaultConsent.notUsed

  1. Aucune configuration de modèle de consentement pour la langue demandée. Pour permettre la configuration du consentement pour la langue spécifiée, contactez notre équipe de support.

  2. Aucun consentement par défaut aux documents pour la transaction demandée

  3. L'opération est demandée pour obtenir un consentement non par défaut au document

500

N/A

Erreur interne du serveur

Vous pouvez configurer votre compte pour qu'il modifie automatiquement le document de consentement afin qu'il corresponde au langage de la transaction. Dans cette optique, le libellé du document de consentement est automatiquement mis à jour si le langage de la transaction est modifié.

Voici quelques exemples de code qui peuvent vous aider à faire cela :

// Giving: there is existing DocumentPackage sdkPackage to update
// Change the transaction language as a part of transaction update operation
sdkPackage.setLanguage(Locale.FRENCH);
// Update package and syncronize consent document language with transaction language
PackageUpdateWorkflowResult result = eslClient.getPackageService().updatePackageAndLocalizeConsent(packageId, sdkPackage);

Si le processus n'est pas mené à bien avec succès, voici une liste d'erreurs possibles :

PackageUpdateWorkflowResult.ConsentInfo.Status

PackageUpdateWorkflowRésultat.ConsentInfo.Message

SAUTÉ

La modification par défaut du consentement au document n'est pas autorisée : la transaction compte au moins un signataire ayant accepté le consentement par défaut.

SAUTÉ

La localisation par consentement n'est pas requise car le langage n'a pas changé.

SAUTÉ

La localisation du consentement n'a pas pu être déterminée : updatedPackage n'est pas disponible.

ÉCHEC

Échec à localiser le consentement par défaut : Le consentement par défaut au document n'existe pas.

ÉCHEC

Échec à localiser le consentement par défaut : La modification par défaut du document de consentement n'est pas autorisée : aucune configuration de modèle de consentement localisée trouvée.

ÉCHEC

Échec à localiser le consentement par défaut : Le consentement par défaut au document n'est pas utilisé.

.NET SDK

Un document de consentement est un document utilisé pour confirmer qu'une personne accepte les termes de la transaction et souhaite poursuivre la procédure.

OneSpan Sign inclut automatiquement l'accord de consentement aux divulgations électroniques et aux signatures dans toutes ses transactions. Tous les signataires doivent accepter les termes de cet accord avant de pouvoir accéder aux documents de transaction.

Cette section explique comment modifier la formulation du document de consentement électronique.

Le libellé du document de consentement peut être mis à jour des manières suivantes :

  1. De manière indépendante, par transaction. Cela vous permet de modifier manuellement la formulation du document de consentement pour une transaction spécifique, quel que soit le langage réel de la transaction.

  2. Automatiquement, pour correspondre au langage de la transaction. Dans cette optique, le libellé du document de consentement est automatiquement mis à jour si le langage de la transaction est modifié.

Utilisez cette méthode lorsque vous souhaitez changer la langue du document de consentement par défaut indépendamment de la langue de la transaction.

Voici quelques exemples de code qui peuvent vous aider à faire cela :

try 
{
    // Executes a single call against the localize-consent REST endpoint
    result = ossClient.LocalizeConsent(packageId, "fr");
}
catch (OssServerException e)
{
    // Example of handling the most common request errors
    ServerError serverError = e.ServerError;

    // Handle HTTP 409: The consent document cannot be updated because at least one signer has already accepted consent
    if (serverError.Code == 409)
    {
        // Log a warning for business case conflict
        Console.WriteLine("Document Consent modification is not allowed for the specified transaction: " + serverError.Message);
    }
    // Handle HTTP 422: Unprocessable Entity
    else if (serverError.Code == 422)
    {
        // No consent template configuration for the requested language
        if ("error.unprocessableEntity.defaultConsent.i18nConfiguration.notFound".Equals(serverError.MessageKey))
        {
            Console.WriteLine(serverError.Message + " To enable consent configuration for the specified language contact our Support Team.");
        }
        // Other unprocessable entity cases
        else
        {
            Console.WriteLine(serverError.Technical);
        }
    }
    else {
        Console.WriteLine(serverError.Technical);
    }
}

Une fois réussi à être complété, le processus renvoie l'état linguistique à la fois pour le paquet et le document de consentement. Si le processus n'est pas mené à bien avec succès, voici une liste d'erreurs possibles :

Code

Clé de message

Description de l'erreur

400

error.validation.defaultConsent.unsupportedLanguage

Valeur de langage invalide/non prise en charge

401

N/A

Erreur non autorisée

403

error.forbidden.cannotEditDeletePkg

Erreur d'accès refusé

404

error.validation.packageDoesNotExist

Erreur de transaction non trouvée

409

error.conflit.defaultConsentement.accepté

Le consentement par défaut au document ne peut pas être mis à jour : la transaction compte au moins un signataire avec un consentement accepté

422

  1. error.unprocessableEntity.defaultConsent.i18nConfiguration.notFound

  2. error.unprocessableEntity.defaultConsent.notExist

  3. error.unprocessableEntity.defaultConsent.notUsed

  1. Aucune configuration de modèle de consentement pour la langue demandée. Pour permettre la configuration du consentement pour la langue spécifiée, contactez notre équipe de support.

  2. Aucun consentement par défaut aux documents pour la transaction demandée

  3. L'opération est demandée pour obtenir un consentement non par défaut au document

500

N/A

Erreur interne du serveur

Vous pouvez configurer votre compte pour qu'il modifie automatiquement le document de consentement afin qu'il corresponde au langage de la transaction. Dans cette optique, le libellé du document de consentement est automatiquement mis à jour si le langage de la transaction est modifié.

Voici quelques exemples de code qui peuvent vous aider à faire cela :

// Giving: there is existing DocumentPackage with packageId to update
// Change the transaction language as a part of transaction update operation
packageToUpdate = PackageBuilder.NewPackageNamed(UPDATED_PACKAGE_NAME)
                   .WithLanguage(CultureInfo.GetCultureInfo("fr"))
                   .Build();
// Update package and syncronize consent document language with transaction language                   
PackageUpdateWorkflowResult updateWorkflowResult = ossClient.UpdatePackageAndLocalizeConsent(packageId, packageToUpdate);

Si le processus n'est pas mené à bien avec succès, voici une liste d'erreurs possibles :

PackageUpdateWorkflowResult.ConsentInfo.Status

PackageUpdateWorkflowRésultat.ConsentInfo.Message

SAUTÉ

La modification par défaut du consentement au document n'est pas autorisée : la transaction compte au moins un signataire ayant accepté le consentement par défaut.

SAUTÉ

La localisation par consentement n'est pas requise car le langage n'a pas changé.

SAUTÉ

La localisation du consentement n'a pas pu être déterminée : updatedPackage n'est pas disponible.

ÉCHEC

Échec à localiser le consentement par défaut : Le consentement par défaut au document n'existe pas.

ÉCHEC

Échec à localiser le consentement par défaut : La modification par défaut du document de consentement n'est pas autorisée : aucune configuration de modèle de consentement localisée trouvée.

ÉCHEC

Échec à localiser le consentement par défaut : Le consentement par défaut au document n'est pas utilisé.

REST API

Un document de consentement est un document utilisé pour confirmer qu'une personne accepte les termes de la transaction et souhaite poursuivre la procédure.

OneSpan Sign inclut automatiquement l'accord de consentement aux divulgations électroniques et aux signatures dans toutes ses transactions. Tous les signataires doivent accepter les termes de cet accord avant de pouvoir accéder aux documents de transaction.

Vous pouvez configurer votre compte pour qu'il modifie automatiquement le document de consentement afin qu'il corresponde au langage de la transaction. Dans cette optique, le libellé du document de consentement est automatiquement mis à jour si le langage de la transaction est modifié.

Voici quelques exemples de code qui peuvent vous aider à faire cela :

Requête HTTP

 POST `/api/packages/{packageId}/documents/localize-consent`

En-têtes HTTP

Accept: application/json 
Content-Type: application/json 
Authorization: Basic api_key

Paramètres de chemin

Paramètre

Type

Obligatoire

Description

packageId

Corde

Oui

L'identifiant de transaction cible.

Charge utile de demande

{
  "language": "fr"
}

Table des charges utiles de requêtes

Pour une description complète de chaque champ, voir le tableau des charges utiles de demande ci-dessous.

Propriété

Type

Obligatoire

Par défaut

Valeurs d'échantillonnage

Description

Langue

Corde

Oui

N/D

en, fr

Code linguistique utilisé pour localiser le document de consentement par défaut. Ça doit être non blanc.

Charge utile de réponse

{
  "consentId": "default-consent",
  "consentMetadata": {
    "packageInfo": {
      "uid": "71c3b7f0-1f2b-4a54-9f62-2fb6c2df6e2b",
      "language": "fr"
    },
    "properties": {
      "accountId": "acc_0011223344",
      "language": "fr"
    },
    "document": {
      "accountId": "acc_0011223344",
      "language": "en"
    }
  },
  "alerts": [
    {
      "severityLevel": "WARNING",
      "code": "warning.defaultConsent.language.mismatch",
      "defaultMessage": "The consent title language 'fr' doesn't match the consent document language 'en'.",
      "parameters": {
        "titleLanguage": "fr",
        "documentLanguage": "en"
      }
    }
  ]
}

Table des charges utiles de réponse

Propriété

Type

Description

consentId

string

L'identifiant du document de consentement localisé (pour le consentement par défaut, il s'agit généralement de « consentement par défaut »).

consentMétadonnées

Objet

Les métadonnées décrivant le paquet et les ressources localisées.

consentMetadata.packageInfo

object

Identifiant de paquet + langue de paquet.

consentMetadata.packageInfo.uid

Corde

L'UID du paquet.

consentMetadata.packageInfo.language

Corde

Le langage du package au moment de la localisation.

consentMétadonnées.propriétés

Objet

Métadonnées pour la ressource de consentement des « propriétés ».

consentMetadata.properties.accountId

Corde

Identifiant de compte propriétaire de la ressource.

consent : Metadata.properties.language

Corde

Langage pour la ressource des propriétés.

consentMetadata.document

Objet

Métadonnées pour la ressource de consentement au document.

consentMetadata.document.accountId

Corde

Identifiant de compte propriétaire de la ressource.

consent : Metadata.document.language

Corde

Langage pour la ressource documentaire.

alertes

Tableau

Alertes système optionnelles (peuvent être omises ou vides). Généralement renvoyée si une condition d'avertissement est détectée (par exemple, un décalage linguistique).

Si le processus n'est pas mené à bien avec succès, voici une liste d'erreurs possibles :

Code

Clé de message

Description de l'erreur

400

error.validation.defaultConsent.unsupportedLanguage

Valeur de langage invalide/non prise en charge

401

N/A

Erreur non autorisée

403

error.forbidden.cannotEditDeletePkg

Erreur d'accès refusé

404

error.validation.packageDoesNotExist

Erreur de transaction non trouvée

409

error.conflit.defaultConsentement.accepté

Le consentement par défaut au document ne peut pas être mis à jour : la transaction compte au moins un signataire avec un consentement accepté

422

  1. error.unprocessableEntity.defaultConsent.i18nConfiguration.notFound

  2. error.unprocessableEntity.defaultConsent.notExist

  3. error.unprocessableEntity.defaultConsent.notUsed

  1. Aucune configuration de modèle de consentement pour la langue demandée. Pour permettre la configuration du consentement pour la langue spécifiée, contactez notre équipe de support.

  2. Aucun consentement par défaut aux documents pour la transaction demandée

  3. L'opération est demandée pour obtenir un consentement non par défaut au document

500

N/A

Erreur interne du serveur