Journal des communications importantes
Communication partenaire API v4 - 30/09/2024
I. Passage de l'API en version 4
Une version 4 de l'API est désormais disponible en pré-production. Vous pouvez passer à la 4 en utilisant le endpoint /dfc/api/v1/settings.En pré-production, le passage sera rendu automatique le 10/10/2024 et le 05/12/2024 en production(cf. section c: le passage en v4 sera possible dès le 03/12/2024 ).
a. Suppression du champ allInternalPartnerIdL'API Partenaire permettait d'associer des identifiants partenaires aux candidats locataire. Ce champs est déprécié et sera supprimé dans cette version de l'API. Pour info, ce champ était présent dans le retour des API et du webhook au niveau du model tenant.
b. Obligation de fournir un e-mail technique de contactUn e-mail de contact technique devient requis. Il pourra être mis à jour en autonomie par les partenaires via le endpoint /dfc/api/v1/settings.Ce endpoint, sera notamment utilisé pour les alertes et les mises à jour importantes de l'application. Il sera également utile pour récupérer vos identifiants de connexion par la suite.
c. Mise à jour des sous-catégories pour les justificatifs d'hébergementCette version présente des changements majeurs, il convient de les appliquer au passage en version 4.Les nouvelles sous-catégories sont désormais:
TENANT : Locataire
OWNER : Propriétaire
GUEST : Hébergé par vos parents, par un ami, par un proche
GUEST_COMPANY : Logement de fonction
GUEST_ORGANISM : Hébergé par un organisme (hébergement d'urgence, placement)
SHORT_TERM_RENTAL : A l’hôtel, au camping ou en location de tourisme
OTHER_RESIDENCY : Dans une autre situation (sans-abri, etc...)
NB: La sous-catégorie GUEST_PARENTS disparaît et est regroupée avec GUEST.
La sous-catégorie GUEST_ORGANISM est séparée en 2 sous-catégories: GUEST_COMPANY et GUEST_ORGANISM.
Rem: Le core de l'application DossierFacile ne gère qu'une seule version à la fois. Ainsi, lors du passage de la version 3 à la version 4 en preproduction, un mapping sera assuré entre les catégories v4 et les catégories v3 le temps de la migration des partenaires. Du fait du type de modification entre les versions, ce mapping souffrira d'un manque de cohérence, la migration en production sera donc nécessaire après la mise en production (les partenaires seront automatiquement migrés en v4 2 jours après la MEP s'ils n'ont pas eux mêmes réalisés cette migration).
II. Pré-validation automatique des dossiers.
Afin d'améliorer la qualité des dossiers et pour optimiser le traitement du dossier au premier passage devant les opérateurs, nous avons mis en place une analyse automatique des dossiers. Ainsi, lors de l'ajout des pièces du dossier, certains documents sont analysés de façon asynchrone et le résultat de l'analyse est fournie dans la réponse du service au niveau des documents dans un champ documentAnalysisReport qui indique le résultat de l'analyse sur le document et les éventuels manquement détecté sur le document. (cf. endpoint /profile) Cette analyse est à titre indicative et non-systématique et ne doit pas être bloquante.
Communication partenaire Avril 2024 - 18/04/2024
Suite à notre précédente communication:
La révocation des accès partenaires est désormais accessible à nos utilisateurs.
Le passage obligatoire à l'API v3 aurait du intervenir le 06/04/2024. Le passage obligatoire sera effectif le 25/04/2024. Ce changement de version introduit de multiples modifications qui nécessitent une prise en compte: France Identité, catégories et sous-catégories des organismes garants, ...
Les nouveautés disponibles en production:
Visualisation et édition des configurations partenaires
Il est désormais possible de visualiser et d'éditer certaines information de votre configuration. Pour cela, vous devez vous connecter avec votre client et utiliser le endpoint suivant:
GET /dfc/api/v1/settings : Pour la visualisation
PATCH {baseurl}/dfc/api/v1/settings : Pour l'édition de la version et de l'adresse du webhook.
Vous pouvez retrouver cette information dans notre documentation: DossierFacile Connect | Edition
Nouveau webhook envoyé lors du changement de applicationType
Précédemment, le changement de type d'application du dossier (seul, en couple, en colocation) ne générait pas d’envoi de webhook (y compris pour les dossiers déjà validés ou refusé). Désormais, un webhook ayant le type APPLICATION_TYPE_CHANGED est envoyé lors de cette modification. Vous pouvez retrouver cette information dans notre documentation: DossierFacileConnect | Webhook
Lien vers la page du dossier utilisateur
En complément du lien vers le documents pdf (nécessitant un appel POST), il y a désormais un lien vers la page de résumé du dossier du candidat validé. Ce champ est présent dans le retour du webhook et des appels API. L'url est situé dans le champ "dossierUrl".
Vous pouvez retrouver cette information dans notre documentation: DossierFacileConnect | Webhook
Expérimentation de la pré-validation automatique
Nous expérimentons une fonctionnalité de pré-validation automatique qui nous permettra d'informer immédiatement le candidat d'éventuelles incohérences dans ses documents sans bloquer l'envoi de ceux-ci. Pour chaque document (documentIdentification, documentResidency, ...) qui a pu être identifié et analysé, nous présentons un résultat d'analyse dans le champ "documentAnalysisReport".
Cette expérimentation étant en cours, elle pourrait évoluer sans préavis. Nous vous informerons de sa pérennisation afin que vous puissiez l'exploiter dans les prochains mois.
Communication partenaire API v3 - 06/02/2024
I. Révocation des accès partenaires
A partir du 06/04/2024, les utilisateurs auront la possibilité via notre interface de révoquer l’accès à leur dossier qu’ils auraient donné à un partenaire (DFConnect ou API). Dans ce cas, les partenaires concernés recevront un nouveau type de webhook ACCESS_REVOKED, par le même biais que les webhook existants.
Par exemple :
Après l’envoi de ce message, l’accès aux données de cet utilisateur ne sera plus autorisé.
II. Passage de l'API en version 3
Une version 3 de l'API est désormais disponible, apportant les changements décrits ci-dessous. Vous utilisez actuellement la version 2, et pouvez demander de passer à la 3 lorsque vous aurez effectué les modifications nécessaires (en écrivant à devs@dossierfacile.fr). En préproduction, le passage en v3 se fera le 20/02/2024. En production, l'utilisation de cette version sera rendue obligatoire à partir du 06/04/2024.
a. Nouveau justificatif d'identité
Une nouvelle sous-catégorie FRANCE_IDENTITE fait son apparition parmi les documents d’identité (catégorie IDENTIFICATION). Elle correspond au justificatif délivré par le service https://france-identite.gouv.fr/.
En version 2, cette sous-catégorie n'existant pas, la valeur retournée dans ce cas sera OTHER_IDENTIFICATION.
b. Changements pour les documents d'organismes garants
Pour les garants de type ORGANISM, certains changements ont eu lieu au niveau du document associé :
La catégorie du document est désormais GUARANTEE_PROVIDER_CERTIFICATE et non plus IDENTIFICATION
Il existe une nouvelle sous-catégorie VISALE (qui correspond spécifiquement à la garantie Visale)
La sous-catégorie CERTIFICATE_VISA a été renommée en OTHER_GUARANTEE (qui englobe toutes les autres garanties)
Le endpoint utilisé actuellement pour uploader ce document va être décommissionné :
Il faudra maintenant utiliser l'endpoint suivant, en ajoutant au formulaire la sous-catégorie choisie (VISALE ou OTHER_GUARANTEE) dans un champ typeDocumentCertificate.
Last updated