Empresarial

O Seguro Empresarial O seguro Pottencial Empresarial foi feito para proteger o patrimônio de sua empresa, dando continuidade aos negócios e proporcionando tranquilidade até nos momentos inesperados. O Seguro Pottencial Empresarial é indicado para empresas de pequeno e médio porte e oferece coberturas que podem ser personalizadas no momento da contratação..

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.

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ção

Solicitar cotação

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

Cada produto possui regras específicas de preenchimento, que estão detalhadas em cada um dos campos.

Requisição (Request)

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

Exemplos

Cotação para o produto Riscos Empresariais

Para cadastro de cotação para o produto Riscos Empresariais é necessário informar um único objeto de risco do tipo BusinessProperty.


{
"discountPercentage": 0.5,
"commercialLoadingFee": 0.2,
"commissionedAgents": [
  {
    "documentNumber": "11111111111111",
    "role": "Broker",
    "commissionPercentage": "0.45",
    "lead": "true"
  }
],
"participants": [
  {
  "documentNumber": "44444444444",
  "role": "Insured",
  "isPayer": "true",
  "type": "Corporate",
  "address": {
    "street": "Av. Raja Gabáglia",
    "number": "1143",
    "district": "Luxemburgo",
    "city": "Belo Horizonte",
    "state": "MG",
    "zipCode": "30380403",
    "complement": "20º andar",
    "country": "BRA",
    "type":"Residential"
  },
  "contact": {
      "name": "nome do contato 1",
      "email": "[email protected]",
      "cellPhoneNumber": "31999999999",
      "phoneNumber": "31999999999"
    }    
  },
  {
    "documentNumber": "33333333333",
    "role": "Beneficiary",
    "participationPercentage": "1",
    "isPayer": "false",
    "main": "true",
    "type": "Corporate",
    "address": {
      "street": "Av. Raja Gabáglia",
      "number": "1143",
      "district": "Luxemburgo",
      "city": "Belo Horizonte",
      "state": "MG",
      "zipCode": "30380403",
      "complement": "20º andar",
      "country": "BRA",
      "type":"Residential"
    }
  }
],
"riskObjects": [
  {
    "type": "BusinessProperty",
    "riskUF": "MG",
    "coverages": [
      {
        "key": "basica",
        "insuredAmount": "50000.00"
      },
      {
        "key": "rc-cabeleireiro",
        "insuredAmount": "80000.00"
      },
      {
        "key": "despesas-fixas",
        "insuredAmount": "150000.00"
      },
      {
        "key": "rc-petshop",
        "insuredAmount": "200000.00"
      },
      {
        "key": "vendaval",
        "insuredAmount": "80000.00"
      },
      {
        "key": "roubo-furto-bens",
        "insuredAmount": "500000.00"
      }
    ],
    "riskLocation": {
      "street": "Av. Raja Gabáglia",
      "number": "1143",
      "district": "Luxemburgo",
      "city": "Belo Horizonte",
      "state": "MG",
      "zipCode": "30380403",
      "complement": "20º andar",
      "country": "Brasil"
    },
    "securityType": "1",
    "buildingType": "1",
    "protectionForFireFighting": "1",
    "protectionForTheft": [
      "1",
      "2"
    ],
    "isRiskLocatedInShopping": "true",
    "insuredActivityId": "903ab663-3d5c-4014-aa5e-cae727103399",
    "documentPeriodStart": "2021-04-29T17:12:27.219Z",
    "documentPeriodEnd": "2021-04-29T17:12:27.219Z",
    "paymentConditions": {
      "paymentType": "Boleto",
      "installments": "2"
    },
    "objectsByBeneficiary": [
      {
        "documentNumber": "33333333333",
        "objectValue": "1444.55",
        "objectDescription": "descricao",
        "observations": "observacao"
      }
    ]
  }
]
}

Respostas (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

Exemplos

Response de Cotação para o produto Riscos Empresariais.


{
"quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
"productKey": "empresarial",
"policyType": "Unique",
"quoteNumber": "99999",
"createdAt": "2021-04-29T17:12:27.219Z",
"status": "Approved",
"commercialPremium": "109.98",
"grossPremium": "99.99",
"iof": "9.99",
"commissionedAgents": [
  {
    "documentNumber": "11111111111111",
    "role": "Broker",
    "commissionPercentage": "0.15",
    "commissionAmount": "486.9,",
    "lead": "true"
  }
],
"participants": [
  {
    "documentNumber": "33333333333",
    "role": "Insured"
  },
  {
    "documentNumber": "33333333333",
    "role": "Beneficiary",
    "participationPercentage": "1"
  }
],
"riskObjects": [
  {
    "type": "BusinessProperty",
    "riskUF": "MG",
    "coverages": [
      {
        "key": "basica",
        "insuredAmount": "50000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "rc-cabeleireiro",
        "insuredAmount": "80000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "despesas-fixas",
        "insuredAmount": "150000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "rc-petshop",
        "insuredAmount": "200000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "vendaval",
        "insuredAmount": "80000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "roubo-furto-bens",
        "insuredAmount": "500000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      }
    ],
    "riskLocation": {
      "street": "Av. Raja Gabáglia",
      "number": "1143",
      "district": "Luxemburgo",
      "city": "Belo Horizonte",
      "state": "MG",
      "zipCode": "30380403",
      "complement": "20º andar",
      "country": "Brasil"
    },
    "securityType": "1",
    "buildingType": "1",
    "protectionForFireFighting": "1",
    "protectionForTheft": [
      "1",
      "2"
    ],
    "isRiskLocatedInShopping": "true",
    "documentPeriodStart": "2021-04-29T17:12:27.219Z",
    "documentPeriodEnd": "2021-04-29T17:12:27.219Z",
    "insuredActivityId": "903ab663-3d5c-4014-aa5e-cae727103399",
    "objectsByBeneficiary": [
      {
        "documentNumber": "33333333333",
        "objectValue": "1444.55",
        "objectDescription": "descricao",
        "observations": "observacao"
      }
    ]
  }
]
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

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

Respostas (Response)

Status	Descrição	Tipo
200	Cotação localizada 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

Exemplos

Response de Cotação para o produto Riscos Empresariais.


{
"quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
"productKey": "empresarial",
"policyType": "Unique",
"quoteNumber": "99999",
"createdAt": "2021-04-29T17:12:27.219Z",
"status": "Approved",
"commercialPremium": "109.98",
"grossPremium": "99.99",
"iof": "9.99",
"commissionedAgents": [
  {
    "documentNumber": "11111111111111",
    "role": "Broker",
    "commissionPercentage": "0.15",
    "commissionAmount": "486.9,",
    "lead": "true"
  }
],
"participants": [
  {
    "documentNumber": "33333333333",
    "role": "Insured"
  },
  {
    "documentNumber": "33333333333",
    "role": "Beneficiary",
    "participationPercentage": "1"
  }
],
"riskObjects": [
  {
    "type": "BusinessProperty",
    "riskUF": "MG",
    "coverages": [
      {
        "key": "basica",
        "insuredAmount": "50000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "rc-cabeleireiro",
        "insuredAmount": "80000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "despesas-fixas",
        "insuredAmount": "150000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "rc-petshop",
        "insuredAmount": "200000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "vendaval",
        "insuredAmount": "80000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      },
      {
        "key": "roubo-furto-bens",
        "insuredAmount": "500000.00",
        "lmi": "10000.00",
        "description": "Texto descritivo da franquia"  
      }
    ],
    "riskLocation": {
      "street": "Av. Raja Gabáglia",
      "number": "1143",
      "district": "Luxemburgo",
      "city": "Belo Horizonte",
      "state": "MG",
      "zipCode": "30380403",
      "complement": "20º andar",
      "country": "Brasil"
    },
    "securityType": "1",
    "buildingType": "1",
    "protectionForFireFighting": "1",
    "protectionForTheft": [
      "1",
      "2"
    ],
    "isRiskLocatedInShopping": "true",
    "documentPeriodStart": "2021-04-29T17:12:27.219Z",
    "documentPeriodEnd": "2021-04-29T17:12:27.219Z",
    "insuredActivityId": "903ab663-3d5c-4014-aa5e-cae727103399",
    "objectsByBeneficiary": [
      {
        "documentNumber": "33333333333",
        "objectValue": "1444.55",
        "objectDescription": "descricao",
        "observations": "observacao"
      }
    ]
  }
]
}

Consultar PDF da cotação

Essa operação permite consultar o documento de PDF a partir do ID da cotação.

Requisição (Request)

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

Respostas (Response)

Status	Descrição	Tipo
200	Documento da cotação localizado 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

Solicitar Endossos

Permite solicitar uma alteração apólice para um produto Pottencial.

Cada produto possui regras específicas de preenchimento, que estão detalhadas em cada um dos campos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/empresarial/quotes/endorsements
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Endosso

Respostas (Response)

Status	Descrição	Tipo
200	Endosso 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

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.

Requisição (Request)

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

Exemplos

Proposta com boleto

Proposta com pagamento à vista através de boleto, com vencimento em 7 dias.


{
"quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
"policyPeriodStart": "2023-08-11T16:09:27.247Z",
"policyPeriodEnd": "2024-08-11T16:09:27.247Z",
"payment": {
  "paymentType": "Boleto",
  "firstInstallmentDueDateDelay": 1,
  "paymentInstructions": "informaçoes da forma de pagamento"
}
}

Proposta pagemento efetuado na cotação

Proposta com pagamento efetuado na cotação .


{
"quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
"policyPeriodStart": "2023-04-06T00:00:00.000Z",
"policyPeriodEnd": "2024-04-06T00:00:00.000Z",
"payment": {
  "firstInstallmentDueDateDelay": 3,
  "paymentInstructions": "informaçoes da forma de pagamento"
}
}

Respostas (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

Exemplos

Resposta de proposta com boleto

Resposta de proposta com pagamento à vista através de boleto, com vencimento em 7 dias.


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

Proposta pagemento efetuado na cotação

Proposta com pagamento efetuado na cotação .


{
"proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
"quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
"documentPeriodStart": "2023-04-06T00:00:00.000Z",
"documentPeriodEnd": "2024-04-06T00:00:00.000Z",
"payment": {
  "paymentType": "Boleto",
  "installments": "5"
},
"createdAt": "2021-08-03",
"status": "Ready"
}

Aceitar proposta

Permite aprovar uma proposta criada.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/empresarial/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. Algumas informações sensíveis de participantes e agentes comissionados são ofuscadas para atender a LGPD.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/empresarial/proposals/{proposal_id}
Method	Get
	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

Exemplos

Resposta de proposta com débito em conta

Resposta de proposta com pagamento parcelado em 12 vezes através de débito em conta.


{
"proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
"quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
"proposalNumber": "99999",
"payment": {
  "paymentType": "AutomaticDebit",
  "installments": "12",
  "automaticDebitAccount": {
    "bankCode": "001",
    "bankNumber": "5858",
    "accountNumber": "66544",
    "accountDigit": "0",
    "documentNumber": "1111111111"
  }
},
"createdAt": "2021-08-03",
"status": "Ready"
}

Resposta de proposta com boleto

Resposta de proposta com pagamento à vista através de boleto, com vencimento em 7 dias.


{
"proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
"quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
"proposalNumber": "99999",
"policyPeriodStart": "2021-01-01",
"policyPeriodEnd": "2021-12-31",
"payment": {
  "paymentType": "Boleto",
  "installments": "1",
  "firstInstallmentDueDateDelay": "7"
},
"createdAt": "2021-08-03",
"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/empresarial/proposals/{proposal_id}/document
Method	Get
	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	Documento da proposta localizado 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

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/empresarial/policies
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Policy

Exemplos

Emissão de apólice

Emissão da apólice para uma proposta existente.


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

Respostas (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

Exemplos

Resposta de emissão de apólice aguardando processamento

Resposta de emissão de apólice aguardando processamento.


{
"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"
}

Resposta de emissão de apólice processada com sucesso

Resposta de emissão de apólice processada com sucesso.


{
"policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
"proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
"quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
"policyNumber": "0306920219901140003053000",
"policyPeriodStart": "2021-08-03T00:00:00Z",
"policyPeriodEnd": "2022-08-03T00:00:00Z",
"status": "Active",
"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. Algumas informações sensíveis de participantes e agentes comissionados são ofuscadas para atender a LGPD.

Requisição (Request)

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

Respostas (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

Exemplos

Resposta de emissão de apólice aguardando processamento

Resposta de emissão de apólice aguardando processamento.


{
"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"
}

Resposta de emissão de apólice processada com sucesso

Resposta de emissão de apólice processada com sucesso.


{
"policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
"proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
"quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
"policyNumber": "0306920219901140003053000",
"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/empresarial/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.

Respostas (Response)

Status	Descrição	Tipo
200	Documento da apólice localizado 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

Quote

Representa uma cotação de um produto.

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.
productId	string (uuid)	Somente leitura	ID único do produto que o identifica dentro da Pottencial.
productKey	string (uuid)	Somente leitura	Chave do produto.
policyType	string (PolicyType)	Somente leitura	Tipo de contratação da apólice, que no caso do produto Empresarial é Unique
quoteNumber	number	Opcional	Número da Cotação
discountPercentage	number	Opcional	Percentual de desconto a ser aplicado no valor do prêmio. O valor máximo de desconto é de 0.1 (10%). 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 valor máximo de agravo é de 10.0 (1000%). 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.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da cotação
status	string (QuoteStatus)	Somente leitura	Situação atual da cotação.
commercialPremium	number	Somente leitura	Valor de prêmio considerando-se subscrição e comercial, incluindo valores de comissão e prolabore.
grossPremium	number	Somente leitura	Valor de prêmio total incluindo, além do prêmio comercial, o IOF e encargos financeiros.
iof	number	Somente leitura	Valor do IOF da cotação.
policyPeriodStart	string (date)	Opcional	Data de início de vigência da apólice. A vigência deve iniciar em no máximo 30 dias. A vigência deve ser 12 ou 24 meses. A vigência não pode ser retroativa.
policyPeriodEnd	string (date)	Opcional	Data do fim de vigência da apólice. A vigência deve ser 12 ou 24 meses. A vigência não pode ser retroativa.
commissionedAgents	array de CommissionedAgent	Obrigatório	Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes.
participants	array de Participant	Obrigatório	Lista de participantes da apólice, que inclui segurado, tomador e beneficiário.
partners	array de Partner	Somente Leitura	Lista de parceiros da apólice.
riskObjects	array de BusinessProperty	Obrigatório	Lista de objetos segurados.

PolicyType

Tipo da apólice informa se é contratação única ou item a item.

Unique: Contratação única.

QuoteStatus

Situação da cotação define o passo do fluxo que a cotação se encontra.

Creating: 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.

Participant

Representa um participante dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF ou CNPJ do participante. Aceita apenas CPF ou CNPJ válido. O titular do CPF não pode estar falecido. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
participationPercentage	number	Opcional	Percentual do prêmio a que o beneficiário tem direito. O valor deve ser no mínimo 0.01 (1%) e no máximo 1.00 (100%). O valor deve ter no máximo duas casas decimais. A soma da participação de todos os beneficiários deve ser igual a 1.00 (100%).
role	string (ParticipantRole)	Obrigatório	Papel do participante na cotação.
address	Address	Obrigatório	Endereço do participante.
contact	Contact	Obrigatório	Contato do participante.
isPayer	boolean	Opcional	Identifica o pagador da apólice.
main	boolean	Opcional	Identifica o participante que é o beneficiário principal. Só deve ser informada para participantes com papel Beneficiary. Não pode ter mais de um beneficiário principal.
type	string	Obrigatório	Tipo do participante. Corporate: Pessoa Jurídica (CNPJ). Individual : Pessoa Física (CPF).

ParticipantRole

Lista de possíveis valores para os participantes da apólice.

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

Partner

Representa um Parceiro comercial em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente Leitura	CPF/CNPJ do parceiro Aceita apenas CPF/CNPJ válido. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
role	string (PartnerRole)	Somente Leitura	Papel do parceiro na cotação.

PartnerRole

Papel do parceiro na cotação.

Advisor: Assessor
CommercialAgent: Representante comercial

CommissionedAgent

Representa um agente comissionado dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CNPJ do agente comissionado. Aceita apenas CNPJ válido. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
role	string (CommissionedAgentRole)	Obrigatório	Papel desempenhado pelo agente comissionado.
lead	boolean	Opcional	Identifica a corretora principal na cotação. Esse campo pode ser omitido quando houver somente uma corretora na cotação.
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. A soma dos percentuais de comissão deve ser no mínimo 0.01 (1%) e no máximo 0.4 (40%). A soma dos percentuais de comissão não deve ultrapassar o percentual máximo de comissão do corretor
commissionAmount	number	Somente leitura	Valor de comissão, no caso de corretora, e valor de pró-labore, no caso de estipulante. Esse valor é preenchido no retorno da cotação.
address	Address	Opcional	Endereço do agente comissionado.
isPayer	boolean	Opcional	Identifica o pagador da apólice.

CommissionedAgentRole

Lista de possíveis valores para os agentes comissionados da apólice.

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

Representa os dados de contato.

Campo	Tipo	Regras	Descrição
name	string	Obrigatório	Nome para identificação do contato.
email	string	Obrigatório	E-mail de contato.
phoneNumber	string	Obrigatório	Número do telefone, com DDD.
cellPhoneNumber	string	Obrigatório	Número do Celular, com DDD.

Coverage

Contém informações das coberturas para cotação.

Campo	Tipo	Regras	Descrição
key	string	Obrigatório	ID da cobertura, conforme cada produto. Básica Incêndio: basica Valor máximo: 5 milhões de reais. Valor mínimo: 100 mil reais. Quebra de vidros e anúncios luminosos: quebra-vidros Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Fidelidade de empregados: fidelidade-empregados Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Danos elétricos: danos-eletricos Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Derrame de sprinklers: derrame-sprinklers Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. Despesas fixas: despesas-fixas Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. Equipamentos portáteis (home office):equipamentos-portateis-home-office Valor máximo: 10% da cobertura básica ou 500 mil de reais. Valor mínimo: mil reais. Exposição e demonstração: exposicao-demonstracao Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Impacto de veículos terrestres: impacto-veiculos Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. Perda e/ou pagamento de aluguel: perda-aluguel Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. Roubo de Valores: roubo-valores Valor máximo: 10% da cobertura básica ou 500 mil de reais. Valor mínimo: mil reais. Mercadorias em ambientes frigorificados: mercadorias-ambientes-frigorificados Valor máximo: 10% da cobertura básica ou 500 mil de reais. Valor mínimo: mil reais. Delivery (mercadorias em trânsito): delivery Valor máximo: 3% da cobertura básica ou 150 mil de reais. Valor mínimo: mil reais. Roubo e/ou furto qualificado de bens: roubo-furto-bens Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Ruptura de tubulações: ruptura-tubulacao Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. Tumulto: tumulto Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. Vendaval: vendaval Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. RC Adicional de percurso: rc-adicional-percurso Valor máximo: 50% da cobertura básica ou 2,5 milhões de reais. Valor mínimo: mil reais. RC Empregador: rc-empregador Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Garagista – compreensiva: rc-garagista-compreensiva Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Operações: rc-operacoes Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Cabeleireiro: rc-cabeleireiro Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Pet shop: rc-petshop Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Farmácias e Drogarias: rc-farmacias-drogarias Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Postos de serviço e oficinas: rc-servico-oficinas Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais. RC Escola: rc-escola Valor máximo: 30% da cobertura básica ou 1,5 milhões de reais. Valor mínimo: mil reais.
insuredAmount	number	Obrigatório	Importância segurada, ou valor segurado, deste objeto de risco.
lmi	number	Opcional	Limite máximo de indenização. Este valor pode ser menor ou igual à soma da importância segurada dos objetos segurados. Caso não seja informado, assume-se o valor da importância segurada.
feeMultiple	number	Opcional	Identifica a taxa múltipla.
indemnityPeriod	number	Opcional	Identifica o período de indenização.

BusinessProperty

Representa uma objeto de Risco do Riscos Empresariais.

Campo	Tipo	Regras	Descrição
riskUF	string	Obrigatório	Sigla do estado da localidade, com duas letras.
documentPeriodStart	string	Obrigatório	Data início da validade do documento.
documentPeriodEnd	string	Obrigatório	Data fim da validade do documento.
insuredActivityId	string	Obrigatório	Identificador da atividade empresarial exercida. Obter atividade na Api Risk Object em: Listar Atividades Apenas atividades listadas (habilitadas) para o produto são aceitas na requisição.
securityType	number	Obrigatório	Tipo do seguro. NewInsurance: 1 CongenereRenovationWithClaim: 2 CongenereRenovationWithoutClaim: 3
buildingType	number	Obrigatório	Tipo de construção. SolidConstruction: 1 Containers: 2 ShoppingKiosks: 3
protectionForFireFighting	number	Obrigatório	Proteções contra incêndio. DoesNotHave: 1 FireExtinguisher: 2 FireExtinguisherAndFireHydrant: 3 FireExtinguisherAndFireHydrantAndSprinkers : 4
protectionForTheft	number	Obrigatório	Proteções contra roubo. GridsAndLocks: 1 Surveillance24h: 2 Alarm: 3 MonitoringSystem : 4 DoesNotHave : 5
isRiskLocatedInShopping	boolean	Opcional	O risco está localizado em Shopping.
riskLocation	object Address	Obrigatório	Representa o Local do Objeto de Risco.
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
paymentConditions	object	Opcional	Representa um objeto informando forma de pagamento na Pottencial.
objectsByBeneficiary	array de ObjectsByBeneficiary	Opcional	Representa um Beneficiario Caso o payload contenha um participante do tipo Beneficiary, este campo se torna obrigatório.

Proposal

Representa uma proposta de um produto.

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)	Obrigatório	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. A vigência deve iniciar em no máximo 30 dias. A vigência deve ser 12 ou 24 meses. A vigência não pode ser retroativa.
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. A vigência deve ser 12 ou 24 meses. A vigência não pode ser retroativa. A data de início da vigência pode ser no máximo 30 dias após criação da 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

Situação da proposta define o passo do fluxo que a proposta se encontra.

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

Representa os dados referentes ao pagamento da apólice.

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. Valor máximo: 11 parcelas.
firstInstallmentDueDateDelay	integer	Opcional	Carência para a data de vencimento da primeira parcela, em dias. Obrigatório para pagamento em boleto.
firstDueDate	string	Opcional	Data de vencimento da primeira parcela. Obrigatório para pagamento em boleto.
automaticDebitAccount	BankAccount	Opcional	Dados bancários para pagamento. Obrigatório para pagamento através de débito em conta. Bancos conveniados: Sicoob, Itaú, Santander, Cresol, Ailos, Banco do Nordeste e Bradesco.

BankAccount

Representa os dados de uma conta bancária.

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.
documentNumber	string	Obrigatório	CPF/CNPJ do titular da conta bancária.
accountExtension	string	Opcional	Dígito verificador da conta bancária.
accountType	string	Opcional	Tipo da conta. Current: Conta Corrente. Savings: Conta Poupança. Payments: Conta Pagamento.

PaymentType

Lista as possíveis formas de pagamento da apólice.

Boleto: Pagamento através de boleto.
- O primeiro boleto deve vencer em no mínimo D+3.
- O primeiro boleto deve vencer em no máximo D+33 (o sugerido seria D+30).
AutomaticDebit: Pagamento através de débito em conta.
- O primeiro débito automático deve vencer em no mínimo D+6 úteis.
- O primeiro débito automático deve vencer em no máximo D+20 úteis.
- Bancos conveniados: Sicoob, Itaú, Santander, Cresol, Ailos, Banco do Nordeste e Bradesco

O Parcelamento é limitado em 11 parcelas.

Policy

Representa uma apólice de um produto.

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.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da apólice.

PolicyStatus

Situação da apólice define o passo do fluxo que a apólice se encontra.

Creating
Modifying
Canceling
Active
Cancelled
Expired

Address

Representa uma localidade com endereço.

Campo	Tipo	Regras	Descrição
street	string	Obrigatório	Nome da avenida, rua ou praça da localidade.
number	string	Obrigatório	Número da localidade.
district	string	Obrigatório	Bairro do localidade.
city	string	Obrigatório	Nome da cidade da localidade, conforme cadastrado nos Correios.
state	string	Obrigatório	Sigla do estado da localidade, com duas letras.
zipCode	string	Obrigatório	CEP da localidade. Devem ser informados somente os dígitos.
complement	string	Obrigatório	Complemento da localidade.
type	string (enum)	Obrigatório	Tipo de localidade Residential: Residencial. Business: Comercial. Billing: Cobrança.

ObjectsByBeneficiary

Representa um Beneficiario

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	numero CPF do Beneficiario.
objectValue	number	Obrigatório	Valor do objeto.
objectDescription	string	Obrigatório	Descricao sobre o Beneficiario.
observations	string	Obrigatório	Observação sobre o Beneficiario.

Resolução de erros

Código	Erro	Descrição	Soluçã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	A URL chamada 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.

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array 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

Empresarial

Formulário de busca

Empresarial

Pré-requisitos

Cotação

Solicitar cotação

Requisição (Request)

Exemplos

Cotação para o produto Riscos Empresariais

Respostas (Response)

Exemplos

Response de Cotação para o produto Riscos Empresariais.

Consultar cotação

Requisição (Request)

Respostas (Response)

Exemplos

Response de Cotação para o produto Riscos Empresariais.

Consultar PDF da cotação

Requisição (Request)

Respostas (Response)

Solicitar Endossos

Requisição (Request)

Respostas (Response)

Propostas

Enviar proposta

Requisição (Request)

Exemplos

Proposta com boleto

Proposta pagemento efetuado na cotação

Respostas (Response)

Exemplos

Resposta de proposta com boleto

Proposta pagemento efetuado na cotação

Aceitar proposta

Requisição (Request)

Respostas (Response)

Consultar proposta

Requisição (Request)

Respostas (Response)

Exemplos

Resposta de proposta com débito em conta

Resposta de proposta com boleto

Consultar documento da proposta

Requisição (Request)

Respostas (Response)

Apólices

Emitir apólice

Requisição (Request)

Exemplos

Emissão de apólice

Respostas (Response)

Exemplos

Resposta de emissão de apólice aguardando processamento

Resposta de emissão de apólice processada com sucesso

Consultar apólice

Requisição (Request)

Respostas (Response)

Exemplos

Resposta de emissão de apólice aguardando processamento

Resposta de emissão de apólice processada com sucesso

Consultar documento da apólice

Requisição (Request)

Respostas (Response)

Quote

PolicyType

QuoteStatus

Participant

ParticipantRole

Partner

PartnerRole

CommissionedAgent

CommissionedAgentRole

Contact

Coverage

BusinessProperty

Proposal

ProposalStatus

Payment

BankAccount

PaymentType