Télécharger un document

Un document du contrat en PDF. Documents officiels en production, documents de test en sandbox.

GEThttps://api.coveraf.com/v1/contrats/{numero}/documents/{type}

Réponse PDFSandbox et production

Remettez les documents à votre client

Conditions Particulières, et pour un voyage l'attestation de chaque voyageur. En sandbox, ce sont des documents de test marqués « SANS VALEUR ».

En-têtes

En-tête	Obligatoire	Valeur
`Authorization`	oui	Bearer suivi de votre clé API (`cvr_test_...` ou `cvr_live_...`).

Paramètres de chemin

Champ	Type	Obligatoire	Description
`numero`	texte	oui	Numéro du contrat.
`type`	« conditions_generales » \| « conditions_particulieres » \| « attestation »	oui	Un des types listés dans documents du contrat. attestation : voyage uniquement.

Paramètres de requête

Champ	Type	Obligatoire	Description
`voyageur`	entier	non	Attestation voyage : numéro du voyageur, de 1 à n. 1 par défaut.

Exemple de requête

curl https://api.coveraf.com/v1/contrats/TEST-CVR-API-MW25XEIG-A2D52BC9C7/documents/conditions_particulieres \
  -H "Authorization: Bearer $COVERAF_CLE_API" \
  -o document.pdf

Réponse

Succès (200) : le fichier PDF (Content-Type: application/pdf). En cas d'erreur, la réponse est en JSON, au format habituel.

Erreurs possibles

Code	HTTP	Signification
`introuvable`	404	Ressource introuvable.
`document_indisponible`	409	Ce document est disponible une fois le contrat émis (après paiement).
`validation`	422	Certaines données sont manquantes ou incorrectes. Voir erreur.details.

S'y ajoutent les erreurs communes à tous les appels (clé, signature, limite de débit, service) : voir Codes d'erreur.