GET
Télécharger le PDF d'un document
Il faudra que l’équipe flatbay vous fournisse une clé d’API (au niveau du groupe) pour utiliser cette route. Télécharge le PDF du document, servi en pièce jointe. Deux natures de documents sont acceptées.

Bail ou acte de cautionnement

Le PDF final (document principal + annexes fusionnées). L’URL prête à l’emploi (clé d’API incluse) est fournie dans le champ pdf.url de la réponse de Détail d’un bail. Tant que le document n’a pas été généré (brouillon), pdf.available vaut false et cette route renvoie une erreur 404.

Pièce justificative d’un utilisateur

Le documentId provient de Pièces justificatives d’un utilisateur. Les pages du fichier sont réassemblées en un seul PDF. Au-delà de 30 Mo, l’assemblage est refusé (413 DOCUMENTTOOLARGE) : récupérer alors les pages une à une via /document/picture/{pageId}.

Path Parameters

id
integer
required

Identifiant du document (bail ou acte de cautionnement) sur la table document

Example:

12345

Query Parameters

apiKey
string
required

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

Example:

"api_key_here"

Response

Fichier PDF

The response is of type file.