Actualizar datos fiscales del conductor

Parámetros, estructura de datos y respuestas del contrato versionado.

PUT/fiscal/motoristas/{id}/dados-fiscais

updateDriverFiscalDataBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

idpath · integerObligatorio

Identificador entero del conductor.

Restricciones

{
  "type": "integer",
  "minimum": 1
}

Cuerpo de la Solicitud

Obligatorio

`application/json`

DriverFiscalInput ↗

cnh_numberstring | nullOpcional

pattern"^\\d{11}$"

cnh_categorystring | nullOpcional

"A" · "B" · "C" · "D" · "E" · "AB" · "AC" · "AD" · "AE"

cnh_statestring | nullOpcional

minLength2

maxLength2

cnh_issued_atstring | null · dateOpcional

cnh_valid_untilstring | null · dateOpcional

rg_numberstring | nullOpcional

maxLength20

rg_issuerstring | nullOpcional

maxLength20

rg_statestring | nullOpcional

minLength2

maxLength2

father_namestring | nullOpcional

maxLength120

mother_namestring | nullOpcional

maxLength120

Respuestas

200 Respuesta HTTP

Perfil fiscal actualizado.

`application/json`

DriverEnvelope ↗

dataobjectObligatorio

Driver ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

Recurso no encontrado en el tenant autenticado.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

422 Respuesta HTTP

Payload inválido, requisito pendiente o regla de negocio.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

Fallo interno sin detalles de las integraciones operativas.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "tags": [
    "Motoristas"
  ],
  "summary": "Atualizar dados fiscais do motorista",
  "operationId": "updateDriverFiscalData",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/DriverFiscalInput"
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/DriverOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "PUT",
  "path": "/fiscal/motoristas/{id}/dados-fiscais",
  "parameters": [
    {
      "$ref": "#/components/parameters/DriverId"
    }
  ]
}