API | 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 sur notre API ?

Non, pas forcément. Les documents que vous fournissez à DossierFacile sont dans tous les cas enregistrés sur notre base de données. Vous n'avez donc pas l'obligation de les sauvegarder.

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

Actuellement, il lui faudra redéposer les pièces justificatives sur votre plateforme.

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 watermarké. 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 ?

Non. L'API qu'utilisent les opérateurs pour valider les dossiers n'est pas accessible aux partenaires.

Peut-on récupérer les identifiants Postman ?

Oui ! Écrivez à un membre de l'équipe ou au support pour être mis en relation avec un développeur. Échanger avec un membre de l'équipe

À partir de quel moment l'URL du dossier renvoyé dans le webhook correspond-elle à un document PDF ?

Quand un locataire complète son dossier, le wehook renvoyé contient une URL d'accès au dossier PDF qui a la forme suivante :
https://api.dossierfacile.fr/api/application/fullPdf/xxxxxxxxxxxxxxx
Ce lien renvoie une erreur tant que le dossier n'est pas validé (statut VALIDATED).
Format de l'erreur :
{"status":"EXPECTATION_FAILED","message":"Some tenants are not yet validated or have null pdf documents in apartment sharing with token [xxxxxxxxxxxxxxxx]"}

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

{{url}}/api-partner/register/documentIdentification
FRENCH_IDENTITY_CARD FRENCH_PASSPORT FRENCH_RESIDENCE_PERMIT OTHER_IDENTIFICATION CERTIFICATE_VISA
{{url}}/api-partner/register/documentResidency
TENANT OWNER GUEST_PARENTS GUEST
{{url}}/api-partner/register/documentProfessional
CDI CDI_TRIAL CDD ALTERNATION INTERNSHIP STUDENT PUBLIC CTT RETIRED UNEMPLYED INDEPENDENT OTHER
{{url}}/api-partner/register/documentFinancial
SALARY SCHOLARSHIP SOCIALSERVICE RENT PENSION NO_INCOME
{{url}}/api-partner/register/documentTax
MY_NAME MY_PARENTS LESS_THAN_YEAR OTHER_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.

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
/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 équivalent à la réponse du endpoint /profile du dossier

Comment les messages fonctionnent-ils ?

Les messages utilisent les méthodes suivantes.
get
/api-partner/tenant/{tenant-id}/message
post
https://api.dossierfacile.fr/api/application/fullPdf
/api-partner/tenant/{tenant-id}/message
N'hésitez pas également à faire des tests de parcours à la main sur locataire-dev.dossierfacile.fr, la logique de l'API respecte exactement la logique de notre frontend en termes de séquences.
Copy link
Outline
L'utilisateur doit-il avoir un compte DossierFacile au préalable ?
Comment cela se passe-t-il quand il y a un problème avec une pièce ?
La liste des pièces demandées est-elle modifiable ?
Comment savoir qu'un dossier est encore à jour ?
Les documents doivent-ils être stockés sur notre API ?
Que se passe-t-il si l'utilisateur a déjà constitué son DossierFacile ?
Quand il y a une modification sur un document, est-ce pris en compte du côté de DossierFacile ?
Est-ce que nous avons accès au back-office en préprod ?
Peut-on récupérer les identifiants Postman ?
À partir de quel moment l'URL du dossier renvoyé dans le webhook correspond-elle à un document PDF ?
Quelles sont les possibilités pour typeDocumentXXX pour chacun des flux de l'API ?
Faut-il préciser la sous-catégorie typeDocumentXXX sur mon site ?
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 ?
post
/api-partner/register/guarantorNaturalPerson/name
Comment les webhooks fonctionnent-ils ?
Comment les messages fonctionnent-ils ?
get
/api-partner/tenant/{tenant-id}/message
post
/api-partner/tenant/{tenant-id}/message