Enregistrer une demande CEE

POST /policies/cee

Vérification complète de l'éligibilité de l'usager (historique et dédoublonnage) et enregistrement de la demande CEE dans l'API CEE :

Si la conformité de la demande est valide, une réponse 201 est retournée validant l'enregistrement de la demande.
Si une demande a déjà été enregistrée pour l'usager en question, une réponse 409 est retournée avec la date à laquelle l'enregistrement a été fait.
Si le trajet envoyé n'est pas trouvé, une réponse 404 est retournée.

Ce point d'API est consultable à J+7 pour la courte et la longue distance, J étant la date de réalisation du trajet.

Schema de la requête HTTP

application/json

Body object Required

journey_type string Required

Value is short.
identity_key string Required
Correspond au SHA d'une chaîne concaténée tel que : sha256({phone_number}-{last_name}) où :
- phone_number correspond au numéro de téléphone complet au format international sans espace ni tiret. Exemple : +33601020304
- last_name correspond au nom de famille complet en majuscule, sans accent ni tiret ni apostrophe : Regexp: [A-Z ]*
Exemple, M. D'Hérûg-de-l'Hérault ayant le numéro 07 01 02 03 04 doit être formatté comme suit +33701020304-D HERUG DE L HERAULT
Minimum length is 64, maximum length is 64.
driving_license string Required

Numéro de permis de conduire (également appelé driving_license) cf https://permisdeconduire.ants.gouv.fr/tout-savoir-sur-le-permis/le-numero-de-dossier-sur-un-permis-au-format-carte-bancaire

One of:
string-1 string string-2 string string-3 string string-4 string

Numéro de permis de conduire composé de 12 chiffres après 1975.

Minimum length is 12, maximum length is 12. Format should match the following pattern: ^[0-9]{12}$.

Numéro de permis de conduire composé de 1 à 15 caractères suivis de 4 chiffres avant 1975.

Minimum length is 5, maximum length is 19. Format should match the following pattern: ^[A-Z0-9]{1,15}[0-9]{4}$.

Numéro de permis de conduire plus anciens composé de 1 à 15 caractères.

Minimum length is 1, maximum length is 15. Format should match the following pattern: ^[A-Z0-9]{1,15}$.

Numéro de permis étranger préfixé de l'indicatif '99-'.

Minimum length is 4, maximum length is 64. Format should match the following pattern: ^99-.*$.
last_name_trunc string Required

Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "

Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
operator_journey_id string Required

Identifiant unique du trajet envoyé par l'opérateur.

Minimum length is 1, maximum length is 256. Format should match the following pattern: ^[a-z0-9]{1,256}$.
application_timestamp string(datetime) Required

Date de signature de l'engagement par le demandeur.

journey_type string Required

Value is long.
identity_key string Required
Correspond au SHA d'une chaîne concaténée tel que : sha256({phone_number}-{last_name}) où :
- phone_number correspond au numéro de téléphone complet au format international sans espace ni tiret. Exemple : +33601020304
- last_name correspond au nom de famille complet en majuscule, sans accent ni tiret ni apostrophe : Regexp: [A-Z ]*
Exemple, M. D'Hérûg-de-l'Hérault ayant le numéro 07 01 02 03 04 doit être formatté comme suit +33701020304-D HERUG DE L HERAULT
Minimum length is 64, maximum length is 64.
driving_license string Required

Numéro de permis de conduire (également appelé driving_license) cf https://permisdeconduire.ants.gouv.fr/tout-savoir-sur-le-permis/le-numero-de-dossier-sur-un-permis-au-format-carte-bancaire

One of:
string-1 string string-2 string string-3 string string-4 string

Numéro de permis de conduire composé de 12 chiffres après 1975.

Minimum length is 12, maximum length is 12. Format should match the following pattern: ^[0-9]{12}$.

Numéro de permis de conduire composé de 1 à 15 caractères suivis de 4 chiffres avant 1975.

Minimum length is 5, maximum length is 19. Format should match the following pattern: ^[A-Z0-9]{1,15}[0-9]{4}$.

Numéro de permis de conduire plus anciens composé de 1 à 15 caractères.

Minimum length is 1, maximum length is 15. Format should match the following pattern: ^[A-Z0-9]{1,15}$.

Numéro de permis étranger préfixé de l'indicatif '99-'.

Minimum length is 4, maximum length is 64. Format should match the following pattern: ^99-.*$.
last_name_trunc string Required

Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "

Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
phone_trunc string Required

Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres

Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
datetime string(datetime) Required

Date de partage des frais.
application_timestamp string(datetime) Required

Date de signature de l'engagement par le demandeur.

Responses

201 application/json

OK, la demande est enregistrée
Hide response attributes Show response attributes object
- datetime number Required
  
  Date de l'opération, en l'occurence date de fin du trajet pour la courte distance et date de paiement pour la longue.
- uuid string(uuid) Required
  
  UUID de la demande
- journey_id number
  
  Numéro de trajet interne au RPC correspondant à l'operator_journey_id envoyé
- status string
  
  Statut du trajet correspondant à l'operator_journey_id envoyé.
- token string Required
  
  signature(sha512([SIRET_OPERATEUR]/[journey_type]/[driving_license]//[DATETIME UTC]))
400
- "expired" : correspond a un trajet envoyé "hors délais". Il faut qu'il soit enregistré dans le RPC dans les 5 jours qui suivent sa réalisation
- "Date should be before 7 days from now" : correspondant à un appel à l'API CEE qui aurait été fait à moins de J+7 de la date de fin du trajet sur la courte distance et à moins de J+7 de la date de paiement au conducteur par l'opérateur sur le longue distance.
401 application/json

Non authentifié. Le token applicatif est manquant ou invalide.
403 application/json

Non autorisé
404
La demande n'a pas pu aboutir car un trajet éligible n'a pas été trouvé soit parce que l'identifiant envoyé ne correspond pas à un trajet inscrit dans le RPC, soit parce que celui-ci ne correspond pas au critères d'éligibilité.

Pour rappel, un trajet éligible est un trajet:
- après le 1er janvier 2023
- de moins de 80 km
- dont le départ ou l'arrivée est en France
- de classe C
409 application/json

Une demande similaire a déjà enregistrée.

Si elle a déjà été enregistrée par le même opérateur, alors la réponse contient l'UUID de la demande, le journey_id et le status si la demande initiale concerne la courte distance.

Dans le cas contraire, seul le champs datetime correspondant à la date de l'opération est renvoyé.
Hide response attributes Show response attributes object
- datetime string(datetime)
  
  Date de l'opération, en l'occurence date de fin du trajet pour la courte distance et date de paiement pour la longue.
- uuid string(uuid)
  
  UUID V4 de la demande si la demande a déjà été effectuée par l'opérateur.

POST /policies/cee

curl \
 --request POST 'https://api.covoiturage.beta.gouv.fr/v3.3/policies/cee' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"journey_type":"short","identity_key":"string","driving_license":"051227308989","last_name_trunc":"string","operator_journey_id":"string","application_timestamp":"string"}'

Request examples

{
  "journey_type": "short",
  "identity_key": "string",
  "driving_license": "051227308989",
  "last_name_trunc": "string",
  "operator_journey_id": "string",
  "application_timestamp": "string"
}

{
  "journey_type": "long",
  "identity_key": "string",
  "driving_license": "051227308989",
  "last_name_trunc": "string",
  "phone_trunc": "+336010203",
  "datetime": "string",
  "application_timestamp": "string"
}

Response examples (201)

{
  "datetime": 42.0,
  "uuid": "string",
  "journey_id": 42.0,
  "status": "string",
  "token": "signature(sha512(13002526500013/short/051227308989/2022-11-22T08:54:19Z))"
}

Response examples (401)

{
  "id": 1,
  "error": {
    "code": -32501,
    "data": "Unauthorized application",
    "message": "Unauthorized Error"
  },
  "jsonrpc": "2.0"
}

Response examples (403)

{
  "id": 1,
  "error": {
    "code": -32503,
    "data": "Invalid permissions",
    "message": "Forbidden Error"
  },
  "jsonrpc": "2.0"
}

Response examples (409)

{
  "datetime": "string",
  "uuid": "string"
}