Skip to main content
API docs by Redocly

Digital Battery Passport API (1.0.0)

Download OpenAPI specification:Download

License: MIT

This OpenApi allows users to query data contained in a digital passport.

More about Digital Passport

BatteryPass

Get a list of all available digital battery passports. The contents of the list might be subjective to access control

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new digital battery passport

Request Body schema: application/json

Definition of a new digital battery passport

batteryIDDMCCode
string

Battery IDDM Code

dateOfManufacturing
string

Manufacturing date (month and year), suggested in form of manufacturing date codes.

dateOfService
string

Date of putting the battery into service

placeOfManufacturing
string

Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product, ESPR Art. 2(33)).

cO2FootprintTotal
number <double>

CO2 Footprint Total (kg CO2)

object (ElectrochemicalProperties)
object (PhysicalDimensionsProperties)
object (CellChemistryProperties)

Cell Chemistry Properties

object (BatteryEnergyProperties)

Battery Energy Properties

object (Attachement)
object (BatteryCycleLifeProperties)

Battery Cycle Life Properties

object (StateOfBatteryProperties)
object (CompositionProperties)

Composition Properties

warrantyPeriod
number

Warranty period of the battery. Also includes the expected life-time under the reference conditions in calendar years.

object (Attachement)
object (Attachement)
carbonFootprintPerformanceClass
string

EV, industrial and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. The carbon footprint performance class shall be accessible via the battery passport. A meaningful number of classes of performance will be developed, with category A being the best class with the lowest carbon footprint life cycle impact.

carbonFootprintStudyLink
string

A web link to get access to a public version of the study supporting the carbon footprint values

object (Attachement)
object (Attachement)
object (Attachement)
extinguishingAgent
string

Usable extinguishing agend refering to classes of extinguishers (A, B, C, D, K).

remainingPowerCapability
number

Remaining performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time

Array of objects (RenewableContentShare)
Array of objects (RenewableContentShare)
Array of objects (RenewableContentShare)
encounteredNegativeEvents
number

The number of encountered negative events (such as accidents)

batteryCategory
string

Categories relevant for the battery passport: LMT battery, electric vehicle battery or industrial battery. The latter includes the subcategory stationary battery energy storage system complemented by other industrial batteries (Art. 2).

declarationOfConformityID
string

Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration.

object (Attachement)
object (Attachement)
object (Attachement)
object (Interval)

Interval

object (Interval)

Interval

object (Interval)

Interval

Responses

Request samples

Content type
application/json
{
  • "batteryIDDMCCode": "string",
  • "dateOfManufacturing": "string",
  • "dateOfService": "string",
  • "placeOfManufacturing": "string",
  • "cO2FootprintTotal": 0.1,
  • "hasEelectrochemicalProperties": {
    },
  • "hasPhysicalDimensionsProperties": {
    },
  • "hasCellChemistryProperties": {
    },
  • "hasBatteryEnergyProperties": {
    },
  • "safetyMeasures": {
    },
  • "hasBatteryCycleLifeProperties": {
    },
  • "hasStateOfBatteryProperties": {
    },
  • "hasCompositionProperties": {
    },
  • "warrantyPeriod": 0,
  • "meaningLabelsAndSymbols": {
    },
  • "separateCollectionSymbol": {
    },
  • "carbonFootprintPerformanceClass": "string",
  • "carbonFootprintStudyLink": "string",
  • "manualDissasemblyAndDismantlingBatteryPack": {
    },
  • "manualRemovalBatteryFromAppliance": {
    },
  • "dueDiligenceReport": {
    },
  • "extinguishingAgent": "string",
  • "remainingPowerCapability": 0,
  • "hasRenewableContentShare": [
    ],
  • "hasPreConsumerRecycledMaterialShare": [
    ],
  • "hasPostConsumerRecycledMaterialShare": [
    ],
  • "encounteredNegativeEvents": 0,
  • "batteryCategory": "string",
  • "declarationOfConformityID": "string",
  • "roleOfEndUsersInWastePrevention": {
    },
  • "roleOfEndUsersInSeparateCollectionOfWasteBatteries": {
    },
  • "informationOnSeparateCollectionTakeBackCollectionPointsPreparingForReusePreparingForRepurposingAndRecyclingOperations": {
    },
  • "temperatureRangeIdleState": {
    },
  • "timeSpentInExtremeTemperatures": {
    },
  • "timeSpentChargingDuringExtremeTemperatures": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get the metadata of a given batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is requested

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update an BattPassport

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is updated

Request Body schema: application/json

Definition of a new digital battery passport

batteryIDDMCCode
string

Battery IDDM Code

dateOfManufacturing
string

Manufacturing date (month and year), suggested in form of manufacturing date codes.

dateOfService
string

Date of putting the battery into service

placeOfManufacturing
string

Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product, ESPR Art. 2(33)).

cO2FootprintTotal
number <double>

CO2 Footprint Total (kg CO2)

object (ElectrochemicalProperties)
object (PhysicalDimensionsProperties)
object (CellChemistryProperties)

Cell Chemistry Properties

object (BatteryEnergyProperties)

Battery Energy Properties

object (Attachement)
object (BatteryCycleLifeProperties)

Battery Cycle Life Properties

object (StateOfBatteryProperties)
object (CompositionProperties)

Composition Properties

warrantyPeriod
number

Warranty period of the battery. Also includes the expected life-time under the reference conditions in calendar years.

object (Attachement)
object (Attachement)
carbonFootprintPerformanceClass
string

EV, industrial and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. The carbon footprint performance class shall be accessible via the battery passport. A meaningful number of classes of performance will be developed, with category A being the best class with the lowest carbon footprint life cycle impact.

carbonFootprintStudyLink
string

A web link to get access to a public version of the study supporting the carbon footprint values

object (Attachement)
object (Attachement)
object (Attachement)
extinguishingAgent
string

Usable extinguishing agend refering to classes of extinguishers (A, B, C, D, K).

remainingPowerCapability
number

Remaining performance ability of the high voltage battery i.e. the amount of energy that a battery is capable to provide over a given period of time

Array of objects (RenewableContentShare)
Array of objects (RenewableContentShare)
Array of objects (RenewableContentShare)
encounteredNegativeEvents
number

The number of encountered negative events (such as accidents)

batteryCategory
string

Categories relevant for the battery passport: LMT battery, electric vehicle battery or industrial battery. The latter includes the subcategory stationary battery energy storage system complemented by other industrial batteries (Art. 2).

declarationOfConformityID
string

Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration.

object (Attachement)
object (Attachement)
object (Attachement)
object (Interval)

Interval

object (Interval)

Interval

object (Interval)

Interval

Responses

Request samples

Content type
application/json
{
  • "batteryIDDMCCode": "string",
  • "dateOfManufacturing": "string",
  • "dateOfService": "string",
  • "placeOfManufacturing": "string",
  • "cO2FootprintTotal": 0.1,
  • "hasEelectrochemicalProperties": {
    },
  • "hasPhysicalDimensionsProperties": {
    },
  • "hasCellChemistryProperties": {
    },
  • "hasBatteryEnergyProperties": {
    },
  • "safetyMeasures": {
    },
  • "hasBatteryCycleLifeProperties": {
    },
  • "hasStateOfBatteryProperties": {
    },
  • "hasCompositionProperties": {
    },
  • "warrantyPeriod": 0,
  • "meaningLabelsAndSymbols": {
    },
  • "separateCollectionSymbol": {
    },
  • "carbonFootprintPerformanceClass": "string",
  • "carbonFootprintStudyLink": "string",
  • "manualDissasemblyAndDismantlingBatteryPack": {
    },
  • "manualRemovalBatteryFromAppliance": {
    },
  • "dueDiligenceReport": {
    },
  • "extinguishingAgent": "string",
  • "remainingPowerCapability": 0,
  • "hasRenewableContentShare": [
    ],
  • "hasPreConsumerRecycledMaterialShare": [
    ],
  • "hasPostConsumerRecycledMaterialShare": [
    ],
  • "encounteredNegativeEvents": 0,
  • "batteryCategory": "string",
  • "declarationOfConformityID": "string",
  • "roleOfEndUsersInWastePrevention": {
    },
  • "roleOfEndUsersInSeparateCollectionOfWasteBatteries": {
    },
  • "informationOnSeparateCollectionTakeBackCollectionPointsPreparingForReusePreparingForRepurposingAndRecyclingOperations": {
    },
  • "temperatureRangeIdleState": {
    },
  • "timeSpentInExtremeTemperatures": {
    },
  • "timeSpentChargingDuringExtremeTemperatures": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ElectrochemicalProperties

Get the Eelectrochemical properties of a given batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is requested

Responses

Response samples

Content type
application/json
{
  • "ratedCapacity": 0,
  • "capacityFade": 0,
  • "capacityThresholdExhaustion": 0,
  • "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy": 0,
  • "remainingCapacity": 0,
  • "internalResistanceProperties": {
    },
  • "voltageProperties": {
    },
  • "batteryPowerProperties": {
    },
  • "temperatureProperties": {
    },
  • "SOCEThresholdForExhaustion": 0
}

Update the electrochemical properties in a batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is updated

Request Body schema: application/json

Definition of the updated ElectrochemicalProperties

ratedCapacity
number

The total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions

capacityFade
number

The decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer

capacityThresholdExhaustion
number

Capacity threshold for exhaustion as percentage value

ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy
number

Ratio between maximum allowed battery power (W) and battery energy (Wh)

remainingCapacity
number

The total remaining number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions

object (InternalResistanceProperties)
object (VoltageProperties)
object (BatteryPowerProperties)

Battery Power Properties

object (TemperatureProperties)

Temperature Properties

SOCEThresholdForExhaustion
number

Derived as analogue to, and potential future replacement of Capacity threshold for exhaustion. Interpreted as minimum percentage of SOCE, above which the battery is still considered operational as EV battery in its current life. The value has to be provided by the economic operator. The SOCE standard is only applicable to electric vehicle batteries. This metric may serve as indicator for a necessary end of current life as EV and may be understood in the context of warranty. A clarified definition is required.

Responses

Request samples

Content type
application/json
{
  • "ratedCapacity": 0,
  • "capacityFade": 0,
  • "capacityThresholdExhaustion": 0,
  • "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy": 0,
  • "remainingCapacity": 0,
  • "internalResistanceProperties": {
    },
  • "voltageProperties": {
    },
  • "batteryPowerProperties": {
    },
  • "temperatureProperties": {
    },
  • "SOCEThresholdForExhaustion": 0
}

Response samples

Content type
application/json
{
  • "ratedCapacity": 0,
  • "capacityFade": 0,
  • "capacityThresholdExhaustion": 0,
  • "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy": 0,
  • "remainingCapacity": 0,
  • "internalResistanceProperties": {
    },
  • "voltageProperties": {
    },
  • "batteryPowerProperties": {
    },
  • "temperatureProperties": {
    },
  • "SOCEThresholdForExhaustion": 0
}

CompositionProperties

Get the composition properties of a given batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is requested

Responses

Response samples

Content type
application/json
{
  • "componentsProperties": [
    ],
  • "leadSymbol": true,
  • "cadmiumSymbol": true,
  • "criticalRawMaterials": "string",
  • "compositionOfBattery": {
    }
}

Update the composition properties in a batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is updated

Request Body schema: application/json

Definition of the updated CompositionProperties

Array of objects (ComponentsProperties)
leadSymbol
boolean

Lead symbol indicating the metal is contained in the battery above a defined threshold of 0.004%

cadmiumSymbol
boolean

Cadmium symbol indicating the metal is contained in the battery above a defined threshold of 0.002%

criticalRawMaterials
string
object (Attachement)

Responses

Request samples

Content type
application/json
{
  • "componentsProperties": [
    ],
  • "leadSymbol": true,
  • "cadmiumSymbol": true,
  • "criticalRawMaterials": "string",
  • "compositionOfBattery": {
    }
}

Response samples

Content type
application/json
{
  • "componentsProperties": [
    ],
  • "leadSymbol": true,
  • "cadmiumSymbol": true,
  • "criticalRawMaterials": "string",
  • "compositionOfBattery": {
    }
}

BatteryCycleLifeProperties

Get the batteryCycleLife properties of a given batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is requested

Responses

Response samples

Content type
application/json
{
  • "expectedLifetime": 0,
  • "cycleLifeTestCRate": 0,
  • "cycleLifeTestDepthOfDischarge": 0,
  • "chargeDischargeCycles": 0,
  • "energyThroughput": 0,
  • "capacityThroughput": 0,
  • "cycleLifeReferenceTest": "string"
}

Update the batteryCycleLifeProperties properties in a batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is updated

Request Body schema: application/json

Definition of the updated BatteryCycleLifeProperties

expectedLifetime
number

Expected battery lifetime expressed in cycles, and reference test used

cycleLifeTestCRate
number

C-rate of Relevant Cycle-life Test

cycleLifeTestDepthOfDischarge
number

Depth of discharge in the cycle-life test

chargeDischargeCycles
number

Number of (full) charging and discharging cycles.

energyThroughput
number

Overall sum of the energy throughput over the battery lifetime. The data attribute should be reported as measured for further potential processing. In addition, the normalisation by usable battery energy could add a further useful value that ensures comparability among battery sizes.

capacityThroughput
number

Overall sum of the capacity throughput over the battery lifetime. The data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes.

cycleLifeReferenceTest
string

Specification of the applied cycle-life test.

Responses

Request samples

Content type
application/json
{
  • "expectedLifetime": 0,
  • "cycleLifeTestCRate": 0,
  • "cycleLifeTestDepthOfDischarge": 0,
  • "chargeDischargeCycles": 0,
  • "energyThroughput": 0,
  • "capacityThroughput": 0,
  • "cycleLifeReferenceTest": "string"
}

Response samples

Content type
application/json
{
  • "expectedLifetime": 0,
  • "cycleLifeTestCRate": 0,
  • "cycleLifeTestDepthOfDischarge": 0,
  • "chargeDischargeCycles": 0,
  • "energyThroughput": 0,
  • "capacityThroughput": 0,
  • "cycleLifeReferenceTest": "string"
}

CellChemistryProperties

Get the cellChemistry properties of a given batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is requested

Responses

Response samples

Content type
application/json
{
  • "cathodeActiveMaterials": [
    ],
  • "recyclateContentActiveMaterials": [
    ],
  • "anodeActiveMaterials": [
    ],
  • "cathodeCompositionOther": [
    ],
  • "anodeCompositionOther": [
    ],
  • "electrolyteComposition": [
    ],
  • "declarationOfConformity": {
    },
  • "testReportsResults": {
    }
}

Update the cellChemistry properties in a batteryPass

path Parameters
batteryIDDMCCode
required
string

Identifier of the BatteryPass that is updated

Request Body schema: application/json

Definition of the updated CellChemistryProperties

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

The total amount of valuable materials contained in CAM material: Nickel, Cobalt, Lithium.

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

List of recovered Recyclate Content in Active Material Recycled is describing a regulatory requirement. The following materials have to be reported on as a minimium: Cobalt, Lithium, Nickel, Lead

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

The total amount of valuable materials contained in Anode: graphite

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

The composition or materials contained in the Cathode

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

The composition or materials contained in the anode

Array of objects (MaterialNameAndWeightAndPercentageMassFraction)

List of materials contained in the electrolyte

object (Attachement)
object (Attachement)

Responses

Request samples

Content type
application/json
{
  • "cathodeActiveMaterials": [
    ],
  • "recyclateContentActiveMaterials": [
    ],
  • "anodeActiveMaterials": [
    ],
  • "cathodeCompositionOther": [
    ],
  • "anodeCompositionOther": [
    ],
  • "electrolyteComposition": [
    ],
  • "declarationOfConformity": {
    },
  • "testReportsResults": {
    }
}

Response samples

Content type
application/json
{
  • "cathodeActiveMaterials": [
    ],
  • "recyclateContentActiveMaterials": [
    ],
  • "anodeActiveMaterials": [
    ],
  • "cathodeCompositionOther": [
    ],
  • "anodeCompositionOther": [
    ],
  • "electrolyteComposition": [
    ],
  • "declarationOfConformity": {
    },
  • "testReportsResults": {
    }
}