API docs by Redocly

TélépointsAPI (v0)

Download OpenAPI specification:Download

URL: https://www.telepointsapi.fr

API to check the balance of French driver license.

Account

Everything related to the authenticated account.

Account current usage

Get usage for last 30 days

Authorizations:
basic_auth

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "count": 1,
  • "url": "/v0/account/usage",
  • "sum": 0
}

Balance

Retrieve the balance of a driver license.

Retrieve a license's balance

This request can take up to 5 seconds to process. Requests with same parameters made the same day (CET) will be billed only once.

Authorizations:
basic_auth
query Parameters
required
string or string
password
required
string(?-mix:\A[0-9A-Z]+\z)

Also called "Code confidentiel", password can be found on letters (48N, 48M, 48SI) received by end-user after loosing some points. You can also obtain it using the Password Request end-point.

Responses

Response samples

Content type
application/json
{
  • "changed_at": "2021-08-25",
  • "changed_date": "2021-08-25",
  • "license_number": "070678300841",
  • "object": "balance",
  • "points": 9,
  • "retrieved_at": "2023-08-08T03:05:00Z",
  • "total_points": 12
}

Delete a retrived license's balance cache

Authorizations:
basic_auth
query Parameters
required
string or string
password
required
string(?-mix:\A[0-9A-Z]+\z)

Also called "Code confidentiel", password can be found on letters (48N, 48M, 48SI) received by end-user after loosing some points. You can also obtain it using the Password Request end-point.

Responses

Response samples

Content type
text/plain
List bulk searches 
Authorizations:
basic_auth
Responses
 Response samples 
Content type
application/json
{
  • "object": "list",
  • "data": [
    ],
  • "count": 3,
  • "url": "/v0/bulk_searches"
}
Create a bulk search 
Check the balance of multiple driver licenses in one bulk search.
Searched driver license with same parameters made the same day (CET) will be billed only
once.


Authorizations:
basic_auth
Request Body schema: application/x-www-form-urlencoded
key
string
 Default:  null
 
Unicity key


required
Array of objects
 
List of licenses to be searched


nickname
string
 Default:  null
 
Free field to name the bulk search


take_screenshot
string
 Default:  "never"
 Enum: "never" "when_balance_changed" "always" 
 
When should a screenshot be taken. "when_balance_changed" requires to provide points in licenses list items.


request_full_report
string
 Default:  "never"
 Enum: "never" "when_balance_changed" "always" 
 
When should the full report (RIR) be pulled. "when_balance_changed" requires to provide points in licenses list items.


Responses
 Response samples 
Content type
application/json
{
  • "created_at": "2023-08-08T03:05:02Z",
  • "failure_reason": null,
  • "id": "65bb963e-1743-4cd2-9ae8-3e1f22e78723",
  • "key": null,
  • "licenses": {
    },
  • "nickname": null,
  • "notified_at": null,
  • "object": "bulk_search",
  • "processed_at": null,
  • "queued_at": "2023-08-08T03:05:02Z",
  • "request_full_report": "never",
  • "take_screenshot": "never",
  • "url": "/v0/bulk_searches/65bb963e-1743-4cd2-9ae8-3e1f22e78723"
}
Show a bulk search 
Authorizations:
basic_auth
path Parameters
id
required
string <uuid> 
 
Search ID


Responses
 Response samples 
Content type
application/json
{
  • "created_at": "2023-08-08T03:05:02Z",
  • "failure_reason": null,
  • "id": "4276c35d-a146-4351-81f1-1d2c82924961",
  • "key": null,
  • "licenses": {
    },
  • "nickname": "Zeros",
  • "notified_at": null,
  • "object": "bulk_search",
  • "processed_at": null,
  • "queued_at": "2023-08-08T03:05:02Z",
  • "request_full_report": "never",
  • "take_screenshot": "never",
  • "url": "/v0/bulk_searches/4276c35d-a146-4351-81f1-1d2c82924961"
}
Delete a bulk search 
Authorizations:
basic_auth
path Parameters
id
required
string <uuid> 
 
Search ID


Responses
 Response samples 
Content type
application/json
{
  • "created_at": "2023-08-08T03:05:02Z",
  • "failure_reason": null,
  • "id": "63fa71e0-ddbc-4dd7-8188-696d9ce44ef0",
  • "key": null,
  • "licenses": {
    },
  • "nickname": "Zeros",
  • "notified_at": null,
  • "object": "bulk_search",
  • "processed_at": null,
  • "queued_at": "2023-08-08T03:05:02Z",
  • "request_full_report": "never",
  • "take_screenshot": "never",
  • "url": "/v0/bulk_searches/63fa71e0-ddbc-4dd7-8188-696d9ce44ef0"
}
Password Request
Retrieve new password (Code confidentiel) for a given license.


Initiate a new password request 
First initiate the password request by providing license holder's personal information,
along with a mobile phone number.


Authorizations:
basic_auth
Request Body schema: application/x-www-form-urlencoded
first_name
required
string
 
last_name
required
string
 
gender
required
string
 Enum: "F" "M" 
 
birthdate
required
string <date> 
 
birthplace
required
string
 
required
string or string
 
mobile_phone
required
string(?-mix:\A0[67]\d{8}\z)
 
Responses
 Response samples 
Content type
application/json
{
  • "confirmed_at": null,
  • "created_at": "2023-08-08T03:05:02Z",
  • "id": "c947c722-d4f1-46df-994d-5ca67803b84d",
  • "object": "password_request"
}
Confirm password request 
Second, provide confirmation code received by text in order to receive new password by text.


Authorizations:
basic_auth
path Parameters
id
required
string <uuid> 
 
Request Body schema: application/x-www-form-urlencoded
confirm_code
required
string(?-mix:\A\d{6}\z)
 
Responses
 Response samples 
Content type
application/json
{
  • "confirmed_at": "2023-08-08T03:05:02Z",
  • "created_at": "2023-08-08T03:05:02Z",
  • "id": "fe83084e-5300-4389-9335-8a7427024e9f",
  • "object": "password_request"
}
Retrieve a password request 
Authorizations:
basic_auth
path Parameters
id
required
string <uuid> 
 
Responses
 Response samples 
Content type
application/json
{
  • "confirmed_at": "2022-03-06T04:05:06Z",
  • "created_at": "2023-08-08T03:05:03Z",
  • "id": "8a593ed4-2ace-4a00-92ab-4ad1600eda64",
  • "object": "password_request"
}