Aller au contenu
Support

Consulter un contrat

Un contrat : prime, dates, souscripteur, assurés, paiement, documents disponibles.

GEThttps://api.coveraf.com/v1/contrats/{numero}
Réponse JSON 200Sandbox et production

En-têtes

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

Paramètres de chemin

ChampTypeObligatoireDescription
numerotexteouiNuméro du contrat (CVR-API-... en production, TEST-CVR-API-... en sandbox).

Exemple de requête

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

Réponse

Succès (200), réponse réelle de la sandbox
{
  "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"
  },
  "assures": [],
  "paiement": {
    "montant": 12980,
    "moyen": "Orange Money (encaissé par le partenaire)",
    "paye_le": "2026-11-04T17:35:36.2+00:00"
  },
  "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"
}

Description de chaque champ : modèle Contrat.

Erreurs possibles

CodeHTTPSignification
introuvable404Ressource introuvable.

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