CNH-BRAZIL
Descriptionβ
The CNH API enables secure, electronic validation of the Brazilian Carteira Nacional de HabilitaΓ§Γ£o (CNH) β the official National Driverβs License. This IDV solution connects to the national traffic authority ecosystem managed under:
- SENATRAN (Secretaria Nacional de TrΓ’nsito)
- State-level DETRAN databases (via federal integration)
HTTP method POSTβ
Endpointβ
https://api.msla-id.com/experience-idv-drivinglicense-api-v1/api/idv-govcheck/v1/br-identity/{cpfNumber}/cnh
For testing purposes, use the base domain: apidev.msla-id.com
info
Before proceeding, make sure you have your jwt token, if you don't have it, check the login documentation.
Request header parameterβ
| NAME | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| Authorization | β | string | Bearer JWT token |
Path request parameterβ
| NAME | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| cpfNumber | β | string | Brazilian CPF number |
Request bodyβ
| NAME | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| nome | β | string | Full name to validate |
| nacionalidade | β | string | Nationality code |
| dataNascimento | β | string | Date of birth (yyyy-MM-dd) |
| nomeMae | β | string | Mother's full name |
| nomePai | β | string | Father's full name |
| cnhNumeroRegistro | β | string | CNH registration number |
{
"nome": "Manuela Elisa da Mota",
"nacionalidade": "1",
"dataNascimento": "1975-06-04",
"nomeMae": "Simone Carla da Mota",
"nomePai": "Roberto Bruno da Mota",
"cnhNumeroRegistro": "00000000"
}
Status code responsesβ
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Internal server error |
The full documentation error codes can be found here.
Response 200 status codeβ
{
"traceId": "b2345cfc7bee621e",
"timestamp": "2023-05-15 11:59:35",
"data": {
"rfbExiste": true,
"cnhExiste": true,
"rfb": {
"nomeValido": true,
"nomeSimilaridade": 1.0,
"dataNascimentoValida": true
},
"cnh": {
"nomeValido": true,
"nomeSimilaridade": 1.0,
"dataNascimentoValida": true,
"nacionalidadeValida": true,
"nomeMaeValido": true,
"nomeMaeSimilaridade": 0.95,
"nomePaiValido": true,
"nomePaiSimilaridade": 0.98,
"numeroRegistroValido": true
}
}
}
Response 400 status codeβ
{
"traceId": "542fc743fffda052",
"timestamp": "2023-05-05 11:20:46",
"code": "IDV-4005",
"message": "-",
"data": null
}
Response 401 status codeβ
{
"timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
"status": 401,
"error": "Unauthorized",
"path": "/api/idv-govcheck/v1/br-identity/{cpfNumber}/driving-license-check"
}
Response 500 status codeβ
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1001",
"message": "A generic error has occurred.",
"data": null
}