consent_acceptedbooleanObrigatório← InícioFleetPay / API
Registrar ou rotacionar credencial AT&M de Seguro Obrigatório de Carga (RCTR-C / RC-DC)
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/seguro-carga/credenciais-atmDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
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).
Autenticação
- Escopo Necessário
operacao— Operação- Módulo
- Seguro Obrigatório de Carga (RCTR-C / RC-DC)
- Perfis Aplicáveis
- Gestor de Transporte · Agregado Empresarial · Embarcador · Transportador Frotista
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.
Parâmetros
Nenhum parâmetro declarado nesta operação.
Corpo da Requisição
Obrigatório
Credenciais AT&M e registro de consentimento.
application/json
consent_terms_versionstring | nullOpcionalusernamestringOpcionalpasswordstringOpcionalclient_codestring | nullOpcionalRespostas
200 Resposta HTTP
Operação processada com sucesso.
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTP
Credencial ausente, inválida ou de outro ambiente.
403 Resposta HTTP
Escopo do painel não habilitado ou recurso fora do escopo da company.
422 Resposta HTTP
Consentimento obrigatório ausente ou credencial inválida.
Definição Completa da Operação
{
"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": []
}