data—Optional← HomeFleetPay / API
List AT&M credentials for Mandatory Cargo Insurance (RCTR-C / RC-DC) reporting
Parameters, data structure and responses from the versioned contract.
GET
/seguro-carga/credenciais-atmTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Returns metadata for automated cargo insurance reporting (AT&M) credentials configured for Mandatory Cargo Insurance (RCTR-C / RC-DC — Law 14.599/2023), without exposing secrets.
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.
Responses
200 HTTP Response
Operation processed successfully.
application/json
metaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP Response
Missing, invalid or cross-environment credential.
403 HTTP Response
Dashboard scope not enabled or resource outside company scope.
Complete Operation Definition
{
"tags": [
"Seguro de Carga"
],
"operationId": "listarCredenciaisAtmSeguroCarga",
"summary": "Listar credenciais AT&M para averbação de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
"description": "Retorna metadados das credenciais de averbação automática (AT&M) configuradas para o Seguro Obrigatório de Carga (RCTR-C / RC-DC — Lei 14.599/2023), sem expor segredos.",
"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."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "seguro-carga",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"embarcador",
"transportador_frotista"
],
"method": "GET",
"path": "/seguro-carga/credenciais-atm",
"parameters": []
}