GET
Pièces justificatives d'un utilisateur
Il faudra que l’équipe Flatbay vous fournisse une clé d’API (au niveau du groupe) pour utiliser cette route. Liste les pièces justificatives d’un utilisateur — locataire ou garant — indépendamment de toute candidature. Elle complète Extractions des leads, qui ne les expose qu’imbriquées dans une candidature.

Documents et pages

Un fichier téléversé est stocké page par page. Une entrée de la réponse = un fichier ; pageIds liste les identifiants de ses pages, utilisables sur /document/picture/{pageId} pour récupérer l’image d’une page. Pour le fichier complet en PDF, utiliser Télécharger le PDF d’un document avec le documentId.

Statut de validation

Seules les validations faites par une agence de votre groupe sont renvoyées.

Codes d’erreur

Path Parameters

id
integer
required

Identifiant de l'utilisateur (locataire ou garant) Id de l'utilisateur qui a vu/partagé le bien

Example:

125

Query Parameters

apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

Response

Liste des pièces justificatives

documentId
integer

Identifiant du document, à passer à /document/{id}/pdf

Example:

57187226

name
string

Nom du fichier d'origine

Example:

"Bulletins de paie 2026-04.pdf"

type
string

Type de pièce justificative

Example:

"document.type.salaire"

nbPages
integer

Nombre de pages du document

Example:

2

size
integer

Poids cumulé des pages, en octets

Example:

531092

pageIds
integer[]

Identifiants des pages, utilisables sur /document/picture/{pageId}

Example:
status
string | null

validationDocument.status.conf | nonConf | incomp, ou null si le document n’est pas encore validé

Example:

"validationDocument.status.conf"

statusUpdatedAt
string<date-time> | null
validatedBy
object | null

Agent ayant posé le statut, null tant que le document n'est pas validé

createdAt
string<date-time>
updatedAt
string<date-time>