← InícioFleetPay / API

Cadastrar ou atualizar apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC)

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/seguro-carga/apolices
cadastrarAtualizarApoliceSeguroCargaBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Registra ou atualiza apólice de Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023; não se trata de seguro de crédito) com vínculo opcional à credencial AT&M.

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

Dados da apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC).

application/json

policy_modelstringOpcional
"provider_own" · "fleetpay_managed"
policy_typestringOpcional

Ramo da apólice (ex: rctrc, rcdc).

policy_numberstringObrigatório
insurer_namestringObrigatório
insurer_cnpjstringObrigatório

CNPJ da seguradora com 14 dígitos.

atm_credential_idinteger | nullOpcional

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"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

Dados obrigatórios da apólice inválidos.

Definição Completa da Operação
{
  "tags": [
    "Seguro de Carga"
  ],
  "operationId": "cadastrarAtualizarApoliceSeguroCarga",
  "summary": "Cadastrar ou atualizar apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
  "description": "Registra ou atualiza apólice de Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023; não se trata de seguro de crédito) com vínculo opcional à credencial AT&M.",
  "requestBody": {
    "required": true,
    "description": "Dados da apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC).",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "policy_number",
            "insurer_name",
            "insurer_cnpj"
          ],
          "properties": {
            "policy_model": {
              "type": "string",
              "enum": [
                "provider_own",
                "fleetpay_managed"
              ]
            },
            "policy_type": {
              "type": "string",
              "description": "Ramo da apólice (ex: rctrc, rcdc)."
            },
            "policy_number": {
              "type": "string"
            },
            "insurer_name": {
              "type": "string"
            },
            "insurer_cnpj": {
              "type": "string",
              "description": "CNPJ da seguradora com 14 dígitos."
            },
            "atm_credential_id": {
              "type": [
                "integer",
                "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": "Dados obrigatórios da apólice inválidos."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "seguro-carga",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "embarcador",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/seguro-carga/apolices",
  "parameters": []
}