Federal highway police

Description

Consult the Federal Highway Police database, the entity responsible for monitoring mobility in Brazil and for the security of federal highways and areas of interest to the Union.

HTTP method GET

Endpoint

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/br-identity/{documentNumber}/check-federal-highway-police

info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Driver license	✅	string	Brazilian driver license

Status code responses

Code	Description
200	OK
400	Bad request
401	Unauthorized
404	Not found
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": {
        "renavam": "49493435681",
        "source": "prefeitura_sp",
        "ait": "QV-A4-214168",
        "issued_at": "2016-09-17T16:36:09.461Z",
        "place": "RuaBarãodeItapetininga",
        "description": "Estacionaremlocal/horárioproibidoespecificamentepelasinalização",
        "plate": "FBR3382",
        "amount_reais": 72.39,
        "uf": "SP",
        "legal_protection": "174",
        "points": "2",
        "protocol": "99280",
        "nit": "12736182732"
    }
}

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/{documentNumber}/check-federal-highway-police"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}