Pièces justificatives d'un utilisateur
curl --request GET \
--url https://flatbay.fr/fr/api/user/{id}/documentsimport requests
url = "https://flatbay.fr/fr/api/user/{id}/documents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/user/{id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flatbay.fr/fr/api/user/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flatbay.fr/fr/api/user/{id}/documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/user/{id}/documents")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/user/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"documentId": 57187226,
"name": "Bulletins de paie 2026-04.pdf",
"type": "document.type.salaire",
"nbPages": 2,
"size": 531092,
"pageIds": [
57187226,
57187227
],
"status": "validationDocument.status.conf",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"validatedBy": {
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]{
"error": "<string>"
}Endpoint Examples
Pièces justificatives d'un utilisateur
GET
/
user
/
{id}
/
documents
Pièces justificatives d'un utilisateur
curl --request GET \
--url https://flatbay.fr/fr/api/user/{id}/documentsimport requests
url = "https://flatbay.fr/fr/api/user/{id}/documents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/user/{id}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flatbay.fr/fr/api/user/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flatbay.fr/fr/api/user/{id}/documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/user/{id}/documents")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/user/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"documentId": 57187226,
"name": "Bulletins de paie 2026-04.pdf",
"type": "document.type.salaire",
"nbPages": 2,
"size": 531092,
"pageIds": [
57187226,
57187227
],
"status": "validationDocument.status.conf",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"validatedBy": {
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]{
"error": "<string>"
}/api/user/:userId/documents?apiKey=xxxxx
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.| Statut | Signification |
|---|---|
| validationDocument.status.conf | Document conforme |
| validationDocument.status.nonConf | Document non conforme |
| validationDocument.status.incomp | Document incomplet |
| null | Document pas encore validé |
Codes d’erreur
| Code | Description |
|---|---|
| NOAPIKEY | Clé API manquante |
| USERNOTINGROUP | L’utilisateur n’appartient pas à votre groupe |
Path Parameters
Identifiant de l'utilisateur (locataire ou garant) Id de l'utilisateur qui a vu/partagé le bien
Example:
125
Query Parameters
Mot de passe pour l'accès sécurisé
Example:
"api_key_here"
Response
Liste des pièces justificatives
Identifiant du document, à passer à /document/{id}/pdf
Example:
57187226
Nom du fichier d'origine
Example:
"Bulletins de paie 2026-04.pdf"
Type de pièce justificative
Example:
"document.type.salaire"
Nombre de pages du document
Example:
2
Poids cumulé des pages, en octets
Example:
531092
Identifiants des pages, utilisables sur /document/picture/{pageId}
Example:
[57187226, 57187227]
validationDocument.status.conf | nonConf | incomp, ou null si le document n’est pas encore validé
Example:
"validationDocument.status.conf"
Agent ayant posé le statut, null tant que le document n'est pas validé
Show child attributes
Show child attributes

