Get a contract

Get a contract

curl --request GET \
  --url https://businessapi-staging-civ.djigui.io/api/v1.0/contract/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://businessapi-staging-civ.djigui.io/api/v1.0/contract/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "issued",
  "quote": {
    "id": "6c1d8f0e-3b7a-4f5e-9a51-2d0c7e8b4a12",
    "amount": 98450,
    "duration": 12,
    "usage": "pleasure",
    "policyHolderName": "Kouamé Yao Serge",
    "coverageId": "20000000-0000-4000-8000-000000000001"
  },
  "vehicle": {
    "id": "0f9b2abd-2fe8-4346-b49e-4a6aefd89a89",
    "externalId": "client-4821-car-1",
    "type": "auto",
    "licencePlate": "1234AB01",
    "brand": "Toyota",
    "model": "Corolla",
    "year": 2019,
    "firstRoadDate": "2019-06-15",
    "carOriginalValue": 15000000,
    "carMarketValue": 9000000,
    "energy": "essence",
    "power": 7,
    "noSeat": 5,
    "hasRegistrationDocument": false,
    "created": "2026-10-20T09:14:03.512Z"
  },
  "certificate": {
    "certificateNumber": "CI-2026-0841736",
    "insuranceCompany": "ATLANTA",
    "effectiveDate": "2026-11-01",
    "expiryDate": "2027-10-31",
    "pdfLink": "https://...",
    "imageLink": "https://...",
    "qrCodeLink": "https://..."
  },
  "documents": {
    "certificateImageUrl": "https://...",
    "contractDocumentUrl": "https://..."
  },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:20:31.402Z"
}

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "pending",
  "quote": { "...": "..." },
  "vehicle": { "...": "..." },
  "certificate": null,
  "documents": { "certificateImageUrl": null, "contractDocumentUrl": null },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:19:47.118Z"
}

GET

contract

{id}

Get a contract

curl --request GET \
  --url https://businessapi-staging-civ.djigui.io/api/v1.0/contract/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://businessapi-staging-civ.djigui.io/api/v1.0/contract/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "issued",
  "quote": {
    "id": "6c1d8f0e-3b7a-4f5e-9a51-2d0c7e8b4a12",
    "amount": 98450,
    "duration": 12,
    "usage": "pleasure",
    "policyHolderName": "Kouamé Yao Serge",
    "coverageId": "20000000-0000-4000-8000-000000000001"
  },
  "vehicle": {
    "id": "0f9b2abd-2fe8-4346-b49e-4a6aefd89a89",
    "externalId": "client-4821-car-1",
    "type": "auto",
    "licencePlate": "1234AB01",
    "brand": "Toyota",
    "model": "Corolla",
    "year": 2019,
    "firstRoadDate": "2019-06-15",
    "carOriginalValue": 15000000,
    "carMarketValue": 9000000,
    "energy": "essence",
    "power": 7,
    "noSeat": 5,
    "hasRegistrationDocument": false,
    "created": "2026-10-20T09:14:03.512Z"
  },
  "certificate": {
    "certificateNumber": "CI-2026-0841736",
    "insuranceCompany": "ATLANTA",
    "effectiveDate": "2026-11-01",
    "expiryDate": "2027-10-31",
    "pdfLink": "https://...",
    "imageLink": "https://...",
    "qrCodeLink": "https://..."
  },
  "documents": {
    "certificateImageUrl": "https://...",
    "contractDocumentUrl": "https://..."
  },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:20:31.402Z"
}

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "pending",
  "quote": { "...": "..." },
  "vehicle": { "...": "..." },
  "certificate": null,
  "documents": { "certificateImageUrl": null, "contractDocumentUrl": null },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:19:47.118Z"
}

Returns a contract, opened when its quote’s payment was confirmed. Its id is the quote’s contractId. See Contracts and certificates.

string

required

The contract’s id.

Response

string

pending (waiting for the certificate or the start date), started (covered) or expired.

string | null

For example 2026.055.401.04217.

string | null

First day covered, YYYY-MM-DD.

string | null

Last day covered, YYYY-MM-DD.

string | null

The payment that opened it.

string

pending (being requested from ASACI), issued, or failed (contact Djigui).

object

The quote it was opened from.

Show quote

string

integer

Premium, francs CFA.

integer

Months.

string

object

The vehicle, as in Get a vehicle.

object | null

The ASACI certificate, null until issued.

Show certificate

string

The certificate as a PDF, hosted by ASACI.

string

The certificate as an image, hosted by ASACI.

string

Its QR code.

object

Download links, valid for one hour. Each is null until its file is stored.

Show documents

string | null

Djigui’s copy of the certificate image.

string | null

The insurance contract.

string

Errors

Status	`code`
404	`contract_not_found`	No contract with this id in your company.

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "issued",
  "quote": {
    "id": "6c1d8f0e-3b7a-4f5e-9a51-2d0c7e8b4a12",
    "amount": 98450,
    "duration": 12,
    "usage": "pleasure",
    "policyHolderName": "Kouamé Yao Serge",
    "coverageId": "20000000-0000-4000-8000-000000000001"
  },
  "vehicle": {
    "id": "0f9b2abd-2fe8-4346-b49e-4a6aefd89a89",
    "externalId": "client-4821-car-1",
    "type": "auto",
    "licencePlate": "1234AB01",
    "brand": "Toyota",
    "model": "Corolla",
    "year": 2019,
    "firstRoadDate": "2019-06-15",
    "carOriginalValue": 15000000,
    "carMarketValue": 9000000,
    "energy": "essence",
    "power": 7,
    "noSeat": 5,
    "hasRegistrationDocument": false,
    "created": "2026-10-20T09:14:03.512Z"
  },
  "certificate": {
    "certificateNumber": "CI-2026-0841736",
    "insuranceCompany": "ATLANTA",
    "effectiveDate": "2026-11-01",
    "expiryDate": "2027-10-31",
    "pdfLink": "https://...",
    "imageLink": "https://...",
    "qrCodeLink": "https://..."
  },
  "documents": {
    "certificateImageUrl": "https://...",
    "contractDocumentUrl": "https://..."
  },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:20:31.402Z"
}

{
  "id": "9e2f4b6a-1c3d-4e5f-8a7b-6c5d4e3f2a1b",
  "status": "pending",
  "policyNumber": "2026.055.401.04217",
  "startDate": "2026-11-01",
  "endDate": "2027-10-31",
  "paymentId": "b4e8a2c6-7d1f-4a3b-9e5c-8f0a1b2c3d4e",
  "certificateStatus": "pending",
  "quote": { "...": "..." },
  "vehicle": { "...": "..." },
  "certificate": null,
  "documents": { "certificateImageUrl": null, "contractDocumentUrl": null },
  "created": "2026-10-20T09:19:47.118Z",
  "updated": "2026-10-20T09:19:47.118Z"
}

Get started

Guides

Coverages

Vehicles

Quotes

Contracts

Response

Errors

​Response

​Errors

Response

Errors