Máquinas e equipamentos

Máquinas e Equipamentos

O seguro Pottencial Máquinas e Equipamentos foi desenvolvido para proteger os mais diversos tipos de equipamentos, seja qual for o negócio ou atividade da empresa – agronegócio, indústria ou serviços.

As APIs da Pottencial permitem que sua empresa realize cotações, propostas e emissões de apólices para os produtos da Pottencial de forma integrada, rápida e segura.

O fluxo para emissão de uma apólice está descrito em passos simples abaixo:

Passo 1 - Autenticação: Gere um token de autenticação a partir de sua chave de acesso. Esse token será necessário nas demais operações.
Passo 2 - Solicitar cotação: Envie os dados da cotação e receba os valores do prêmio para os dados informados.
Passo 3 - Enviar proposta: Quando a cotação estiver pronta, envie os dados para criar uma proposta.
Passo 4 - Aceitar proposta: Aceite a proposta criada.
Passo 5 - Emitir apólice: Com a proposta aceita, emita sua apólice.

O fluxo para emissão de uma apólice de endosso está descrito em passos simples abaixo:

Passo 1 - Autenticação: Gere um token de autenticação a partir de sua chave de acesso. Esse token será necessário nas demais operações.
Passo 2 - Solicitar cotação: Envie os dados da cotação e receba os valores do prêmio para os dados informados.
Passo 3 - Enviar proposta: Quando a cotação estiver pronta, envie os dados para criar uma proposta.
Passo 4 - Aceitar proposta: Aceite a proposta criada.
Passo 5 - Emitir apólice: Com a proposta aceita, emita sua apólice.

O fluxo para emissão para cancelamento de uma apólice está descrito em passos simples abaixo:

Passo 1 - Autenticação: Gere um token de autenticação a partir de sua chave de acesso. Esse token será necessário nas demais operações.
Passo 2 - Listar motivos de cancelamento: Escolha um dos motivos para realizar o cancelamento.
Passo 3 - Enviar proposta: Enviar proposta: Envie os dados para criar uma proposta e receba o documento da proposta.
Passo 4 - Aceitar proposta: Aceitar proposta: Depois de verificar o documento de proposta aceite a proposta criada.
Passo 5 - Emitir apólice: Com a proposta aceita, emita o cancelamento de apólice.

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.

Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Cotações

Solicitar cotação

Permite solicitar uma nova cotação para um produto Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/quotes
Method	POST
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Quote

Exemplo

{
       "policyPeriodStart": "2025-01-28",
       "policyPeriodEnd": "2026-01-28",
       "policyType": "ItemByItem",
       "discountPercentage": 0.0,
       "commercialLoadingFee": 0.0,
       "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f",
       "commissionedAgents": [
           {
               "role": "Broker",
               "commissionPercentage": 0.10,
               "lead": true,
               "isPayer": false,
               "documentNumber": "11112220000999"
           },
           {
               "role": "PolicyOwner",
               "commissionPercentage": 0.10,
               "lead": false,
               "isPayer": false,
               "documentNumber": "44443330000888"
           }
       ],
       "participants": [
           {
               "documentNumber": "00077766600",
               "name": "INSURED NAME",
               "role": "Insured",
               "isPayer": true,
               "address": {
                    "type": "Residential",
                    "zipCode": "30380403",
                    "street": "Av. Raja Gabáglia",
                    "number": "1143",
                    "complement": "19º andar",
                    "district": "Luxemburgo",
                    "city": "BELO HORIZONTE",
                    "state": "MG"
                },
               "contact": {
                   "name": "Insured",
                   "email": "[email protected]",
                   "phoneNumber": "31988554422"
               }
           },
           {
               "documentNumber": "00044455500",
               "name": "BENEFICIARY NAME",
               "role": "Beneficiary",
               "isPayer": false,
               "participationPercentage": 1.0,
               "address": {
                    "type": "Residential",
                    "zipCode": "30380403",
                    "street": "Av. Raja Gabáglia",
                    "number": "1143",
                    "complement": "19º andar",
                    "district": "Luxemburgo",
                    "city": "BELO HORIZONTE",
                    "state": "MG"
                },
               "contact": {
                   "name": "Beneficiary",
                   "email": "[email protected]",
                   "phoneNumber": "31988554422"
               }
           }
       ],
       "riskObjects": [
           {
               "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
               "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
               "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
               "financed": false,
               "ownerOperator": false,
               "equipmentCanBeRented": false,
               "coverages": [
                   {
                       "key": "basica",
                       "insuredAmount": 3000000
                   },
                   {
                       "key": "danos-eletricos",
                       "insuredAmount": 10000,
                       "feeMultiple": 1
                   }
               ],
               "riskObjectDetails": {
                   "model": "MINDRAY DO BRASIL - COM E DISTRDE EQUIPAMENTOS MEDICOS LTDA",
                   "year": 2020,
                   "serialNumber": "123464547775463243423"
                   "chassis": "0004531231354664"
               },
               "riskLocation": {
                   "address": {
                       "street": "RUA JOÃO FLORIANO MARTINS ",
                       "number": "374",
                       "district": "centro",
                       "city": "Taguaí",
                       "state": "SP",
                       "zipCode": "18890009",
                       "complement": "casa A"
                   }
               },
               "invoice": {
                   "number": "31312313131",
                   "date": "2024-12-24"
               },
               "holdings": [
                   {
                       "documentNumber": "00044455500"
                   }
               ]
           }
       ],
       "paymentConditions": {
           "paymentType": "Boleto",
           "installments": 4
       }
}

Resposta (Response)

Status	Descrição	Tipo
200	Cotação cadastrada com sucesso.	Quote
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "quoteId": "ca1a10a-a1a1-4887-a1a1-f5e6a1a18z",
  "quoteNumber": 19198,
  "policyType": "ItemByItem",
  "createdAt": "2025-01-01T08:00:00",
  "status": "Approved",
  "commercialPremium": 1360452,
  "grossPremium": 1460853.36,
  "iof": 100401.36,
  "commissionedAgents": [
      {
          "name": "CORRETORA DE SEGUROS LTDA",
          "documentNumber": "10***6900001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": true,
          "participationPercentage": 0,
          "isPayer": false
      },
      {
          "name": "Empresa X S.A.",
          "documentNumber": "48***5520001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": false,
          "participationPercentage": 0,
          "isPayer": false
      }
  ],
  "participants": [
      {
          "documentNumber": "100***866**",
          "name": "INSURED NAME",
          "role": "Insured",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "isPayer": true,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      },
      {
          "documentNumber": "075***266**",
          "name": "BENEFICIARY NAME",
          "role": "Beneficiary",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "participationPercentage": 0.333333333,
          "isPayer": false,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      }
  ],
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "policyPeriodStart": "2025-01-01T08:00:00",
  "policyPeriodEnd": "2026-01-01T08:00:00",
  "riskObjects": [
      {
          "riskId": "988551a-1103-4242-1103-ad56c110312",
          "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
          "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
          "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
          "financed": false,
          "ownerOperator": false,
          "equipmentCanBeRented": false,
          "coverages": [
              {
                  "key": "basica",
                  "insuredAmount": 3000000,
                  "lmi": 3000000,
                  "price": 30000,
                  "pos": 0.1,
                  "description": "10% dos prejuízos com o mínimo de R$ 30000,00 por evento.",
                  "commercialPremium": 1173000,
                  "grossPremium": 1259567.41
              }
          ],
          "riskObjectDetails": {
              "manufacture": "Agrale",
              "name": "Abafador (Ruído)",
              "model": "MINDRAY DO BRASIL - COM E DISTRDE EQUIPAMENTOS MEDICOS LTDA",
              "year": 2020,
              "serialNumber": "123464547775463243423"
          },
          "riskLocation": {
              "address": {
                  "street": "RUA JOÃO FLORIANO MARTINS ",
                  "number": "374",
                  "district": "centro",
                  "city": "Taguaí",
                  "state": "SP",
                  "zipCode": "18890009",
                  "complement": "casa A"
              }
          },
          "invoice": {
              "number": "3131231",
              "date": "2024-12-24T00:00:00"
          },
          "holdings": [
              {
                  "documentNumber": "075***266**"
              }
          ]
      }
  ],
  "type": "Issuance",
  "paymentConditions": {
      "paymentType": "Boleto",
      "installments": 4
  },
  "partners": [
      {
          "documentNumber": "39***7490001**",
          "role": "Advisor",
          "name": "TESTE DE CORRETAGEM DE SEGUROS LTDA"
      }
  ],
  "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f"
}

Criar cotação de endosso

Essa operação permite criar um endosso para alterações, inclusões e exclusões em apólices de Riscos Diversos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/quotes/endorsement/{policyId}
Method	POST
	policyId	ID da apólice para criação do endosso.
Headers	x-person-id	X-person-id (obrigatório).
	x-person-role	X-person-role (obrigatório).
	x-product-key	X-product-key (obrigatório).
	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	EndorsementQuoteRequest

Resposta (Response)

Status	Descrição	Tipo
200	Cotação de endosso criada com sucesso.	EndorsementQuoteResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Apólice não encontrada.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo de Requisição

{
  "documentPeriodStart": "2021-09-01",
  "documentPeriodEnd": "2022-08-03",
  "discountPercentage": 5.0,
  "commercialLoadingFee": 0,
  "externalControlNumber": "END-2021-001",
  "participants": [
    {
      "documentNumber": "12345678901",
      "name": "EMPRESA SEGURADA LTDA",
      "role": "Insured",
      "isPayer": true,
      "participationPercentage": 100.0,
      "address": {
        "type": "Business",
        "street": "Av. Paulista",
        "number": "1000",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310100",
        "complement": "Sala 1001"
      },
      "contact": {
        "name": "João Silva",
        "email": "[email protected]",
        "phoneNumber": "11999887766"
      }
    }
  ],
  "riskObjects": [
    {
      "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
      "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
      "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
      "financed": false,
      "ownerOperator": false,
      "equipmentCanBeRented": false,
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": 250000.00
        },
        {
          "key": "danos-eletricos",
          "insuredAmount": 35000.00,
          "feeMultiple": 1
        }
      ],
      "riskId": "e861b71c-03d8-4166-85a0-7d4e0e495e0c",
      "riskObjectDetails": {
        "model": "TK890",
        "year": 2022,
        "serialNumber": "2181063"
      },
      "riskLocation": {
        "nationalCoverage": false,
        "address": {
          "street": "RUA LUIZ SCOTT",
          "number": "920",
          "district": "JARDIM IRACEMAALDEIA",
          "city": "BARUERI",
          "state": "SP",
          "zipCode": "06440260",
          "country": "BRA"
        }
      },
      "holdings": [
        {
          "documentNumber": "14437322657"
        }
      ]
    }
  ],
  "paymentConditions": {
    "paymentType": "CreditCard",
    "installments": 1
  }
}

Exemplo de Resposta

{
  "quoteId": "quote-endosso-123-456",
  "quoteNumber": 1,
  "productId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
  "key": "maquinas-equipamentos",
  "policyType": "ItemByItem",
  "createdAt": "2021-09-01T10:30:00.000Z",
  "status": "CREATED",
  "commercialPremium": 1292407.60,
  "grossPremium": 1388787.01,
  "iof": 96379.41,
  "commissionedAgents": [
    {
      "documentNumber": "111***999**",
      "role": "Broker",
      "commissionPercentage": 0.10,
      "participationPercentage": 1.0,
      "commissionAmount": 129240.76,
      "personId": "person-123-456",
      "lead": true,
      "name": "CORRETORA DE SEGUROS LTDA"
    }
  ],
  "participants": [
    {
      "documentNumber": "123***789**",
      "participationPercentage": 0,
      "role": "Insured",
      "address": {
        "street": "Av. Paulista",
        "number": "1000",
        "complement": "Sala 1001",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310100",
        "country": "BR"
      },
      "phoneNumber": "11999887766",
      "email": "[email protected]",
      "personId": "person-789-abc",
      "name": "EMPRESA SEGURADA LTDA",
      "contact": {
        "name": "João Silva",
        "email": "[email protected]",
        "phoneNumber": "11999887766",
        "cellPhoneNumber": "11999887766"
      },
      "isPayer": true,
      "emails": [
        "[email protected]"
      ],
      "phones": [
        "11999887766"
      ],
      "type": "Individual"
    }
  ],
  "discountPercentage": 5.0,
  "commercialLoadingFee": 0,
  "policyPeriodStart": "2021-08-03",
  "policyPeriodEnd": "2022-08-03",
  "documentPeriodStart": "2021-09-01",
  "documentPeriodEnd": "2022-08-03",
  "riskObjects": [
    {
      "type": "Equipment",
      "riskId": "risk-123-456",
      "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
      "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
      "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
      "financed": false,
      "ownerOperator": true,
      "equipmentCanBeRented": false,
      "coverages": [
        {
          "id": "cov-123",
          "lmi": 3000000,
          "insuredAmount": 3000000,
          "key": "basic-coverage",
          "feeMultiple": 1.0,
          "indemnityPeriod": 0,
          "coverageId": "coverage-basic",
          "price": 1292407.60,
          "pos": 1,
          "description": "Cobertura Básica"
        }
      ],
      "riskObjectDetails": {
        "manufacture": "Caterpillar",
        "model": "320D",
        "year": 2020,
        "serialNumber": "CAT320D123456",
        "chassis": "CAT320DCHASSIS"
      },
      "riskLocation": {
        "nationalCoverage": true,
        "address": {
          "street": "Av. Industrial",
          "number": "500",
          "complement": "Galpão 1",
          "district": "Distrito Industrial",
          "city": "São Paulo",
          "state": "SP",
          "zipCode": "08000000",
          "country": "BR"
        }
      },
      "invoice": {
        "number": "NF-2021-001",
        "date": "2021-07-01"
      },
      "holdings": [
        {
          "documentNumber": "123***789**"
        }
      ],
      "insuranceRiskType": "Standard"
    }
  ],
  "productKey": "maquinas-equipamentos-key",
  "type": "Endorsement",
  "createdBy": "sistema-automatico",
  "channel": "Digital",
  "underwritingStatus": "Approved",
  "quoteStatus": "Created",
  "pricingId": "pricing-123-456",
  "pricingResponseDate": "2021-09-01T10:30:00.000Z",
  "quoteSequential": 1,
  "paymentConditions": {
    "paymentType": "CreditCard",
    "installments": 1,
    "firstInstallmentPaymentType": "CreditCard"
  },
  "insurers": [
    "Pottencial Seguradora"
  ],
  "requiredCompanyAcceptance": false,
  "financialAmount": 0,
  "partners": {
    "documentNumber": "111***999**",
    "role": "Advisor",
    "name": "CORRETORA DE SEGUROS LTDA"
  },
  "externalControlNumber": "END-2021-001"
}

Atualizar cotação de endosso

Essa operação permite atualizar uma cotação de endosso existente para alterações, inclusões e exclusões em apólices de Riscos Diversos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/quotes/endorsement/{quoteId}
Method	PUT
	quoteId	ID da cotação de endosso para atualização.
Headers	x-person-id	X-person-id (obrigatório).
	x-person-role	X-person-role (obrigatório).
	x-product-key	X-product-key (obrigatório).
	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	EndorsementQuoteUpdateRequest

Resposta (Response)

Status	Descrição	Tipo
200	Cotação de endosso atualizada com sucesso.	EndorsementQuoteResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Cotação não encontrada.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo de Requisição

{
  "policyId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "documentPeriodStart": "2021-09-01",
  "documentPeriodEnd": "2022-08-03",
  "discountPercentage": 7.5,
  "commercialLoadingFee": 0,
  "externalControlNumber": "END-2021-001-UPD",
  "participants": [
    {
      "documentNumber": "12345678901",
      "name": "EMPRESA SEGURADA LTDA",
      "role": "Insured",
      "isPayer": true,
      "participationPercentage": 100.0,
      "address": {
        "type": "Business",
        "street": "Av. Paulista",
        "number": "1000",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310100",
        "complement": "Sala 1001"
      },
      "contact": {
        "name": "João Silva",
        "email": "[email protected]",
        "phoneNumber": "11999887766"
      }
    }
  ],
  "riskObjects": [
    {
      "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
      "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
      "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
      "financed": false,
      "ownerOperator": false,
      "equipmentCanBeRented": false,
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": 250000.00
        },
        {
          "key": "danos-eletricos",
          "insuredAmount": 35000.00,
          "feeMultiple": 1
        }
      ],
      "riskId": "e861b71c-03d8-4166-85a0-7d4e0e495e0c",
      "riskObjectDetails": {
        "model": "TK890",
        "year": 2022,
        "serialNumber": "2181063"
      },
      "riskLocation": {
        "nationalCoverage": false,
        "address": {
          "street": "RUA LUIZ SCOTT",
          "number": "920",
          "district": "JARDIM IRACEMAALDEIA",
          "city": "BARUERI",
          "state": "SP",
          "zipCode": "06440260",
          "country": "BRA"
        }
      },
      "holdings": [
        {
          "documentNumber": "14437322657"
        }
      ]
    }
  ],
  "paymentConditions": {
    "paymentType": "CreditCard",
    "installments": 1
  }
}

Exemplo de Resposta

{
  "quoteId": "quote-endosso-123-456",
  "quoteNumber": 1,
  "productId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
  "key": "maquinas-equipamentos",
  "policyType": "ItemByItem",
  "createdAt": "2021-09-01T10:30:00.000Z",
  "status": "UPDATED",
  "commercialPremium": 1250385.20,
  "grossPremium": 1342915.38,
  "iof": 92530.18,
  "commissionedAgents": [
    {
      "documentNumber": "111***999**",
      "role": "Broker",
      "commissionPercentage": 0.10,
      "participationPercentage": 1.0,
      "commissionAmount": 125038.52,
      "personId": "person-123-456",
      "lead": true,
      "name": "CORRETORA DE SEGUROS LTDA"
    }
  ],
  "participants": [
    {
      "documentNumber": "123***789**",
      "participationPercentage": 0,
      "role": "Insured",
      "address": {
        "street": "Av. Paulista",
        "number": "1000",
        "complement": "Sala 1001",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310100",
        "country": "BR"
      },
      "phoneNumber": "11999887766",
      "email": "[email protected]",
      "personId": "person-789-abc",
      "name": "EMPRESA SEGURADA LTDA",
      "contact": {
        "name": "João Silva",
        "email": "[email protected]",
        "phoneNumber": "11999887766",
        "cellPhoneNumber": "11999887766"
      },
      "isPayer": true,
      "emails": [
        "[email protected]"
      ],
      "phones": [
        "11999887766"
      ],
      "type": "Individual"
    }
  ],
  "discountPercentage": 7.5,
  "commercialLoadingFee": 0,
  "policyPeriodStart": "2021-08-03",
  "policyPeriodEnd": "2022-08-03",
  "documentPeriodStart": "2021-09-01",
  "documentPeriodEnd": "2022-08-03",
  "riskObjects": [
    {
      "type": "Equipment",
      "riskId": "risk-123-456",
      "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
      "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
      "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
      "financed": false,
      "ownerOperator": true,
      "equipmentCanBeRented": false,
      "coverages": [
        {
          "id": "cov-123",
          "lmi": 3000000,
          "insuredAmount": 3000000,
          "key": "basic-coverage",
          "feeMultiple": 1.0,
          "indemnityPeriod": 0,
          "coverageId": "coverage-basic",
          "price": 1250385.20,
          "pos": 1,
          "description": "Cobertura Básica"
        }
      ],
      "riskObjectDetails": {
        "manufacture": "Caterpillar",
        "model": "320D",
        "year": 2020,
        "serialNumber": "CAT320D123456",
        "chassis": "CAT320DCHASSIS"
      },
      "riskLocation": {
        "nationalCoverage": true,
        "address": {
          "street": "Av. Industrial",
          "number": "500",
          "complement": "Galpão 1",
          "district": "Distrito Industrial",
          "city": "São Paulo",
          "state": "SP",
          "zipCode": "08000000",
          "country": "BR"
        }
      },
      "invoice": {
        "number": "NF-2021-001",
        "date": "2021-07-01"
      },
      "holdings": [
        {
          "documentNumber": "123***789**"
        }
      ],
      "insuranceRiskType": "Standard"
    }
  ],
  "productKey": "maquinas-equipamentos-key",
  "type": "Endorsement",
  "createdBy": "sistema-automatico",
  "channel": "Digital",
  "underwritingStatus": "Approved",
  "quoteStatus": "Updated",
  "pricingId": "pricing-123-456",
  "pricingResponseDate": "2021-09-01T10:30:00.000Z",
  "quoteSequential": 1,
  "paymentConditions": {
    "paymentType": "CreditCard",
    "installments": 1,
    "firstInstallmentPaymentType": "CreditCard"
  },
  "insurers": [
    "Pottencial Seguradora"
  ],
  "requiredCompanyAcceptance": false,
  "financialAmount": 0,
  "partners": {
    "documentNumber": "111***999**",
    "role": "Advisor",
    "name": "CORRETORA DE SEGUROS LTDA"
  },
  "externalControlNumber": "END-2021-001-UPD"
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/quotes/{quote_id}
Method	GET
Query	quote_id	ID da cotação para consulta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Cotação cadastrada com sucesso.	Quote
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "quoteId": "ca1a10a-a1a1-4887-a1a1-f5e6a1a18z",
  "quoteNumber": 19198,
  "policyType": "ItemByItem",
  "createdAt": "2025-01-01T08:00:00",
  "status": "Approved",
  "commercialPremium": 1360452,
  "grossPremium": 1460853.36,
  "iof": 100401.36,
  "commissionedAgents": [
      {
          "name": "CORRETORA DE SEGUROS LTDA",
          "documentNumber": "10***6900001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": true,
          "participationPercentage": 0,
          "isPayer": false
      },
      {
          "name": "Empresa X S.A.",
          "documentNumber": "48***5520001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": false,
          "participationPercentage": 0,
          "isPayer": false
      }
  ],
  "participants": [
      {
          "documentNumber": "100***866**",
          "name": "INSURED NAME",
          "role": "Insured",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "isPayer": true,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      },
      {
          "documentNumber": "075***266**",
          "name": "BENEFICIARY NAME",
          "role": "Beneficiary",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "participationPercentage": 0.333333333,
          "isPayer": false,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      }
  ],
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "policyPeriodStart": "2025-01-01T08:00:00",
  "policyPeriodEnd": "2026-01-01T08:00:00",
  "riskObjects": [
      {
          "riskId": "988551a-1103-4242-1103-ad56c110312",
          "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
          "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
          "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
          "financed": false,
          "ownerOperator": false,
          "equipmentCanBeRented": false,
          "coverages": [
              {
                  "key": "basica",
                  "insuredAmount": 3000000,
                  "lmi": 3000000,
                  "price": 30000,
                  "pos": 0.1,
                  "description": "10% dos prejuízos com o mínimo de R$ 30000,00 por evento.",
                  "commercialPremium": 1173000,
                  "grossPremium": 1259567.41
              }
          ],
          "riskObjectDetails": {
              "manufacture": "Agrale",
              "name": "Abafador (Ruído)",
              "model": "MINDRAY DO BRASIL - COM E DISTRDE EQUIPAMENTOS MEDICOS LTDA",
              "year": 2020,
              "serialNumber": "123464547775463243423"
          },
          "riskLocation": {
              "address": {
                  "street": "RUA JOÃO FLORIANO MARTINS ",
                  "number": "374",
                  "district": "centro",
                  "city": "Taguaí",
                  "state": "SP",
                  "zipCode": "18890009",
                  "complement": "casa A"
              }
          },
          "invoice": {
              "number": "3131231",
              "date": "2024-12-24T00:00:00"
          },
          "holdings": [
              {
                  "documentNumber": "075***266**"
              }
          ]
      }
  ],
  "type": "Issuance",
  "paymentConditions": {
      "paymentType": "Boleto",
      "installments": 4
  },
  "partners": [
      {
          "documentNumber": "39***7490001**",
          "role": "Advisor",
          "name": "TESTE DE CORRETAGEM DE SEGUROS LTDA"
      }
  ],
  "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f"
}

Atualizar cotação

Permite atualizar os dados de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/quotes/{quote_id}
Method	PUT
Query	quote_id	ID da cotação para atualização.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Quote

Exemplo

{
       "policyPeriodStart": "2025-01-28",
       "policyPeriodEnd": "2026-01-28",
       "policyType": "ItemByItem",
       "discountPercentage": 0.0,
       "commercialLoadingFee": 0.0,
       "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f",
       "commissionedAgents": [
           {
               "role": "Broker",
               "commissionPercentage": 0.10,
               "lead": true,
               "isPayer": false,
               "documentNumber": "11112220000999"
           },
           {
               "role": "PolicyOwner",
               "commissionPercentage": 0.10,
               "lead": false,
               "isPayer": false,
               "documentNumber": "44443330000888"
           }
       ],
       "participants": [
           {
               "documentNumber": "00077766600",
               "name": "INSURED NAME",
               "role": "Insured",
               "isPayer": true,
               "address": {
                    "id": "711031a-1103-4242-1103-ad56c110312",
                    "type": "Residential",
                    "zipCode": "30380403",
                    "street": "Av. Raja Gabáglia",
                    "number": "1143",
                    "complement": "19º andar",
                    "district": "Luxemburgo",
                    "city": "BELO HORIZONTE",
                    "state": "MG"
                },
                "contact": {
                    "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
                    "phoneNumber": "31988554422",
                    "emailId": "988551a-1103-4242-1103-ad56c110312",
                    "email": "[email protected]"
                }
           },
           {
               "documentNumber": "00044455500",
               "name": "BENEFICIARY NAME",
               "role": "Beneficiary",
               "isPayer": false,
               "participationPercentage": 1.0,
               "address": {
                  "id": "711031a-1103-4242-1103-ad56c110312",
                  "type": "Residential",
                  "zipCode": "30380403",
                  "street": "Av. Raja Gabáglia",
                  "number": "1143",
                  "complement": "19º andar",
                  "district": "Luxemburgo",
                  "city": "BELO HORIZONTE",
                  "state": "MG"
                },
                "contact": {
                  "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
                  "phoneNumber": "31988554422",
                  "emailId": "988551a-1103-4242-1103-ad56c110312",
                  "email": "[email protected]"
                }
           }
       ],
       "riskObjects": [
           {
               "riskId": "988551a-1103-4242-1103-ad56c110312",
               "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
               "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
               "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
               "financed": false,
               "ownerOperator": false,
               "equipmentCanBeRented": false,
               "coverages": [
                   {
                       "key": "basica",
                       "insuredAmount": 3000000
                   },
                   {
                       "key": "danos-eletricos",
                       "insuredAmount": 10000,
                       "feeMultiple": 1
                   }
               ],
               "riskObjectDetails": {
                   "model": "MINDRAY DO BRASIL - COM E DISTRDE EQUIPAMENTOS MEDICOS LTDA",
                   "year": 2020,
                   "serialNumber": "123464547775463243423"
                   "chassis": "0004531231354664"
               },
               "riskLocation": {
                   "address": {
                       "street": "RUA JOÃO FLORIANO MARTINS ",
                       "number": "374",
                       "district": "centro",
                       "city": "Taguaí",
                       "state": "SP",
                       "zipCode": "18890009",
                       "complement": "casa A"
                   }
               },
               "invoice": {
                   "number": "31312313131",
                   "date": "2024-12-24"
               },
               "holdings": [
                   {
                       "documentNumber": "00044455500"
                   }
               ]
           }
       ],
       "paymentConditions": {
           "paymentType": "Boleto",
           "installments": 4
       }
}

Resposta (Response)

Status	Descrição	Tipo
200	Cotação cadastrada com sucesso.	Quote
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "quoteId": "ca1a10a-a1a1-4887-a1a1-f5e6a1a18z",
  "quoteNumber": 19198,
  "policyType": "ItemByItem",
  "createdAt": "2025-01-01T08:00:00",
  "status": "Approved",
  "commercialPremium": 1360452,
  "grossPremium": 1460853.36,
  "iof": 100401.36,
  "commissionedAgents": [
      {
          "name": "CORRETORA DE SEGUROS LTDA",
          "documentNumber": "10***6900001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": true,
          "participationPercentage": 0,
          "isPayer": false
      },
      {
          "name": "Empresa X S.A.",
          "documentNumber": "48***5520001**",
          "role": "Broker",
          "commissionPercentage": 0.1,
          "commissionAmount": 680,
          "lead": false,
          "participationPercentage": 0,
          "isPayer": false
      }
  ],
  "participants": [
      {
          "documentNumber": "100***866**",
          "name": "INSURED NAME",
          "role": "Insured",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "isPayer": true,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      },
      {
          "documentNumber": "075***266**",
          "name": "BENEFICIARY NAME",
          "role": "Beneficiary",
          "address": {
              "id": "711031a-1103-4242-1103-ad56c110312",
              "type": "Residential",
              "zipCode": "30380403",
              "street": "Av. Raja Gabáglia",
              "number": "1143",
              "complement": "19º andar",
              "district": "Luxemburgo",
              "city": "BELO HORIZONTE",
              "state": "MG"
          },
          "participationPercentage": 0.333333333,
          "isPayer": false,
          "contact": {
              "phoneNumberId": "4242031a-1103-4242-1103-ad56c110312",
              "phoneNumber": "31988554422",
              "emailId": "988551a-1103-4242-1103-ad56c110312",
              "email": "[email protected]"
          }
      }
  ],
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "policyPeriodStart": "2025-01-01T08:00:00",
  "policyPeriodEnd": "2026-01-01T08:00:00",
  "riskObjects": [
      {
          "riskId": "988551a-1103-4242-1103-ad56c110312",
          "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
          "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
          "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
          "financed": false,
          "ownerOperator": false,
          "equipmentCanBeRented": false,
          "coverages": [
              {
                  "key": "basica",
                  "insuredAmount": 3000000,
                  "lmi": 3000000,
                  "price": 30000,
                  "pos": 0.1,
                  "description": "10% dos prejuízos com o mínimo de R$ 30000,00 por evento.",
                  "commercialPremium": 1173000,
                  "grossPremium": 1259567.41
              }
          ],
          "riskObjectDetails": {
              "manufacture": "Agrale",
              "name": "Abafador (Ruído)",
              "model": "MINDRAY DO BRASIL - COM E DISTRDE EQUIPAMENTOS MEDICOS LTDA",
              "year": 2020,
              "serialNumber": "123464547775463243423"
          },
          "riskLocation": {
              "address": {
                  "street": "RUA JOÃO FLORIANO MARTINS ",
                  "number": "374",
                  "district": "centro",
                  "city": "Taguaí",
                  "state": "SP",
                  "zipCode": "18890009",
                  "complement": "casa A"
              }
          },
          "invoice": {
              "number": "3131231",
              "date": "2024-12-24T00:00:00"
          },
          "holdings": [
              {
                  "documentNumber": "075***266**"
              }
          ]
      }
  ],
  "type": "Issuance",
  "paymentConditions": {
      "paymentType": "Boleto",
      "installments": 4
  },
  "partners": [
      {
          "documentNumber": "39***7490001**",
          "role": "Advisor",
          "name": "TESTE DE CORRETAGEM DE SEGUROS LTDA"
      }
  ],
  "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f"
}

Consultar documento da cotação

Permite consultar a minuta de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/quotes/{quote_id}/draft
Method	GET
Query	quote_id	ID da cotação para consulta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Documento da cotação localizado com sucesso.	BLOB
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Consultar simulações de pagamento

Permite consultar as simulações de pagamento de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/quotes/{quote_id}/payment-simulations
Method	GET
Query	quote_id	ID da cotação para consulta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Documento da cotação localizado com sucesso.	Lista de PaymentSimulation
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Enviar para análise

Permite enviar a cotação para análise da subscrição.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/quotes/{quote_id}/send-to-analysis
Method	POST
Query	quote_id	ID da cotação para análise.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
201	Cotação enviada para análise com sucesso.
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Propostas

Enviar proposta

Permite submeter uma nova proposta para um produto Pottencial. Para envio de uma proposta é necessário primeiramente ter realizado uma cotação a partir da API de cotação.

Observação: Caso a API retorne os erros "Serial number is required." ou "Chassis required for self-propelled equipment." isso significa que a cotação foi realizada sem o número de série (serialNumber) e/ou chassi (quando aplicável).

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/proposals
Method	POST
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Proposal

Exemplo

{
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "policyPeriodStart": "2025-01-01",
  "policyPeriodEnd": "2026-01-01",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1",
    "firstInstallmentDueDateDelay": "7"
    "paymentInstructions": "Informações da forma de pagamento"
  }
}

Resposta (Response)

Status	Descrição	Tipo
200	Proposta submetida com sucesso.	Proposal
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2025-01-01",
  "policyPeriodEnd": "2026-01-01",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1"
  },
  "createdAt": "2025-01-01",
  "status": "Ready"
}

Enviar proposta de cancelamento

Permite submeter uma proposta de cancelamento para um produto Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/proposals/cancellations
Method	POST
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	ProposalCancellation

Exemplo


{
  "cancellationDate": "string",
  "policyId": "string",
  "cancellationReasonId": "string",
  "financialRestitutionData": {
    "bankNumber": "string",
    "agencyNumber": "string",
    "accountNumber": "string",
    "accountDigit": "string"
  }
}

Resposta (Response)

Status	Descrição	Tipo
201	Proposta submetida com sucesso.	Proposal de cancelamento
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo


{
  "cancellationDate": "2025-08-25",
  "policyId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "cancellationReasonId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "financialRestitutionData": {
    "bankNumber": "001",
    "agencyNumber": "1234",
    "accountNumber": "567890",
    "accountDigit": "1"
  }
}

Aceitar proposta

Permite aprovar uma proposta criada.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/proposals/{proposal_id}/accept
Method	POST
	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Proposta aceita com sucesso.
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Consultar proposta

Essa operação permite consultar os dados de uma proposta a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/proposals/{proposal_id}
Method	GET
Query	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Proposta localizada com sucesso.	Proposal
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2025-01-01",
  "policyPeriodEnd": "2026-01-01",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1"
  },
  "createdAt": "2025-01-01",
  "status": "Ready"
}

Consultar documento da proposta

Essa operação permite consultar o documento de uma proposta a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/proposals/{proposal_id}/document
Method	GET
Query	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	>Documento da proposta localizado com sucesso.	BLOB
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Apólices

Emitir apólice

Permite emitir uma apólice para uma proposta existente. A proposta deve ter sido aceita previamente.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/policies
Method	POST
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Policy

Exemplo

{
  "proposalId": "bddbcd59-213f-4523-a055-7e28f23a4978"
}

Resposta (Response)

Status	Descrição	Tipo
200	Apólice emitida com sucesso.	Policy
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
  "policyPeriodStart": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Creating",
  "createdAt": "2021-08-03T18:11:02.573Z"
}

Consultar apólice

Essa operação permite consultar os dados de uma apólice a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/policies/{policy_id}
Method	GET
	policy_id	ID da apólice.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Apólice localizada com sucesso.	Policy
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
  "policyPeriodStart": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Active",
  "createdAt": "2021-08-03T18:11:02.573Z"
}

Consultar apólice V2

Essa operação permite consultar os dados detalhados de uma apólice a partir do ID. Esta versão retorna informações mais completas da apólice incluindo todos os detalhes financeiros, participantes, objetos de risco e coberturas.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v2/maquinas-equipamentos/policies/{policy_id}
Method	GET
	policy_id	ID da apólice.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Apólice localizada com sucesso.	Policy Details
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
  "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "policyType": "ItemByItem",
  "channel": "Digital",
  "productId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
  "productName": "Maquinas-Equipamentos",
  "productDisplayedName": "Seguro Máquinas e Equipamentos",
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "policyPeriodStart": "2021-08-03",
  "policyPeriodEnd": "2022-08-03",
  "documentPeriodStart": "2021-08-03",
  "documentPeriodEnd": "2022-08-03",
  "issuedBy": "Sistema Automático",
  "issuedAt": "2021-08-03T18:11:02.573Z",
  "status": "Active",
  "policySequential": 1,
  "endorsement": 0,
  "proposalSequential": 1,
  "issuanceType": "Normal",
  "paymentProcessingTime": "Immediate",
  "originalOrderId": "ORD-2021-001",
  "pricingId": "pricing-123-456",
  "documentId": "doc-789-abc",
  "branchOfficeCode": "001",
  "lineCode": "0321",
  "groupCode": "03",
  "policySusepNumber": "15414900321202100000001",
  "policyNumber": "POL-2021-001",
  "iof": 100401.36,
  "financialCharge": 0,
  "grossPremium": 1460853.36,
  "commercialPremium": 1360452,
  "commission": 136045.20,
  "commissionPercentage": 0.10,
  "prolabore": 0,
  "prolaborePercentage": 0,
  "installmentCost": 0,
  "installmentsQuantity": 1,
  "installments": [
    {
      "type": "Premium",
      "dueDate": "2021-08-10",
      "amount": 1460853.36,
      "status": "Paid",
      "number": 1,
      "iofAmount": 100401.36,
      "additionAmount": 0,
      "discountAmount": 0
    }
  ],
  "participants": [
    {
      "choicedName": "EMPRESA SEGURADA LTDA",
      "documentNumber": "123***789**",
      "name": "EMPRESA SEGURADA LTDA",
      "type": "Legal",
      "role": "Insured",
      "isPayer": true,
      "percentage": 0,
      "contact": {
        "phoneNumber": "11999887766",
        "email": "[email protected]"
      },
      "address": {
        "type": "Business",
        "street": "Av. Paulista",
        "number": "1000",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "zipCode": "01310100"
      }
    }
  ],
  "commissionedAgents": [
    {
      "commissionAmount": 136045.20,
      "name": "CORRETORA DE SEGUROS LTDA",
      "type": "Legal",
      "role": "Broker",
      "commissionPercentage": 0.10,
      "lead": true,
      "isPayer": false,
      "documentNumber": "111***999**"
    }
  ],
  "riskObjects": [
    {
      "commercialPremium": 1360452,
      "grossPremium": 1460853.36,
      "iof": 100401.36,
      "financialCharge": 0,
      "installmentCost": 0,
      "financialRefundAmount": 0,
      "coverages": [
        {
          "type": "Basic",
          "name": "Cobertura Básica",
          "description": "Cobertura básica para danos ao equipamento",
          "line": {
            "code": "0321",
            "group": {
              "code": "03"
            }
          },
          "commercialPremium": 1360452,
          "grossPremium": 1460853.36,
          "iof": 100401.36,
          "financialCharge": 0,
          "installmentCost": 0,
          "insuredAmount": 3000000,
          "equipmentAmount": 3000000,
          "lmi": 3000000,
          "deductible": {
            "value": 30000,
            "percent": 0.10,
            "description": "10% dos prejuízos com o mínimo de R$ 30.000,00",
            "sourceType": "Percentage",
            "susepDeductibleCodeType": "01",
            "participationType": "Minimum",
            "minimumType": "Fixed",
            "minimumValue": 30000,
            "includesTotalLoss": false
          }
        }
      ],
      "riskId": "risk-123-456",
      "riskVersion": "1.0",
      "sortSequence": 1,
      "type": "Equipment",
      "properties": {
        "type": "EquipmentProperties",
        "riskObject": {
          "category": 1,
          "name": "Escavadeira Hidráulica",
          "manufacture": "Caterpillar",
          "model": "320D",
          "year": 2020,
          "serialNumber": "CAT320D123456"
        },
        "operatesOnWater": false,
        "performsPeriodicMaintenance": true,
        "operatorsAreTrained": true,
        "equipmentCanBeRented": false,
        "invoice": {},
        "beneficiaries": [
          "123***789**"
        ],
        "equipmentTypeId": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
        "utilizationId": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
        "manufacturerId": "e6a98888-fc7e-4e23-8097-448d982e262f",
        "financed": false,
        "ownerOperator": true,
        "utilizationName": "Construção Civil",
        "restricted": false,
        "insuranceRiskType": "Standard",
        "riskUF": "SP",
        "riskLocation": {}
      }
    }
  ],
  "clauses": [
    {
      "description": "Cláusula de Cobertura Básica",
      "type": "Coverage",
      "text": "Esta cláusula estabelece as condições da cobertura básica...",
      "default": true
    }
  ],
  "insurers": [
    {
      "lead": true,
      "participationPercentage": 1.0,
      "leadPolicyNumber": "POL-2021-001",
      "leadPolicyIssuedAt": "2021-08-03T18:11:02.573Z",
      "name": "Pottencial Seguradora",
      "type": "Lead"
    }
  ],
  "externalControlNumber": "e6a98888-fc7e-4e23-8097-448d982e262f",
  "holdings": [
    {
      "riskId": "risk-123-456",
      "documentNumber": "123***789**"
    }
  ],
  "deductibleType": "Percentage",
  "commercialConditionsId": "cc-789-def"
}

Consultar documento da apólice

Essa operação permite consultar o documento de uma apólice a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/policies/{policy_id}/document
Method	GET
	policy_id	ID da apólice.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Resposta (Response)

Status	Descrição	Tipo
200	Documento da apólice localizado com sucesso.	BLOB
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Dicionário

Quote

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Somente leitura	ID único da cotação que a identifica dentro da Pottencial. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso. Ele deve ser armazenado pois é utilizado nas demais operações de consulta e proposta.
quoteNumber	number	Somente leitura	Número da Cotação.
policyType	string (PolicyType)	Somente leitura	Tipo de contratação da apólice, que no caso do produto Máquinas e Equipamentos é ItemByItem
createdAt	string (date-time)	Somente leitura	Data e hora de criação da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
status	string (QuoteStatus)	Somente leitura	Situação atual da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
commercialPremium	number	Somente leitura	Valor de prêmio considerando-se subscrição e comercial, incluindo valores de comissão e prolabore. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
grossPremium	number	Somente leitura	Valor de prêmio total incluindo, além do prêmio comercial, o IOF e encargos financeiros. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
iof	number	Somente leitura	Valor do IOF da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
commissionedAgents	Lista de CommissionedAgent	Obrigatório	Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes.
participants	Lista de Participant	Obrigatório	Lista de participantes da apólice, que inclui segurado, tomador e beneficiário.
discountPercentage	number	Opcional	Percentual de desconto a ser aplicado no valor do prêmio. O percentual de desconto e a taxa de agravo são mutuamente exclusivos, então somente um deles pode ser informado para uma cotação.
commercialLoadingFee	number	Opcional	Taxa de agravo comercial a ser aplicada no valor do prêmio. O percentual de desconto e a taxa de agravo são mutuamente exclusivos, então somente um deles pode ser informado para uma cotação.
policyPeriodStart	string (date)	Opcional	Data de início de vigência da apólice. A diferença entre o policyPeriodEnd e policyPeriodStart deve ser de 1, 2, 3, 4 ou 5 anos completos.
policyPeriodEnd	string (date)	Opcional	Data do fim de vigência da apólice. A diferença entre o policyPeriodEnd e policyPeriodStart deve ser de 1, 2, 3, 4 ou 5 anos completos.
riskObjects	Lista de Equipment	Obrigatório	Lista de objetos segurados.
productKey	string (uuid)	Somente leitura	chave do produto. A API de produtos deve ser utilizada para recuperar a lista de produtos que estão disponíveis para cotação.
type	string	Somente leitura	Tipo de emissão.
paymentConditions	Payment	Opcional	Condições de pagamento.
partners	Lista de Partners	Somente leitura	Lista de Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.
externalControlNumber	string	Opcional	Número de controle do parceiro para a cotação.

PolicyType

ItemByItem: Contratação item a item.

QuoteStatus

Pending: A cotação foi criada, porém ainda não foi encaminhada para a subscrição.
UnderAnalysis: A cotação está sob análise da subscrição.
Denied: A cotação não foi aprovada.
Approved: A cotação foi aprovada.

CommissionedAgent

Campo	Tipo	Regras	Descrição
name	string	Somente leitura	Nome do agente comissionado.
documentNumber	string	Obrigatório	CPF/CNPJ do agente comissionado. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos visíveis.
role	string (CommissionedAgentRole)	Obrigatório	Papel desempenhado pelo agente comissionado.
commissionPercentage	number	Opcional	Percentual de comissão, no caso de corretora, e percentual de pró-labore, no caso de estipulante. O valor deve ter no máximo 3 casas decimais.
commissionAmount	number	Somente leitura	Valor de comissão no caso de corretora, e valor de pró-labore no caso de estipulante.
lead	boolean	Opcional	Flag que identifica se é a corretora principal na cotação. Esse campo pode ser omitido quando houver somente uma corretora na cotação.
participationPercentage	number	Opcional	Percentual de participação na comissão, no caso de co-corretagem. Quando informado, a soma desse valor para todas as corretoras deve ser igual a 1. O valor deve ter no máximo 3 casas decimais.
isPayer	boolean	Obrigatório	Flag para informar se o participante é o pagador da apólice.

Participant

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do participante. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos visíveis.
participationPercentage	number	Opcional	Percentual do prêmio a que o beneficiário tem direito. O valor deve ter no máximo duas casas decimais e estar entre 0.01 e 1.00. Obrigatório para os beneficiários e a soma da participação de todos os beneficiários deve ser igual a 1.
role	string (ParticipantRole)	Obrigatório	Papel do participante na cotação.
address	Address	Opcional	Endereço do participante.
contact	Contact	Opcional	Contato do participante.
isPayer	boolean	Obrigatório	Flag para informar se o participante é o pagador da apólice.

ParticipantRole

Beneficiary: O beneficiário é a pessoa da apólice que tem direito a indenização do seguro em caso de problema (sinistro). O beneficiário pode ser uma pessoa diferente do segurado (que é quem está com o risco protegido) e do estipulante (que é quem está contratando o seguro), dependendo da situação.
Insured: O segurado é a pessoa, física ou jurídica, cujos interesses estão garantidos pela apólice de seguro. Geralmente é quem contrata o seguro.
PolicyHolder: Devedor das obrigações por ele assumidas no contrato principal. (Circular SUSEP 232/03).

CommissionedAgentRole

Broker: É o profissional especializado e habilitado a intermediar contratos de seguros entre as seguradoras, empresas e os consumidores, sejam eles pessoas físicas ou jurídicas.
PolicyOwner: O estipulante é a pessoa que contrata o seguro, independente se é ele que se beneficia do seguro ou se é ele quem vai receber a indenização. É o estipulante, ou dono da apólice, que preenche e assina a proposta de seguro, paga o prêmio, solicita eventuais modificações durante a vigência da apólice, autoriza a sua renovação, ou solicita o seu cancelamento quando for o caso.
InsuranceAgent: .

Contact

Campo	Tipo	Regras	Descrição
phoneNumberId	string	Somente leitura	Identificador do número de telefone.
phoneNumber	string	Opcional	Número de telefone.
emailId	string	Somente leitura	Identificador do email.
email	string	Opcional	Endereço de e-mail.

Equipment

Campo	Tipo	Regras	Descrição
riskId	string (uuid)	Somente leitura	Identificador do objeto de risco.
equipmentTypeId	string (uuid)	Obrigatório	Identificador do tipo de equipamento.
utilizationId	string (uuid)	Obrigatório	Identificador do tipo de utilização.
manufacturerId	string (uuid)	Opcional	Identificador do fabricante. O campo será obrigatório caso o campo manufacture não seja informado em RiskObjectDetails
financed	boolean	Obrigatório	Flag que indica se o equipamento é financiado.
ownerOperator	boolean	Obrigatório	Flag que indica se o equipamento possui operador.
equipmentCanBeRented	boolean	Obrigatório	Flag que indica se o equipamento poderá ser alugado à terceiros.
coverages	Lista de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
riskObjectDetails	RiskObjectDetails	Obrigatório	Detalhes do equipamento segurado.
riskLocation	RiskLocation	Opcional	Detalhes da localização do equipamento segurado.
invoice	Invoice	Opcional	Detalhes da Nota Fiscal ou Contrato de aquisição do equipamento.
holdings	Lista de Holding	Obrigatório	Beneficiários do seguro do equipamento.

Coverage

Campo	Tipo	Regras	Descrição
key	string	Obrigatório	Chaves existentes Cobertura básica: basica Cobertura Adicional de Furto Simples: furto Cobertura Adicional de perda ou pagamento de aluguel a terceiros: perda-pagamento Cobertura Adicional de Responsabilidade Civil - Máquinas: rc-maquinas Cobertura Adicional de Equipamentos próximos a água: operacao-proxima-agua Cobertura Adicional de Danos Elétricos: danos-eletricos Cobertura Adicional de Responsabilidade Civil - Operador: rc-operador Cobertura Adicional de Furto Parcial: furto-parcial Cobertura Adicional de Queda de Equipamentos: queda-equipamentos
insuredAmount	number	Obrigatório	Importância segurada, ou valor segurado, deste objeto de risco.
lmi	number	Somente leitura	Limite máximo de indenização.
price	number	Somente leitura	Valor da franquia.
pos	number	Somente leitura	Pagamento obrigatório do segurado (em caso de sinistro).
description	string	Somente leitura	Texto descritivo da franquia.
commercialPremium	number	Somente leitura	Valor de prêmio considerando-se subscrição e comercial, incluindo valores de comissão e prolabore. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
grossPremium	number	Somente leitura	Valor de prêmio total incluindo, além do prêmio comercial, o IOF e encargos financeiros. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.

RiskObjectDetails

Campo	Tipo	Regras	Descrição
manufacture	string	Opcional	Fabricante do equipamento.
model	string	Obrigatório	Modelo do equipamento.
year	number (Int32)	Obrigatório	Ano de fabricação do equipamento
serialNumber	string	Opcional	Número de série do equipamento.
chassis	string	Opcional	Chassi do equipamento. Esse campo é obrigatório caso seja um equipamento que tenha chassi.

RiskLocation

Campo	Tipo	Regras	Descrição
nationalCoverage	boolean	Opcional	Identifica se a cobertura do equipamento é para todo o território nacional.
address	Address	Obrigatório	Representa um endereço.

Invoice

Campo	Tipo	Regras	Descrição
number	string	Obrigatório	Número da Nota Fiscal ou Contrato de aquisição do equipamento.
date	string	Obrigatório	Data da Nota Fiscal ou Contrato de aquisição do equipamento.

Holding

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do beneficiário.

Address

Campo	Tipo	Regras	Descrição
street	string	Obrigatório	Logradouro.
number	string	Obrigatório	Número.
district	string	Obrigatório	Bairro.
city	string	Obrigatório	Nome da cidade.
state	string	Obrigatório	Sigla do estado.
zipCode	string	Obrigatório	CEP. Devem ser informados somente os dígitos.
complement	string	Opcional	Complemento. Apartamento, andar.
country	string	Opcional	Sigla do país de origem.
type	string	Opcional	Descrição da localidade Residential: Endereço Residencial. Business: Endereço Empresal. Billing: Endereço de Cobrança.

Partners

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do participante. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos visíveis.
role	string (PartnerRole)	Somente leitura	Papel do parceiro na cotação.
name	string	Somente leitura	Nome do parceiro

PartnerRole

Advisor: Assessor.
CommercialAgent: Representante Comercial.

PaymentSimulation

Campo	Tipo	Regras	Descrição
paymentType	string (PaymentType)	Somente leitura	Forma de pagamento da apólice.
firstInstallmentPaymentType	string (PaymentType)	Somente leitura	Forma de pagamento da primeira parcela da apólice.
minFirstPaymentDate	string	Somente leitura	Data mínima para a primeira parcela.
maxFirstPaymentDate	string	Somente leitura	Data máxima para a primeira parcela.
installments	Lista de Installments	Somente leitura	Lista de parcelamento da forma de pagamento da apólice.

Installments

Campo	Tipo	Regras	Descrição
countInstallments	number	Somente leitura	Quantidade da Parcelas.
commercialAmount	number	Somente leitura	Valor considerando-se subscrição e comercial, incluindo valores de comissão e prolabore.
iofAmount	number	Somente leitura	Valor de IOF.
grossAmount	number	Somente leitura	Valor total incluindo, além do prêmio comercial, o IOF e encargos financeiros.
additionalAmount	number	Somente leitura	Valor dos juros/adicional de fracionamento.
financialChargesAmount	number	Somente leitura	Valor dos encargos financeiros.
installments	Lista de number	Somente leitura	Lista com os valores das parcelas.
installmentDescription	string	Somente leitura	Descrição do parcelamento.

Proposal

Campo	Tipo	Regras	Descrição
proposalId	string (uuid)	Somente leitura	ID único da proposta. O ID será gerado automaticamente no retorno da API.
quoteId	string (uuid)	Obrigatório	ID único da cotação que vai dar origem à proposta.
proposalNumber	number	Opcional	Número da Proposta.
policyPeriodStart	string (date)	Opcional	Data de início de vigência da apólice. Esse valor pode ser omitido caso essa informação tenha sido informada no momento de cotação.
policyPeriodEnd	string (date)	Opcional	Data do fim de vigência da apólice. Esse valor pode ser omitido caso essa informação tenha sido informada no momento de cotação.
payment	Payment	Obrigatório	Detalhes do pagamento da apólice.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da proposta.
status	string (ProposalStatus)	Somente leitura	Situação atual da proposta.

ProposalStatus

Pending: A proposta foi criada, porém ainda não foi definido meio de pagamento.
Ready: O meio de pagamento da proposta foi definido.
Issued: O documento da proposta foi emitido.
Accepted: A proposta foi aceita.

Payment

Campo	Tipo	Regras	Descrição
paymentType	string (PaymentType)	Obrigatório	Forma de pagamento da apólice.
installments	integer	Obrigatório	Número de parcelas que será dividido o pagamento da apólice.
firstInstallmentDueDateDelay	integer	Opcional	Carência para a data de vencimento da primeira parcela, em dias, para pagamento em boleto.
firstDueDate	string	Opcional	Data de vencimento da primeira parcela, para pagamento em boleto.
automaticDebitAccount	BankAccount	Opcional	Dados bancários para pagamento através de débito em conta.

BankAccount

Campo	Tipo	Regras	Descrição
bankCode	string	Obrigatório	Código de compensação do banco, conforme cadastrado no Banco Central.
bankNumber	string	Obrigatório	Número a agência da conta bancária, sem dígito.
accountNumber	string	Obrigatório	Número da conta bancária, sem dígito.
accountDigit	string	Obrigatório	Dígito verificador da conta bancária.
accountExtension	string	Opcional	Letra verificador da conta bancária.
documentNumber	string	Obrigatório	CPF/CNPJ do titular da conta bancária.
accountType	string	Opcional	Tipo da conta Current: Conta Corrente. Savings: Conta Poupança. Payments: Conta Pagamento.

PaymentType

Invoice: Pagamento através de fatura.
Boleto: Pagamento através de boleto.
AutomaticDebit: Pagamento através de débito em conta.

Policy

Campo	Tipo	Regras	Descrição
policyId	string (uuid)	Somente leitura	ID único da apólice. O ID será gerado automaticamente no retorno da API.
proposalId	string (uuid)	Obrigatório	ID único da proposta aceita anteriormente que vai dar origem à apólice.
quoteId	string (uuid)	Somente leitura	ID único da cotação que deu origem à proposta.
policyNumber	string	Somente leitura	Número da apólice.
policyPeriodStart	string (date)	Somente leitura	Data de início de vigência da apólice.
policyPeriodEnd	string (date)	Somente leitura	Data do fim de vigência da apólice.
status	string (PolicyStatus)	Somente leitura	Situação atual da apólice. Esse campo é preenchido automaticamente e retornado quando uma apólice é criada com sucesso.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da apólice. Esse campo é preenchido automaticamente e retornado quando uma apólice é criada com sucesso.

Proposal Cancellation Response

Campo	Tipo	Regras	Descrição
proposalId	string (uuid)	Obrigatório	ID único da proposta. O ID será gerado automaticamente no retorno da API.
proposalNumber	number	Obrigatório	Número da Proposta.
documentUri	string	Obrigatório	URI do documento da proposta.
status	string (ProposalStatus)	Obrigatório	Situação atual da proposta.

Proposal Cancellation

Campo	Tipo	Regras	Descrição
cancellationDate	string (date)	Somente leitura	Data de cancelamento da proposta.
policyId	string (uuid)	Obrigatório	ID único da apólice que vai ser cancelada.
cancellationReasonId	string (uuid)	Obrigatório	ID único do motivo de cancelamento.
financialRestitutionData	financialRestitutionData	Obrigatório	Detalhes da restituição financeira da apólice.

FinancialRestitutionData

Campo	Tipo	Regras	Descrição
bankNumber	string	Obrigatório	Código de compensação do banco, conforme cadastrado no Banco Central.
agencyNumber	string	Obrigatório	Número a agência da conta bancária, sem dígito.
accountNumber	string	Obrigatório	Número da conta bancária, sem dígito.
accountDigit	string	Obrigatório	Dígito verificador da conta bancária.

Policy Details

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Somente leitura	ID único da cotação que originou esta apólice.
policyId	string (uuid)	Somente leitura	ID único da apólice que a identifica dentro da Pottencial.
policyType	string	Somente leitura	Tipo de contratação da apólice (ex: ItemByItem).
channel	string	Somente leitura	Canal de distribuição da apólice.
productId	string (uuid)	Somente leitura	Identificador único do produto.
productName	string	Somente leitura	Nome interno do produto.
productDisplayedName	string	Somente leitura	Nome comercial do produto exibido ao cliente.
proposalId	string (uuid)	Somente leitura	ID único da proposta que originou esta apólice.
policyPeriodStart	string (date)	Somente leitura	Data de início de vigência da apólice.
policyPeriodEnd	string (date)	Somente leitura	Data de fim de vigência da apólice.
documentPeriodStart	string (date)	Somente leitura	Data de início de vigência do documento.
documentPeriodEnd	string (date)	Somente leitura	Data de fim de vigência do documento.
issuedBy	string	Somente leitura	Identificação de quem emitiu a apólice.
issuedAt	string (date-time)	Somente leitura	Data e hora de emissão da apólice.
status	string	Somente leitura	Status atual da apólice (Active, Cancelled, Expired, etc.).
policySequential	number	Somente leitura	Número sequencial da apólice.
endorsement	number	Somente leitura	Número do endosso, sendo 0 para a apólice original.
proposalSequential	number	Somente leitura	Número sequencial da proposta.
issuanceType	string	Somente leitura	Tipo de emissão da apólice.
paymentProcessingTime	string	Somente leitura	Tempo de processamento do pagamento.
originalOrderId	string	Somente leitura	ID do pedido original.
pricingId	string (uuid)	Somente leitura	ID do pricing utilizado.
documentId	string (uuid)	Somente leitura	ID único do documento da apólice.
branchOfficeCode	string	Somente leitura	Código da filial responsável pela apólice.
lineCode	string	Somente leitura	Código da linha de produto SUSEP.
groupCode	string	Somente leitura	Código do grupo de produto SUSEP.
policySusepNumber	string	Somente leitura	Número SUSEP da apólice.
policyNumber	string	Somente leitura	Número comercial da apólice.
iof	number	Somente leitura	Valor do IOF da apólice.
financialCharge	number	Somente leitura	Valor dos encargos financeiros.
grossPremium	number	Somente leitura	Valor do prêmio bruto total incluindo IOF e encargos financeiros.
commercialPremium	number	Somente leitura	Valor do prêmio comercial incluindo comissão e prolabore.
commission	number	Somente leitura	Valor total de comissão da apólice.
commissionPercentage	number	Somente leitura	Percentual de comissão aplicado.
prolabore	number	Somente leitura	Valor total de prolabore da apólice.
prolaborePercentage	number	Somente leitura	Percentual de prolabore aplicado.
installmentCost	number	Somente leitura	Custo adicional por parcelamento.
installmentsQuantity	number	Somente leitura	Quantidade de parcelas do pagamento.
installments	Lista de Installment	Somente leitura	Lista detalhada das parcelas de pagamento.
participants	Lista de PolicyParticipant	Somente leitura	Lista de participantes da apólice (segurado, tomador, beneficiário).
commissionedAgents	Lista de PolicyCommissionedAgent	Somente leitura	Lista de agentes comissionados (corretoras, estipulantes).
riskObjects	Lista de PolicyRiskObject	Somente leitura	Lista de objetos de risco segurados na apólice.
clauses	Lista de Clause	Somente leitura	Lista de cláusulas aplicadas à apólice.
insurers	Lista de Insurer	Somente leitura	Lista de seguradoras participantes da apólice.
externalControlNumber	string	Somente leitura	Número de controle externo do parceiro.
holdings	Lista de PolicyHolding	Somente leitura	Lista de relacionamentos entre objetos de risco e beneficiários.
deductibleType	string	Somente leitura	Tipo de franquia aplicada à apólice.
commercialConditionsId	string (uuid)	Somente leitura	ID das condições comerciais aplicadas.

Installment

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Tipo da parcela de pagamento.
dueDate	string (date)	Somente leitura	Data de vencimento da parcela.
amount	number	Somente leitura	Valor da parcela.
status	string	Somente leitura	Status da parcela (Pending, Paid, Overdue, etc.).
number	number	Somente leitura	Número sequencial da parcela.
iofAmount	number	Somente leitura	Valor do IOF da parcela.
additionAmount	number	Somente leitura	Valor adicional da parcela (juros, multas, etc.).
discountAmount	number	Somente leitura	Valor de desconto aplicado na parcela.

PolicyParticipant

Campo	Tipo	Regras	Descrição
choicedName	string	Somente leitura	Nome escolhido/fantasia do participante.
documentNumber	string	Somente leitura	CPF/CNPJ do participante ofuscado conforme LGPD.
name	string	Somente leitura	Nome completo do participante.
type	string	Somente leitura	Tipo de pessoa (Physical, Legal).
role	string (ParticipantRole)	Somente leitura	Papel do participante na apólice.
isPayer	boolean	Somente leitura	Flag indicando se é o pagador da apólice.
percentage	number	Somente leitura	Percentual de participação (para beneficiários).
contact	Contact	Somente leitura	Informações de contato do participante.
address	Address	Somente leitura	Endereço do participante.

PolicyCommissionedAgent

Campo	Tipo	Regras	Descrição
commissionAmount	number	Somente leitura	Valor da comissão do agente.
name	string	Somente leitura	Nome do agente comissionado.
type	string	Somente leitura	Tipo de pessoa (Physical, Legal).
role	string (CommissionedAgentRole)	Somente leitura	Papel do agente comissionado.
commissionPercentage	number	Somente leitura	Percentual de comissão.
lead	boolean	Somente leitura	Flag indicando se é o agente principal.
isPayer	boolean	Somente leitura	Flag indicando se é o pagador.
documentNumber	string	Somente leitura	CPF/CNPJ do agente ofuscado conforme LGPD.

PolicyRiskObject

Campo	Tipo	Regras	Descrição
commercialPremium	number	Somente leitura	Prêmio comercial do objeto de risco.
grossPremium	number	Somente leitura	Prêmio bruto do objeto de risco.
iof	number	Somente leitura	IOF do objeto de risco.
financialCharge	number	Somente leitura	Encargos financeiros do objeto de risco.
installmentCost	number	Somente leitura	Custo de parcelamento do objeto de risco.
financialRefundAmount	number	Somente leitura	Valor de reembolso financeiro.
coverages	Lista de PolicyCoverage	Somente leitura	Lista de coberturas do objeto de risco.
riskId	string (uuid)	Somente leitura	ID único do objeto de risco.
riskVersion	string	Somente leitura	Versão do objeto de risco.
sortSequence	number	Somente leitura	Sequência de ordenação.
type	string	Somente leitura	Tipo do objeto de risco.
properties	PolicyRiskProperties	Somente leitura	Propriedades específicas do objeto de risco.

PolicyCoverage

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Tipo da cobertura.
name	string	Somente leitura	Nome da cobertura.
description	string	Somente leitura	Descrição da cobertura.
line	CoverageLine	Somente leitura	Linha da cobertura SUSEP.
commercialPremium	number	Somente leitura	Prêmio comercial da cobertura.
grossPremium	number	Somente leitura	Prêmio bruto da cobertura.
iof	number	Somente leitura	IOF da cobertura.
financialCharge	number	Somente leitura	Encargos financeiros da cobertura.
installmentCost	number	Somente leitura	Custo de parcelamento da cobertura.
insuredAmount	number	Somente leitura	Valor segurado da cobertura.
equipmentAmount	number	Somente leitura	Valor do equipamento.
lmi	number	Somente leitura	Limite máximo de indenização.
deductible	Deductible	Somente leitura	Informações da franquia.

CoverageLine

Campo	Tipo	Regras	Descrição
code	string	Somente leitura	Código da linha SUSEP.
group	CoverageGroup	Somente leitura	Grupo da cobertura SUSEP.

CoverageGroup

Campo	Tipo	Regras	Descrição
code	string	Somente leitura	Código do grupo SUSEP.

Deductible

Campo	Tipo	Regras	Descrição
value	number	Somente leitura	Valor da franquia.
percent	number	Somente leitura	Percentual da franquia.
description	string	Somente leitura	Descrição da franquia.
sourceType	string	Somente leitura	Tipo de origem da franquia.
susepDeductibleCodeType	string	Somente leitura	Código SUSEP do tipo de franquia.
participationType	string	Somente leitura	Tipo de participação na franquia.
minimumType	string	Somente leitura	Tipo de valor mínimo.
minimumValue	number	Somente leitura	Valor mínimo da franquia.
includesTotalLoss	boolean	Somente leitura	Flag indicando se inclui perda total.

Clause

Campo	Tipo	Regras	Descrição
description	string	Somente leitura	Descrição da cláusula.
type	string	Somente leitura	Tipo da cláusula.
text	string	Somente leitura	Texto completo da cláusula.
default	boolean	Somente leitura	Flag indicando se é uma cláusula padrão.

Insurer

Campo	Tipo	Regras	Descrição
lead	boolean	Somente leitura	Flag indicando se é a seguradora líder.
participationPercentage	number	Somente leitura	Percentual de participação da seguradora.
leadPolicyNumber	string	Somente leitura	Número da apólice líder.
leadPolicyIssuedAt	string (date-time)	Somente leitura	Data de emissão da apólice líder.
name	string	Somente leitura	Nome da seguradora.
type	string	Somente leitura	Tipo da seguradora.

PolicyHolding

Campo	Tipo	Regras	Descrição
riskId	string (uuid)	Somente leitura	ID do objeto de risco.
documentNumber	string	Somente leitura	CPF/CNPJ do beneficiário ofuscado conforme LGPD.

PolicyRiskProperties

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Tipo das propriedades do risco.
riskObject	PolicyRiskObjectDetails	Somente leitura	Detalhes do objeto de risco.
operatesOnWater	boolean	Somente leitura	Flag indicando se opera próximo à água.
performsPeriodicMaintenance	boolean	Somente leitura	Flag indicando se realiza manutenção periódica.
operatorsAreTrained	boolean	Somente leitura	Flag indicando se os operadores são treinados.
equipmentCanBeRented	boolean	Somente leitura	Flag indicando se o equipamento pode ser alugado.
invoice	object	Somente leitura	Informações da nota fiscal.
beneficiaries	Lista de string	Somente leitura	Lista de beneficiários.
equipmentTypeId	string (uuid)	Somente leitura	ID do tipo de equipamento.
utilizationId	string (uuid)	Somente leitura	ID da utilização.
manufacturerId	string (uuid)	Somente leitura	ID do fabricante.
financed	boolean	Somente leitura	Flag indicando se é financiado.
ownerOperator	boolean	Somente leitura	Flag indicando se é operador proprietário.
utilizationName	string	Somente leitura	Nome da utilização.
restricted	boolean	Somente leitura	Flag indicando se é restrito.
insuranceRiskType	string	Somente leitura	Tipo de risco do seguro.
riskUF	string	Somente leitura	UF do risco.
riskLocation	object	Somente leitura	Localização do risco.

PolicyRiskObjectDetails

Campo	Tipo	Regras	Descrição
category	number	Somente leitura	Categoria do equipamento.
name	string	Somente leitura	Nome do equipamento.
manufacture	string	Somente leitura	Fabricante do equipamento.
model	string	Somente leitura	Modelo do equipamento.
year	number	Somente leitura	Ano de fabricação.
serialNumber	string	Somente leitura	Número de série do equipamento.

EndorsementQuoteRequest

Campo	Tipo	Regras	Descrição
documentPeriodStart	string (date)	Obrigatório	Data de início de vigência do documento de endosso.
documentPeriodEnd	string (date)	Obrigatório	Data de fim de vigência do documento de endosso.
discountPercentage	number	Opcional	Percentual de desconto a ser aplicado no endosso. Mutuamente exclusivo com commercialLoadingFee.
commercialLoadingFee	number	Opcional	Taxa de agravo comercial a ser aplicada no endosso. Mutuamente exclusivo com discountPercentage.
externalControlNumber	string	Opcional	Número de controle externo do parceiro para o endosso.
participants	Lista de EndorsementParticipant	Opcional	Lista de participantes a serem alterados/incluídos no endosso.
riskObjects	Lista de Equipment Endorsement	Opcional	Lista de objetos de risco (equipamentos) a serem alterados/incluídos no endosso.
paymentConditions	EndorsementPaymentConditions	Opcional	Condições de pagamento do endosso.

EndorsementParticipant

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF ou CNPJ do participante.
name	string	Obrigatório	Nome completo do participante.
role	string (ParticipantRole)	Obrigatório	Papel do participante na apólice.
isPayer	boolean	Obrigatório	Flag indicando se é o pagador da apólice.
participationPercentage	number	Opcional	Percentual de participação (usado para beneficiários).
address	EndorsementAddress	Obrigatório	Endereço do participante.
contact	Contact	Obrigatório	Informações de contato do participante.

EndorsementAddress

Campo	Tipo	Regras	Descrição
type	string	Obrigatório	Tipo do endereço (Residential, Business).
street	string	Obrigatório	Nome da rua.
number	string	Obrigatório	Número do endereço.
district	string	Obrigatório	Bairro.
city	string	Obrigatório	Cidade.
state	string	Obrigatório	Estado (UF).
zipCode	string	Obrigatório	CEP do endereço.
complement	string	Opcional	Complemento do endereço.

EndorsementPaymentConditions

Campo	Tipo	Regras	Descrição
paymentType	string	Obrigatório	Tipo de pagamento (CreditCard, BankSlip, PIX, etc.).
installments	number	Obrigatório	Quantidade de parcelas para pagamento.

EndorsementQuoteResponse

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Somente leitura	ID único da cotação de endosso criada.
quoteNumber	number	Somente leitura	Número sequencial da cotação.
productId	string (uuid)	Somente leitura	ID do produto da apólice.
key	string	Somente leitura	Chave identificadora do produto.
policyType	string	Somente leitura	Tipo de contratação da apólice.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da cotação.
status	string	Somente leitura	Status da cotação de endosso.
commercialPremium	number	Somente leitura	Valor do prêmio comercial do endosso.
grossPremium	number	Somente leitura	Valor do prêmio bruto total do endosso incluindo IOF.
iof	number	Somente leitura	Valor do IOF do endosso.
commissionedAgents	Lista de EndorsementCommissionedAgent	Somente leitura	Lista de agentes comissionados.
participants	Lista de EndorsementResponseParticipant	Somente leitura	Lista de participantes do endosso.
discountPercentage	number	Somente leitura	Percentual de desconto aplicado.
commercialLoadingFee	number	Somente leitura	Taxa de agravo comercial aplicada.
policyPeriodStart	string (date)	Somente leitura	Data de início de vigência da apólice original.
policyPeriodEnd	string (date)	Somente leitura	Data de fim de vigência da apólice original.
documentPeriodStart	string (date)	Somente leitura	Data de início de vigência do endosso.
documentPeriodEnd	string (date)	Somente leitura	Data de fim de vigência do endosso.
riskObjects	Lista de EndorsementRiskObject	Somente leitura	Lista de objetos de risco do endosso.
productKey	string	Somente leitura	Chave do produto.
type	string	Somente leitura	Tipo de emissão (Endorsement).
createdBy	string	Somente leitura	Identificação de quem criou a cotação.
channel	string	Somente leitura	Canal de distribuição.
underwritingStatus	string	Somente leitura	Status de subscrição.
quoteStatus	string	Somente leitura	Status detalhado da cotação.
pricingId	string	Somente leitura	ID do pricing utilizado.
pricingResponseDate	string (date-time)	Somente leitura	Data da resposta do pricing.
quoteSequential	number	Somente leitura	Número sequencial da cotação.
paymentConditions	EndorsementResponsePaymentConditions	Somente leitura	Condições de pagamento do endosso.
insurers	Lista de string	Somente leitura	Lista de seguradoras participantes.
requiredCompanyAcceptance	boolean	Somente leitura	Flag indicando se requer aceitação da seguradora.
financialAmount	number	Somente leitura	Valor financeiro adicional.
partners	EndorsementPartner	Somente leitura	Informações do parceiro comercial.
assistanceServices	Lista de AssistanceService	Somente leitura	Lista de serviços de assistência contratados.
equipmentAreRentedMayCededThird	boolean	Somente leitura	Flag indicando se equipamentos podem ser alugados ou cedidos a terceiros.
externalControlNumber	string	Somente leitura	Número de controle externo do parceiro.
availableplans	Lista de string	Somente leitura	Lista de planos disponíveis.

EndorsementCommissionedAgent

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do agente comissionado (ofuscado).
role	string	Somente leitura	Papel do agente (Broker, Stipulator, etc.).
commissionPercentage	number	Somente leitura	Percentual de comissão do agente.
participationPercentage	number	Somente leitura	Percentual de participação do agente.
commissionAmount	number	Somente leitura	Valor da comissão do agente.
personId	string (uuid)	Somente leitura	ID da pessoa do agente.
lead	boolean	Somente leitura	Flag indicando se é o agente principal.
name	string	Somente leitura	Nome do agente comissionado.

EndorsementResponseParticipant

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do participante (ofuscado).
participationPercentage	number	Somente leitura	Percentual de participação.
role	string	Somente leitura	Papel do participante na apólice.
address	ResponseAddress	Somente leitura	Endereço do participante.
phoneNumber	string	Somente leitura	Número de telefone principal.
email	string	Somente leitura	Email principal.
personId	string (uuid)	Somente leitura	ID da pessoa.
name	string	Somente leitura	Nome completo do participante.
contact	ResponseContact	Somente leitura	Informações de contato detalhadas.
isPayer	boolean	Somente leitura	Flag indicando se é o pagador.
emails	Lista de string	Somente leitura	Lista de emails do participante.
phones	Lista de string	Somente leitura	Lista de telefones do participante.
type	string	Somente leitura	Tipo de pessoa (Individual, Legal).
gender	string	Somente leitura	Gênero (para pessoas físicas).
birthDate	string (date)	Somente leitura	Data de nascimento (para pessoas físicas).
relationship	string	Somente leitura	Relacionamento (Spouse, etc.).
courtId	string	Somente leitura	ID do tribunal (para casos específicos).

ResponseAddress

Campo	Tipo	Regras	Descrição
street	string	Somente leitura	Nome da rua.
number	string	Somente leitura	Número do endereço.
complement	string	Somente leitura	Complemento do endereço.
district	string	Somente leitura	Bairro.
city	string	Somente leitura	Cidade.
state	string	Somente leitura	Estado (UF).
zipCode	string	Somente leitura	CEP.
country	string	Somente leitura	País.

ResponseContact

Campo	Tipo	Regras	Descrição
name	string	Somente leitura	Nome do contato.
email	string	Somente leitura	Email do contato.
phoneNumber	string	Somente leitura	Telefone do contato.
cellPhoneNumber	string	Somente leitura	Celular do contato.

EndorsementRiskObject

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Tipo do objeto de risco.
riskId	string (uuid)	Somente leitura	ID único do objeto de risco.
coverages	Lista de RiskObjectCoverage	Somente leitura	Lista de coberturas do objeto de risco.
equipmentTypeId	string (uuid)	Somente leitura	ID do tipo de equipamento.
utilizationId	string (uuid)	Somente leitura	ID da utilização.
manufacturerId	string (uuid)	Somente leitura	ID do fabricante.
financed	boolean	Somente leitura	Flag indicando se é financiado.
ownerOperator	boolean	Somente leitura	Flag indicando se é operador proprietário.
equipmentCanBeRented	boolean	Somente leitura	Flag indicando se o equipamento pode ser alugado.
riskObjectDetails	RiskObjectDetails	Somente leitura	Detalhes do objeto de risco.
riskLocation	RiskLocation	Somente leitura	Localização do risco.
invoice	InvoiceInfo	Somente leitura	Informações da nota fiscal.
holdings	Lista de HoldingInfo	Somente leitura	Lista de beneficiários do objeto.
insuranceRiskType	string	Somente leitura	Tipo de risco do seguro.

RiskObjectCoverage

Campo	Tipo	Regras	Descrição
id	string	Somente leitura	ID da cobertura.
lmi	number	Somente leitura	Limite máximo de indenização.
insuredAmount	number	Somente leitura	Valor segurado.
key	string	Somente leitura	Chave da cobertura.
feeMultiple	number	Somente leitura	Múltiplo da taxa.
indemnityPeriod	number	Somente leitura	Período de indenização.
coverageId	string (uuid)	Somente leitura	ID único da cobertura.
price	number	Somente leitura	Preço da cobertura.
pos	number	Somente leitura	Posição da cobertura.
description	string	Somente leitura	Descrição da cobertura.

RiskObjectDetails

Campo	Tipo	Regras	Descrição
manufacture	string	Somente leitura	Fabricante do equipamento.
model	string	Somente leitura	Modelo do equipamento.
year	number	Somente leitura	Ano de fabricação.
serialNumber	string	Somente leitura	Número de série do equipamento.
chassis	string	Somente leitura	Número do chassi do equipamento.

RiskLocation

Campo	Tipo	Regras	Descrição
nationalCoverage	boolean	Somente leitura	Flag indicando se tem cobertura nacional.
address	ResponseAddress	Somente leitura	Endereço específico do risco.

InvoiceInfo

Campo	Tipo	Regras	Descrição
number	string	Somente leitura	Número da nota fiscal.
date	string (date)	Somente leitura	Data da nota fiscal.

HoldingInfo

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do beneficiário (ofuscado).

EndorsementResponsePaymentConditions

Campo	Tipo	Regras	Descrição
paymentType	string	Somente leitura	Tipo de pagamento.
installments	number	Somente leitura	Quantidade de parcelas.
firstInstallmentPaymentType	string	Somente leitura	Tipo de pagamento da primeira parcela.

EndorsementPartner

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do parceiro (ofuscado).
role	string	Somente leitura	Papel do parceiro (Advisor, etc.).
name	string	Somente leitura	Nome do parceiro.

AssistanceService

Campo	Tipo	Regras	Descrição
id	string	Somente leitura	ID do serviço de assistência.
makeUpPremium	boolean	Somente leitura	Flag indicando se compõe o prêmio.
amount	number	Somente leitura	Valor base do serviço.
commercialAmount	number	Somente leitura	Valor comercial do serviço.
grossAmount	number	Somente leitura	Valor bruto do serviço.
iof	number	Somente leitura	IOF do serviço.
financialCharge	number	Somente leitura	Encargos financeiros do serviço.
installmentCost	number	Somente leitura	Custo de parcelamento do serviço.
linkDescription	string	Somente leitura	Descrição do link do serviço.

EndorsementQuoteUpdateRequest

Campo	Tipo	Regras	Descrição
policyId	string (uuid)	Obrigatório	ID da apólice para a qual o endosso será atualizado.
documentPeriodStart	string (date)	Obrigatório	Data de início de vigência do documento de endosso.
documentPeriodEnd	string (date)	Obrigatório	Data de fim de vigência do documento de endosso.
discountPercentage	number	Opcional	Percentual de desconto a ser aplicado no endosso. Mutuamente exclusivo com commercialLoadingFee.
commercialLoadingFee	number	Opcional	Taxa de agravo comercial a ser aplicada no endosso. Mutuamente exclusivo com discountPercentage.
externalControlNumber	string	Opcional	Número de controle externo do parceiro para o endosso.
participants	Lista de EndorsementParticipant	Opcional	Lista de participantes a serem alterados/incluídos no endosso.
riskObjects	Lista de Equipment Endorsement	Opcional	Lista de objetos de risco (equipamentos) a serem alterados/incluídos no endosso.
paymentConditions	EndorsementPaymentConditions	Opcional	Condições de pagamento do endosso.

Equipment Endorsement

Campo	Tipo	Regras	Descrição
equipmentTypeId	string (uuid)	Obrigatório	Identificador do tipo de equipamento.
utilizationId	string (uuid)	Obrigatório	Identificador do tipo de utilização.
manufacturerId	string (uuid)	Obrigatório	Identificador do fabricante.
coverages	Lista de Coverage	Opcional	Lista de coberturas do equipamento.
riskObjectDetails	RiskObjectDetails	Obrigatório	Detalhes específicos do objeto de risco.
riskLocation	RiskLocation	Obrigatório	Localização do objeto de risco.
holdings	Holdings	Obrigatório	Dados do segurado relacionados ao objeto de risco.

PolicyStatus

Creating
Modifying
Canceling
Active
Cancelled
Expired

Resolução de erros

Campo	Tipo	Regras	Descrição
400	Bad Request	Invalid secret in Authorization header	O client_secret informado no header é inválido. Verifique se o client_secret informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
401	Unauthorized	Could not find a required APP in the request, identified by HEADER client_id.	O client_id informado no header é inválido. Verifique se o client_id informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
404	Not Found	Not Found	Provavelmente a URL sendo chamado não está correta. Verifique se está conforme especificado.
415	Unsupported Media Type	Content type not supported	O header Content-Type não está sendo informado conforme esperado. O correto é application/json.
429	Too Many Requests	Too Many Requests	O consumidor estourou o limite de requisições por tempo. Aguarde um pouco para tentar novas requisições.
500	Internal Server Error	Internal Server Error	Erro não esperado, algo está quebrado na API. Por favor aguarde ou entre em contato com o time de suporte.

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	Lista de ErrorMessage	Opcional	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

Campo	Tipo	Regras	Descrição
code	string	Opcional	Código de identificação do erro.
message	string	Opcional	Descrição do erro.

Idioma

Undefined

Máquinas e equipamentos

Formulário de busca

Máquinas e Equipamentos

Pré-requisitos

Cotações

Solicitar cotação

Requisição (Request)

Exemplo

Resposta (Response)

Exemplo

Criar cotação de endosso

Requisição (Request)

Resposta (Response)

Exemplo de Requisição

Exemplo de Resposta

Atualizar cotação de endosso

Requisição (Request)

Resposta (Response)

Exemplo de Requisição

Exemplo de Resposta

Consultar cotação

Requisição (Request)

Resposta (Response)

Exemplo

Atualizar cotação

Requisição (Request)

Exemplo

Resposta (Response)

Exemplo

Consultar documento da cotação

Requisição (Request)

Resposta (Response)

Consultar simulações de pagamento

Requisição (Request)

Resposta (Response)

Enviar para análise

Requisição (Request)

Resposta (Response)

Propostas

Enviar proposta

Requisição (Request)

Exemplo

Resposta (Response)

Exemplo

Enviar proposta de cancelamento

Requisição (Request)

Exemplo

Resposta (Response)

Exemplo

Aceitar proposta

Requisição (Request)

Respostas (Response)

Consultar proposta

Requisição (Request)

Respostas (Response)

Exemplo

Consultar documento da proposta

Requisição (Request)

Resposta (Response)

Apólices

Emitir apólice

Requisição (Request)

Exemplo

Resposta (Response)

Exemplo

Consultar apólice

Requisição (Request)

Resposta (Response)

Exemplo

Consultar apólice V2

Requisição (Request)

Resposta (Response)

Exemplo

Consultar documento da apólice

Requisição (Request)

Resposta (Response)

Dicionário

Quote

PolicyType

QuoteStatus