API docs by Redocly

PCP API (1.0)

Download OpenAPI specification:

CharIN e.V.: coordination@charin.global URL: https://charin.global License: Attribution-ShareAlike 4.0 International

PCP services API.

GetProvisioningCertificate

GetProvisioningCertificateByPCID

Get a provisioning certificate by pcid from PCP.

path Parameters
pcid
required
string (pcidParamV1) [ 17 .. 18 ] characters ^[a-zA-Z0-9]{17,18}$
header Parameters
broadcast
boolean
Default: false
Example: true

if set to true - this call is not getting forwarded to other Ecosystems

OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
application/json
{
  • "provisioningCertificate": {
    }
}

DeleteProvisioningCertificate

DeleteProvisioningCertificateByPCID

This method is used by the OEM to depublish Provisioning Certificates.

A successful deletes triggers a call to the DELETE method of the Contract Certificate Pool for all EMAIDs related to this PCID! In case of contract certificates issued by one of the Operator owned eMSP CAs, this also involves revocation of the same.

path Parameters
pcid
required
string (pcidParamV1) [ 17 .. 18 ] characters ^[a-zA-Z0-9]{17,18}$
header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
application/json
{
  • "errorMessages": [
    ],
  • "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa"
}

AddProvisioningCertificate

AddProvisioningCertificate

Add a provisioning certificate to the PCP.

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Request Body schema: application/json

Expects a Provisioning Certificate.

>= 3 properties
required
object (CertificateChainV1)

General certificate chain type.

xsdMsgDefNamespace
string (xsdMsgDefNamespaceParamV1)
Default: "urn:iso:15118:2:2013:MsgDef"
Enum: "urn:iso:15118:2:2013:MsgDef" "urn:iso:15118:20:2020:MsgDef"

ISO15118 Version

rootIssuerSerialNumber
string

Serial number of the root certificate which is the trust anchor of the given certificate chain. A serial number is a large integer. The interface expects and returns serial numbers in its hexadecimal representation in lower case without separators. Deprecated in future versions. The root certificate will be determined from the Sub-CA 1 certificate automatically.

v2gRootAuthorityKeyIdentifiers
Array of strings non-empty unique

List of root authority key identifiers in a hex formated string (with ":"as separator) which are installed in the EV.

rootAuthorityKeyIdentifier
string

authority key identifier in a hex formated string (with ":"as separator)

fingerprint
string

SHA256 certificate fingerprint (informative)

previousPcid
string [ 17 .. 18 ] characters ^[a-zA-Z0-9]{17,18}$

if the PCID of a vehicle changed, the OEM can use this field to store the previous identifier

Responses

Request samples

Content type
application/json
{
  • "provisioningCertificateChain": {
    },
  • "xsdMsgDefNamespace": "urn:iso:15118:2:2013:MsgDef",
  • "rootIssuerSerialNumber": "69ab00d259bbdf42ce80529ad30ce5ed",
  • "v2gRootAuthorityKeyIdentifiers": [
    ],
  • "rootAuthorityKeyIdentifier": "4b:45:ff:82:25:fc:10:96",
  • "fingerprint": "string",
  • "previousPcid": "stringstringstrin"
}

Response samples

Content type
application/json
Example
{
  • "errorMessages": [
    ],
  • "traceId": "1c8c56cb-b71f-46a5-8788-5ddcedc88e2a"
}

LookUpVehicle

LookUpVehicleByPCID

Check if there is a provisioning certificate for a vehicle stored in the PCP based on PCID.

path Parameters
pcid
required
string (pcidParamV1) [ 17 .. 18 ] characters ^[a-zA-Z0-9]{17,18}$
header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
application/json
{
  • "errorMessages": [
    ],
  • "traceId": "1c8c56cb-b71f-46a5-8788-5ddcedc88e2a"
}