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