Simuler une demande CEE

POST /policies/cee/simulate

Possibilité de simuler une demande avant la réalisation du trajet par un usager afin de vérifier partiellement la pré-éligibilité de ce dernier (vérification de l'historique mais pas du dédoublonnage).

Sont requis : n° de permis de conduire, trois premières lettres du nom de famille et 8 premiers chiffres du numéro de téléphone.

application/json

Body Required

  • driving_license string

    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}$.

  • journey_type string Required

    Values are short or long.

  • identity_key string

    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.

Responses

  • 200

    OK, la demande est possible

  • 401 application/json

    Non authentifié. Le token applicatif est manquant ou invalide.

  • 403 application/json

    Non autorisé

  • 409 application/json

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

    Hide response attributes Show response attributes object
    • datetime string(datetime)

      Date à laquelle la demande a été effectuée

    • uuid string(uuid)

      UUID de la demande si la demande a déjà été effectuée par l'opérateur.
POST /policies/cee/simulate 
curl \
 -X POST https://api.covoiturage.beta.gouv.fr/v3.1/policies/cee/simulate \
 -H "Content-Type: application/json" \
 -d '{"driving_license":"051227308989","last_name_trunc":"string","phone_trunc":"+336010203","journey_type":"short","identity_key":"string"}'
Request examples 
{
  "driving_license": "051227308989",
  "last_name_trunc": "string",
  "phone_trunc": "+336010203",
  "journey_type": "short",
  "identity_key": "string"
}
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"
}