Aller au contenu
Support

Lister les contrats

Vos contrats, du plus récent au plus ancien, page par page.

GEThttps://api.coveraf.com/v1/contrats
Réponse JSON 200Sandbox et production
Page suivante

Si suite n'est pas null, rappelez avec ?avant= suivi de cette valeur pour obtenir les contrats plus anciens.

En-têtes

En-têteObligatoireValeur
AuthorizationouiBearer suivi de votre clé API (cvr_test_... ou cvr_live_...).

Paramètres de requête

ChampTypeObligatoireDescription
limiteentiernonNombre de contrats par page, de 1 à 100. 20 par défaut.
avantinstant ISO 8601nonPour la page suivante : la valeur de suite reçue dans la page précédente.

Exemple de requête

curl https://api.coveraf.com/v1/contrats?limite=10 \
  -H "Authorization: Bearer $COVERAF_CLE_API"

Réponse

Succès (200), réponse réelle de la sandbox
{
  "objet": "liste",
  "donnees": [
    {
      "numero": "TEST-CVR-API-MW2EDTG6-F92441FC41",
      "objet": "contrat",
      "environnement": "test",
      "statut": "actif",
      "offre": "securvie_500k",
      "produit": "vie",
      "devis_id": "dev_68e56446d4b5c6875911f178",
      "souscription_id": "sou_8a1ab1eb752f13c8f09bb0b6",
      "reference_partenaire": "CMD-2026-0042",
      "prime": {
        "nette": 11000,
        "accessoires": 0,
        "taxes": 1980,
        "totale": 12980,
        "devise": "XOF"
      },
      "date_effet": "2026-11-04",
      "date_echeance": "2027-11-03",
      "duree_mois": 12,
      "souscripteur": {
        "nom": "KONE",
        "prenom": "Awa",
        "telephone": "+2250701020304",
        "email": "awa.kone@example.com"
      },
      "paiement": null,
      "documents": [
        {
          "type": "conditions_generales",
          "disponible": true,
          "adresse": "/v1/contrats/TEST-CVR-API-MW2EDTG6-F92441FC41/documents/conditions_generales"
        },
        {
          "type": "conditions_particulieres",
          "disponible": true,
          "adresse": "/v1/contrats/TEST-CVR-API-MW2EDTG6-F92441FC41/documents/conditions_particulieres"
        }
      ],
      "cree_le": "2026-11-04T17:35:36.575052+00:00"
    }
  ],
  "suite": "2026-11-04T16:44:34.688451+00:00"
}

Description de chaque champ : modèle Liste.

Erreurs possibles

Aucune erreur propre à cet appel.

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