API Partenaire | FAQ

L'utilisateur doit-il avoir un compte DossierFacile au préalable ?

Non. À l'inverse du DossierFacile Connect, vous créez un DossierFacile avec les informations dont vous disposez déjà dans votre base de données. L'utilisateur n'a donc rien à faire.

Il faut que l’utilisateur ait conscience que ses pièces vont être vérifiées par un tiers, qu'il a un compte créé chez DossierFacile et qu'il a la possibilité d'utiliser son DossierFacile ailleurs que sur votre plateforme

Comment cela se passe-t-il quand il y a un problème avec une pièce ?

Vous pouvez intégrer à votre front la messagerie présente dans l'espace personnel de l'utilisateur. Ainsi, il reçoit les modifications demandées sur chacune des pièces par ce biais.

La liste des pièces demandées est-elle modifiable ?

Oui et non. Vous devez à minima demander les 5 catégories de DossierFacile (justificatif d'identité, justificatif de domicile, justificatif de situation professionnelle, justificatif de ressources, avis d'imposition). Dans chacune des catégories, un seul type de document est autorisé sauf pour le justificatif de ressources ou l'utilisateur à la possibilité de renseigner diverses sources de revenus et donc "d'ajouter un revenu" par type de ressources.

L'ajout d'autres catégories ne feront pas l'objet d'une vérification par DossierFacile

Comment savoir qu'un dossier est encore à jour ?

Vous avez accès à la date de la dernière mise à jour du dossier par l'utilisateur. Dès lors que la personne ayant un dossier validé, opère une modification sur l'une de ces pièces justificatives, l'ensemble de son dossier est à nouveau vérifié (le statut du dossier passe alors en TO_PROCESS)

Les documents doivent-ils être stockés dans notre application ?

Non, pas forcément. Les documents que vous fournissez à DossierFacile sont dans tous les cas enregistrés. Seule la version filigrané (et/ou miniaturisé) sera consultable. Vous n'avez donc pas l'obligation de les sauvegarder.

Que se passe-t-il si l'utilisateur a déjà constitué son DossierFacile ?

Il faudra réaliser une connexion DossierFacile Connect pour récupérer les documents de l'utilisateur.

Quand il y a une modification sur un document, est-ce pris en compte du côté de DossierFacile ?

Oui, nous régénérons le PDF filigrané. De votre côté vous avez la main pour piloter l'ensemble des documents : ceux mis à jour ou les anciens et vous pouvez décider de supprimer ou non tel ou tel document.

Est-ce que nous avons accès au back-office en préprod ?

L'API qu'utilisent les opérateurs pour valider les dossiers n'est pas accessible aux partenaires. Toutefois, un accès partiel et temporaire peut être accordé sur demande, nous vous invitons à mocker les réponses lorsque cet accès vous est fourni car celui-ci reste temporaire.

Quelles sont les possibilités pour typeDocumentXXX pour chacun des flux de l'API ?

Une liste des catégorie est fournies avec des descriptionsdans la section DossierFacile Connect (cf.FAQ). Les categories correspondant au typeDocument sont les suivantes:

• documentIdentification : IDENTIFICATION

• documentResidency : RESIDENCY

• documentProfessional : PROFESSIONAL

• documentFinancial : FINANCIAL

• documentTax : TAX

Faut-il préciser la sous-catégorie typeDocumentXXX sur mon site ?

Oui, il est nécessaire de bien préciser la sous-catégorie pour permettre la validation du dossier.

Comment ajouter/modifier un type de document et comment ajouter/supprimer des fichiers?

Pour ajouter un type de document, vous devez faire appel aux endpoints: {}/api-partner/register/documentXXX Ce endpoint vous permet également d'ajouter d'autres fichiers en re-précisant le contenu du formulaire.

Pour le type de document FINANCIAL, il faut penser à préciser l'id qui est retourné pour ne pas créer un nouveau type de document car il peut y avoir plusieurs type de document identiques (Par exemple plusieurs type revenu).

Pour supprimer des fichiers d'un document: {}/api-partner/tenant/{tenantId}/file/{id} Pour supprimer le document complet: {}/api-partner/tenant/{tenantId}/document/{id}

Je vois comment ajouter un garant et ces pièces mais je ne vois pas comment ajouter son nom/prénom, comment dois-je faire ?

Il s'agit de la méthode suivante. Attention au type de garant (physique, moral, organisme).

POST https://{}/api-partner/register/guarantorNaturalPerson/name

Comment les webhooks fonctionnent-ils ?

Les webhooks sont déclenchés lors de certains événements de changement de statuts du candidat et appellent une URL que vous devez fournir. Ils renverront un JSON qui selon le type de webhook peut avoir des informations différentes mais qui est dans le cas usuel équivalent à la réponse du endpoint /profile du dossier

Comment les messages fonctionnent-ils ?

Les messages utilisent les méthodes suivantes.

GET https://{}/api-partner/tenant/{tenant-id}/message

POST https://{}/api-partner/tenant/{tenant-id}/message

Je n'arrive pas à accéder aux API dans Swagger.

Attention à choisir le bon sous menu dans le swagger : https://api-preprod.dossierfacile.fr/swagger-ui/index.html

D'autres questions?

Nous vous invitons à consulter la page FAQ de DossierFacile Connect qui contient peut-etre la réponse que vous cherchez.

N'hésitez pas également à faire des tests de parcours à la main sur locataire-preprod.dossierfacile.fr, la logique de l'API respecte exactement la logique de notre frontend en termes de séquences.