Consultar las licencias de una persona en el RUNT

POST

/api/v1/consults/license

curl --request POST \
  --url https://notiauto.co/api/v1/consults/license \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "type_document": "C", "document": "12345678", "first_surname": "GOMEZ", "refresh": false }'

• Producción

Requiere el scope consults.license. El resultado se cachea 24 horas por (tipo de documento, documento, primer apellido); cached indica si se sirvió del caché.

Authorizations

• ApiKey

Request Body^required

Media typeapplication/json

object

type_document

required

string

Example

C

document

required

string

Example

12345678

first_surname

required

string

Example

GOMEZ

refresh

boolean

Responses

200

Licencias de la persona. status se calcula contra la fecha de hoy.

Media typeapplication/json

object

success

boolean

cached

boolean

data

object

nombres

string

nullable

apellidos

string

nullable

documento

string

estado_conductor

string

nullable

licenses

Array<object>

object

numero

string

category

string

expedition_date

string format: date

nullable

expiration_date

string format: date

nullable

status

string

Allowed values: VIGENTE VENCIDA

sustrato

string

total_licenses

integer

Example

{
  "success": true,
  "cached": false,
  "data": {
    "nombres": "ANA",
    "apellidos": "GOMEZ",
    "documento": "12345678",
    "estado_conductor": "ACTIVO"
  },
  "licenses": [
    {
      "numero": "123456789",
      "category": "B1",
      "status": "VIGENTE",
      "sustrato": "ACTIVA"
    }
  ],
  "total_licenses": 2
}

422

Documento con formato inválido

503

El RUNT no respondió

Media typeapplication/json

Error

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "API key inválida o expirada."
}