Skip to main content
GET
cURL

Authorizations

​
X-API-Key
string
header
required

Canonical server-to-server API key header name: X-API-Key. Partner customer applications must not use this credential. Examples must never include raw API secrets.

Headers

​
X-Correlation-ID
string

Optional request correlation header. If omitted, Akhdar generates one. Every success and error response includes X-Correlation-ID. Error payloads include correlation_id.

Non-PII request correlation identifier.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Example:

"corr_7c2e9b1a4d6f8e0c"

Path Parameters

​
calculation_id
string
required

Akhdar-generated emissions estimate identifier.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Example:

"calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"

Response

Estimate found for the authenticated partner and environment.

​
calculation_id
string
required

Akhdar-generated emissions estimate identifier.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Example:

"calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"

​
partner_order_ref
string
required

Stable non-PII partner order correlation reference. Enforces one confirmed contribution per partner order within partner and environment. Must not contain direct personal data.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Example:

"ord_9f3c2a71"

​
status
enum<string>
required

Estimate lifecycle statuses.

  • calculated: valid estimate not yet associated
  • associated: valid association snapshot created
  • expired: unassociated estimate exceeded the 24-hour window
  • discarded: unassociated estimate invalidated before association Do not expose these statuses in customer-facing UI.
Available options:
calculated,
associated,
expired,
discarded
Example:

"calculated"

​
distance_km
string
required

Partner-supplied estimated route distance in kilometres as a decimal string. Validation rules:

  • Positive decimal-string values only
  • 0 < distance_km <= 200
  • Maximum three decimal places
  • Maximum value exactly 200
  • 200, 200.0, 200.00, and 200.000 are valid
  • Values above 200 are invalid
  • Reject excess precision rather than silently round Trailing-zero numeric equivalence is preserved for values within range (5, 5.0, 5.000).
Pattern: ^(?:0\.(?!0+$)\d{1,3}|(?:[1-9]|[1-9]\d|1\d{2})(?:\.\d{1,3})?|200(?:\.0{1,3})?)$
Example:

"7.400"

​
distance_unit
enum<string>
required

Distance unit. Kilometres only.

Available options:
km
Example:

"km"

​
vehicle_category
enum<string>
required

Exact supported vehicle categories. Aliases, inferred vehicles, and defaults are not accepted.

Available options:
motorcycle_gasoline,
car_gasoline
Example:

"motorcycle_gasoline"

​
methodology_version
string
required

Methodology version identifier.

Example:

"DEM-WTW-v1.0.0"

​
vehicle_catalog_version
string
required

Vehicle-catalog version identifier.

Example:

"DVC-v1.0.0"

​
emission_factor_version
string
required

Emission-factor version identifier used for this estimate.

Example:

"EF-DESNZ-2026-MOTORCYCLE-GASOLINE-AVG-WTW-v1.0.0"

​
emission_factor_gco2e_per_km
string
required

Base-10 decimal value encoded as a string to preserve deterministic precision. Implementations must not rely on binary floating-point for calculation storage.

Pattern: ^-?\d+(\.\d+)?$
Example:

"1.059902"

​
lifecycle_boundary
enum<string>
required

Delivery-emissions lifecycle boundary.

Available options:
well_to_wheel
Example:

"well_to_wheel"

​
raw_emissions_gco2e
string
required

Base-10 decimal value encoded as a string to preserve deterministic precision. Implementations must not rely on binary floating-point for calculation storage.

Pattern: ^-?\d+(\.\d+)?$
Example:

"1.059902"

​
estimated_emissions_kgco2e
string
required

Base-10 decimal value encoded as a string to preserve deterministic precision. Implementations must not rely on binary floating-point for calculation storage.

Pattern: ^-?\d+(\.\d+)?$
Example:

"1.059902"

​
display
object
required
​
disclosure_en
string
required
Allowed value: "Estimated from distance and vehicle type."
​
disclosure_ar
string
required
Allowed value: "تقديرية حسب المسافة ونوع المركبة."
​
calculated_at
string<date-time>
required

ISO 8601 UTC timestamp.

Example:

"2026-08-03T12:00:00.000Z"

​
expires_at
string<date-time>
required

Temporary unassociated estimate expiry timestamp (24-hour window).

Example:

"2026-08-03T12:00:00.000Z"

​
environment
enum<string>
required

Partner API environment derived from authenticated credentials.

Available options:
sandbox,
production
Example:

"sandbox"