🔑
API
Difficulté d'intégration : 7/10

Prérequis techniques

    Avoir un espace login sur votre plateforme pour les utilisateurs,
    Avoir un front (ou être en capacité de le développer) qui ait les mêmes fonctionnalités que le nôtre : uploader les documents et échanger avec les utilisateurs

Visionner la présentation technique par le développeur

En quoi consiste l'intégration de notre API ?

En intégrant notre API, vous bénéficierez de la vérification par DossierFacile de dossiers déposés par vos clients candidats locataires sur votre plateforme.
C'est vous qui créez un compte relié à DossierFacile pour lui avec l'ensemble des documents qu'il vous a transmis. L'utilisateur n'a aucun contact direct avec DossierFacile et c'est vous qui gérez toutes les relations avec ce dernier. Vous devez donc l'informer à toutes les étapes de son dossier : de sa création à sa vérification puis sa validation.
Les opérateurs DossierFacile vérifient les documents et vous avez accès à l'ensemble des informations du candidat locataire.

Parcours utilisateur

Visionner la présentation technique par le développeur

Conditions juridiques

Convention de sous-traitance RGPD

Il vous sera demandé de nous retourner la convention de sous-traitance RGPD ci-dessous remplie et signée avant l'intégration de l'API sur votre plateforme.
Le modèle sera fourni prochainement.

Obligations d'information des utilisateurs

Les utilisateurs dont le dossier nous est transmis devront être informés :
    que leurs pièces sont transmises et vérifiés à un service tiers
    que ce service est proposé par l'Etat
    qu'ils peuvent partager leur DossierFacile en-dehors de votre plateforme
L'utilisation de l'API étant offerte, le service de vérification ne pourra en aucun cas être proposé comme une option payante à l'utilisateur.

Lien vers le swagger de l'API

Swagger UI

Testez l'API avec Postman

API Partenaire DossierFacile est un système vous permettant de créer et modifier un dossier de location DossierFacile pour vos utilisateurs directement sur votre plateforme. Il permet également de mettre en place un webhook vous indiquant quand le statut d’un dossier change.
Ce tutoriel décrit les différentes étapes de l’utilisation via Postman.
L’objectif de l’opération est de dérouler toutes les étapes nécessaires à la création d’un dossier de location DossierFacile au statut “TO PROCESS” qui sera alors étudié par nos opérateurs et contrôles automatiques.

1 - Configuration de l’authentification dans Postman

Configurez l’authentification de Postman en Oauth 2.0 puis configurez un nouveau token avec les valeurs suivantes.
Token Name
oauth2 keycloack
Grant Type
Client Credentials
Access Token URL
https://sso-preprod.dossierfacile.fr/auth/realms/dossier-facile/protocol/openid-connect/token
Client ID
api-partner-test-client
Client Secret
db471104-f614-41dd-9131-2511737eea50
Scope
openid
State
Client Authentication
Send as Basic Auth header
Cliquez ensuite sur Get New Access Token puis sur Use Token

2 - Utilisation de l’API Partner

Utilisez https://api-dev.dossierfacile.fr/swagger-ui/?urls.primaryName=API%20Partner afin de créer et compléter de nouveaux comptes utilisateurs.

3 - Optionnel 2 : Webhook

Il est possible de configurer un webhook afin qu’une fois qu’un utilisateur s’est logué à DossierFacile depuis votre plateforme, vous receviez les changements de statuts de son dossier. Veuillez contacter l’équipe de Dossier Facile pour la mise en place de ce webhook.

4- Cas d’usage : création d’un compte de bout en bout

Séquence des appels API :

{{url}}/api-partner/register/account
{{url}}/api-partner/register/names
{{url}}/api-partner/register/application
{{url}}/api-partner/register/documentIdentification
{{url}}/api-partner/register/documentResidency
{{url}}/api-partner/register/documentProfessional
{{url}}/api-partner/register/documentFinancial
{{url}}/api-partner/register/documentTax
{{url}}/api-partner/register/guarantorType (optionnel)

Documents du garant en fonction de son type :

    1.
    Cas d’un garant personne physique
{{url}}/api-partner/register/guarantorNaturalPerson/documentIdentification
{{url}}/api-partner/register/guarantorNaturalPerson/documentResidency
{{url}}/api-partner/register/guarantorNaturalPerson/documentProfessional
{{url}}/api-partner/register/guarantorNaturalPerson/documentFinancial
{{url}}/api-partner/register/guarantorNaturalPerson/documentTax
2. Cas d’un garant organisme
{{url}}/api-partner/register/guarantorOrganism/documentIdentification
3. Cas d’un garant personne morale
{{url}}/api-partner/register/guarantorLegalPerson/documentIdentification
{{url}}/api-partner/register/guarantorLegalPerson/documentRepresentanIdentification
{{url}}/api-partner/register/honorDeclaration
Le dossier est alors terminé et soumis à validation

💡
Pensez à mettre à jour vos CGU 😉 !

Prendre rendez-vous pour plus d'informations

Last modified 5d ago