consent_acceptedbooleanObligatorio← InicioFleetPay / API
Registrar o rotar credencial AT&M de Seguro Obligatorio de Carga (RCTR-C / RC-DC)
Parámetros, estructura de datos y respuestas del contrato versionado.
POST
/seguro-carga/credenciais-atmLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Almacena credenciales en la bóveda con consentimiento explícito para automatizar declaraciones de Seguro Obligatorio de Carga (RCTR-C y RC-DC — Ley 14.599/2023).
Autenticación
- Permiso Requerido
operacao— Operación- Módulo
- Seguro Obligatorio de Carga (RCTR-C / RC-DC)
- Perfiles Aplicables
- Gestor de Transporte · Agregado Empresarial · Embarcador · Transportista Flotista
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.
Parámetros
No hay parámetros declarados para esta operación.
Cuerpo de la Solicitud
Obligatorio
Credenciales AT&M y registro de consentimiento.
application/json
consent_terms_versionstring | nullOpcionalusernamestringOpcionalpasswordstringOpcionalclient_codestring | nullOpcionalRespuestas
200 Respuesta HTTP
Operación procesada con éxito.
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTP
Credencial ausente, inválida o de otro entorno.
403 Respuesta HTTP
Permiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTP
Consentimiento obligatorio ausente o credencial inválida.
Definición Completa de la Operación
{
"tags": [
"Seguro de Carga"
],
"operationId": "registrarCredencialAtmSeguroCarga",
"summary": "Registrar ou rotacionar credencial AT&M de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
"description": "Armazena credenciais no cofre com consentimento explícito para automatizar averbações de Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023).",
"requestBody": {
"required": true,
"description": "Credenciais AT&M e registro de consentimento.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"consent_accepted"
],
"properties": {
"consent_accepted": {
"type": "boolean"
},
"consent_terms_version": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"client_code": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
},
"422": {
"description": "Consentimento obrigatório ausente ou credencial inválida."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "seguro-carga",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"embarcador",
"transportador_frotista"
],
"method": "POST",
"path": "/seguro-carga/credenciais-atm",
"parameters": []
}