Vérifier un certificat

GET /certificates/{uuid}

Path parameters

  • uuid string(uuid) Required

    Identifiant du certificat précédemment créé.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • type string

      Values are ok or expired.

    • uuid string(uuid)
    • tz string
    • start_at string(date-time)
    • end_at string(date-time)
    • created_at string(date-time)
    • identity object

      Additional properties are allowed.

      Hide identity attribute Show identity attribute object
    • operator object

      Additional properties are allowed.

      Hide operator attributes Show operator attributes object
    • positions array[object]
      Hide positions attributes Show positions attributes object
      • lat number Required

        Latitude comprise entre 90deg et -90deg décimaux en datum WSG-84

      • lon number Required

        Longitude comprise entre 180deg et -180deg décimaux en datum WSG-84

    • driver object

      Additional properties are NOT allowed.

      Hide driver attributes Show driver attributes object
      • total object

        Additional properties are allowed.

        Hide total attributes Show total attributes object
      • trips array[object]
        Hide trips attributes Show trips attributes object
        • type string

          Values are driver or passenger.

        • datetime string(date-time)
        • trips integer
        • distance number

          Distance exprimée en mètre

          Minimum value is 0, maximum value is 1000000.

        • amount number

          montant en centimes d'euros

    • Additional properties are NOT allowed.

      Hide passenger attributes Show passenger attributes object
      • total object

        Additional properties are allowed.

        Hide total attributes Show total attributes object
      • trips array[object]
        Hide trips attributes Show trips attributes object
        • type string

          Values are driver or passenger.

        • datetime string(date-time)
        • trips integer
        • distance number

          Distance exprimée en mètre

          Minimum value is 0, maximum value is 1000000.

        • amount number

          montant en centimes d'euros

  • 401 application/json

    Non authentifié. Le token applicatif est manquant ou invalide

  • 403 application/json

    Accès refusé Les permissions de votre token applicatif ne vous permettent pas de créer une attestation. Vous pouvez générer un nouveau token et réessayer. Si le problème persiste, contactez notre équipe.

  • 404 application/json

    L'attestation n'a pu être trouvée

GET /certificates/{uuid}
curl \
 -X GET http://api.example.com/certificates/9415300a-7a51-4296-96d1-68636e46485d \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "type": "ok",
  "uuid": "8a9d2da9-39e3-4db7-be8e-12b4d2179fda",
  "tz": "Europe/Paris",
  "start_at": "2020-01-01T00:00:00+01:00",
  "end_at": "2020-01-01T00:00:00+01:00",
  "created_at": "2020-01-01T00:00:00+01:00",
  "identity": {
    "uuid": "string"
  },
  "operator": {
    "_id": 42,
    "uuid": "string",
    "name": "string"
  },
  "positions": [
    {
      "lat": 47.682821,
      "lon": -0.557483
    }
  ],
  "driver": {
    "total": {
      "trips": 42,
      "week_trips": 42,
      "weekend_trips": 42,
      "distance": 42.0,
      "amount": 42.0
    },
    "trips": [
      {
        "type": "driver",
        "datetime": "2024-05-04T09:42:00+00:00",
        "trips": 42,
        "distance": 42.0,
        "amount": 42.0
      }
    ]
  },
  "passenger": {
    "total": {
      "trips": 42,
      "week_trips": 42,
      "weekend_trips": 42,
      "distance": 42.0,
      "amount": 42.0
    },
    "trips": [
      {
        "type": "driver",
        "datetime": "2024-05-04T09:42:00+00:00",
        "trips": 42,
        "distance": 42.0,
        "amount": 42.0
      }
    ]
  }
}
Response examples (401)
{
  "code": 401,
  "error": "Unauthorized"
}
Response examples (403)
{
  "code": 403,
  "error": "Forbidden"
}
Response examples (404)
{
  "code": 404,
  "error": "Not found"
}