Gérer les demandes de modification de coordonnées destinataire depuis l’API

Automatisez, via l’API, la modification des coordonnées des destinataires proposée à vos clients. Augmentez ainsi le taux d’AR de vos envois et proposez une solution rapide et simple pour permettre aux destinataires d’ouvrir leur courrier recommandé électronique.

1. Contexte

L’envoi d’un courrier recommandé électronique eIDAS impose la vérification d’identité du destinataire du courrier. Le destinataire est amené à transmettre une pièce d’identité lors de cette vérification afin de s’assurer de la bonne identité de la personne qui souhaite réceptionner le courrier.
Une comparaison du nom présent sur la pièce d’identité avec le nom apposé sur le courrier recommandé électronique est effectué lors de la vérification d’identité du destinataire. Il peut arriver qu’une différence entre les deux noms surviennent pour diverses raisons :

• un nom marital qui n’apparaît pas sur la pièce d’identité
• une erreur de saisie des coordonnées du destinataire …

Lorsque ce cas de figure survient, AR24 va notifier l’expéditeur du courrier de cette différence entre les informations analysées sur la pièce d’identité et les coordonnées entrées par l’expéditeur. L’expéditeur peut alors effectuer deux actions sur le courrier :

• Autoriser une modification des coordonnées du destinataire sur son courrier recommandé pour qu’elles correspondent aux données présentes sur la pièce d’identité transmise par le destinataire. Le destinataire pourra alors accéder immédiatement à son courrier et connaître l’identité de l’expéditeur.
• Refuser la modification des coordonnées du destinataire de son courrier recommandé. Le destinataire sera alors notifié de ce refus et sera invité à transmettre une pièce d’identité avec les coordonnées entrées par l’expéditeur lors de l’envoi du courrier recommandé

2. Lister les demandes de modification des coordonnées destinataire en cours

Vous avez la possibilité de lister toutes les demandes de modification des coordonnées destinataire d’un expéditeur donné via la route /api/mail_recipients_update/list.

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : l’identifiant utilisateur AR24, expéditeur des courriers recommandés

Vous obtenez alors un retour de notre API avec le statut SUCCESS et la liste des demandes de modification de coordonnées destinataire.
Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://developers.ar24.fr/doc/#get-list-all-recipient-update-for-a-specific-user

3. Accepter une demande de modification des coordonnées destinataire

Vous avez la possibilité d’accepter une demande de modification des coordonnées destinataire via la route /api/mail_recipients_update/valid.

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : l’identifiant utilisateur AR24, expéditeur des courriers recommandés
• id_recipient_update : l’identifiant de la modification des coordonnées destinataire obtenu depuis la liste des demandes de modification des coordonnées destinataire

Vous obtenez alors un retour de notre API avec le statut SUCCESS et le destinataire du courrier recevra un email de notre part pour le notifier de cette mise à jour. Le destinataire pourra alors accuser réception de son courrier.
Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://developers.ar24.fr/doc/#post-validate-a-recipient-update

4. Refuser une demande de modification des coordonnées destinataire

Vous avez la possibilité d’accepter une demande de modification des coordonnées destinataire via la route /api/mail_recipients_update/refuse.

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : l’identifiant utilisateur AR24, expéditeur des courriers recommandés
• id_recipient_update : l’identifiant de la modification des coordonnées destinataire obtenu depuis la liste des demandes de modification des coordonnées destinataire

Vous obtenez alors un retour de notre API avec le statut SUCCESS et le destinataire du courrier recevra un email de notre part pour le notifier de cette mise à jour. Le destinataire sera invité à nous transmettre une nouvelle pièce d’identité portant le nom présent sur le courrier recommandé.
Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://developers.ar24.fr/doc/#post-refuse-a-recipient-update

5. Être informé d’une demande de modification des coordonnées grâce aux webhooks de l’API

Si lors de l’envoi de votre courrier recommandé électronique eIDAS vous avez rempli le paramètre webhook ou si votre API possède une URL globale pour les webhooks ; vous serez automatiquement notifié d’une demande de modification des coordonnées destinataire du courrier.

Un appel sera fait sur le lien du webhook transmis avec les paramètres suivants :

• new_state avec la valeur recipient_update
• id_mail avec l’identifiant unique du recommandé électronique associé à la demande de modification de coordonnées destinataire en cours

Avec l’identifiant du courrier recommandé électronique, vous pourrez facilement obtenir toutes les informations de la demande de modification de coordonnées destinataire en appelant la route /api/mail. Dans le résultat obtenu, les informations importantes seront disponibles dans l’attribut recipient_update. Cet attribut contient un tableau des modifications de coordonnées destinataire du courrier recommandé électronique. Vous y trouverez les informations suivantes :

• id_recipient_update : le numéro unique de la modification des coordonnées destinataire. Il vous permettra d’accepter ou refuser la demande comme expliqué aux points 3 et 4 de cette page
• date : la date de demande de la modification des coordonnées destinataire
• status : le statut de la demande. Il peut prendre la valeur pending, accepted ou refused
• new_to_firstname (optionnel) : le nouveau nom proposé dans la demande
• new_to_lastname (optionnel) : le nouveau prénom proposé dans la demande
• new_to_company (optionnel) : la nouvelle société proposée dans la demande