← HomeFleetPay / API

Register or rotate Mandatory Cargo Insurance (RCTR-C / RC-DC) AT&M credential

Parameters, data structure and responses from the versioned contract.

POST/seguro-carga/credenciais-atm
registrarCredencialAtmSeguroCargaSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Stores credentials in the vault with explicit consent to automate Mandatory Cargo Insurance (RCTR-C and RC-DC — Law 14.599/2023) filings.

Authentication

Required Scope
operacao — Operations
Module
Mandatory Cargo Insurance (RCTR-C / RC-DC)
Target Profiles
Transport Manager · Dedicated Fleet Contractor · Shipper · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Request Body

Required

AT&M credentials and consent record.

application/json

consent_acceptedbooleanRequired
consent_terms_versionstring | nullOptional
usernamestringOptional
passwordstringOptional
client_codestring | nullOptional

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

422 HTTP Response

Missing mandatory consent or invalid credential.

Complete Operation Definition
{
  "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": []
}