Benfeitorias

Benfeitorias

O seguro Pottencial Benfeitorias 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:

Fluxo de emissão de apólice

Você pode testar agora as chamadas das APIs da Pottencial utilizando o Postman:

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/benfeitorias/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"
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

Url https://api-sandbox.pottencial.com.br/insurance/v2/benfeitorias/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/benfeitorias/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/benfeitorias/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/benfeitorias/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/benfeitorias/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.

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/benfeitorias/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"
}

Aceitar proposta

Permite aprovar uma proposta criada.

Requisição (Request)

Url https://api-sandbox.pottencial.com.br/insurance/v1/benfeitorias/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/benfeitorias/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/benfeitorias/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/benfeitorias/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/benfeitorias/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 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/benfeitorias/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 Benfeitorias é 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.

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.
Undefined

Pottencial Seguradora S.A. – Cnpj: 11.699.534/0001-74 – Susep: 03069   © Pottencial Seguradora, 2021. Todos Os Direitos Reservados

Av. Raja Gabáglia, 1143, 19°Andar Luxemburgo, Belo Horizonte - MG