PolicyManagement

Policy Manager

A Policies Management permite realizar a consulta e Listagem de Apólices e Endossos Emitidos na Pottencial.

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.

Consultar Apólices e Endossos

Permite consultar os dados de Apólices e Endossos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/policiesmanagement/v1/policies
Method	Get
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Query	IssuancePeriodStart	string (date-time)	Filtro por período inicial (emissão) da apólice e endossos no formato (YYYY-MM-DDTHH:mm:ss)
Query	IssuancePeriodEnd	string (date-time)	Filtro por período (emissão) da apólice e endossos no formato (YYYY-MM-DDTHH:mm:ss)
Query	PolicyId	string (uuid)	Filtro por Identificador Único da Apólice/Endosso
Query	PolicyNumber	string	Filtro por Número da Apólice
Query	ProposalNumber	string	Filtro por Número da Proposta
Query	PolicyHolder	string	filtro por Devedor das obrigações por ele assumidas no contrato principal. (Circular SUSEP 232/03). OBS: Para consultar clientes nomeados utilizar filtro policyHolder. Mais Detalhes em : Histórico de apólices/endossos - Clientes Nomeados
Query	Skip	number	Pular quantos registros
Query	Take	number	Selecionar quantidade de itens por página
Query	PolicyIds	array de string	Filtra por um ou mais Identificadores único da Apólice/Endosso.
Query	Includes	array de Includes	Informações adicionais, vazio vem todos, caso necessário adicione os Includes conforme a sua necessidade para adicionar ou remover informações retornadas.

Respostas (Response)

Status	Descrição	Tipo
200	Lista de ápolices localizada com sucesso. O total das apolíces é retornado no headers no campo TotalCount .	ver Policy number
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

Histórico de apólices/endossos - Clientes Nomeados

É possível obter o histórico de todas as apólices/endossos emitidas na Pottencial referentes às modalidades de seguro(s)/tomadores(clientes) aos quais representa, independentemente se possuía nomeação na data que as apólices/endossos foram emitidas.

Exemplo: a corretora X perdeu a nomeação do tomador(clientes) Z a partir de 01/01/2023. A corretora Y (nova corretora) em 02/01/2023 ganhou a nomeação do tomador Z, por isso ela tem poderes para solicitar e receber todas as cópias das apólices/endossos emitidas na Pottencial referentes às modalidades de seguro(s) aos quais ela representa para o tomador(clientes) Z.

Para consultar o histórico de um tomador(cliente) é necessário informar no filtro da requisição o CNPJ do tomador(cliente) no campo policyHolder, desta forma verificamos se a corretora possui nomeação ativa referentes as modalidades de seguro(s) e disponibilizamos no retorno o histórico de apólices/endossos dessas modalidades. O campo commissionPercentage terá seu valor igual a zero nos dados do histórico da apólice.

Observação

Payload comum para todas as Apólices

RISK OBJECTS montado conforme Objeto de Risco do Produto

Exemplo

    
        [
        {
           "policyId":"c03ab663-3d5c-4014-aa5e-cae727103392",
           "policyNumber":"1234567890",
           "quoteNumber":"109330",
           "mainPolicyNumber":"1234567890",
           "referencePolicyId":"c03ab663-3d5c-4014-aa5e-cae727103392",
           "issuedBy":"c03ab663-3d5c-4014-aa5e-cae727103392",
           "issuedByName":"Teste 0101",
           "proposalId":"c03ab663-3d5c-4014-aa5e-cae727103392",
           "proposalNumber":12345641,
           "createdAt":"2021-04-29T17:12:27.219Z",
           "issuanceAt":"2021-04-29T17:12:27.219Z",
           "policyPeriodStart":"2021-04-29T17:12:27.219Z",
           "policyPeriodEnd":"2022-04-29T17:12:27.219Z",
           "commercialPremium":"109.98",
           "susepPolicyNumber":"021223323",
           "grossPremium":"99.99",
           "commissionAmount":"99999.8",
           "commissionPercentage":"9.8",
           "lmg":"9.99",
           "issuanceType":"Apolice",
           "policyType":"Unico",
           "reason":"Apólice",
           "susepProcessNumber":"11111.1111/2014-20",
           "renewalPolicyNumber":"1234567890",
           "susepInsuranceCode":"1234",
           "externalControlNumber": "1233",
           "policyLmg": 50000.00,
           "documentType": "Endorsement",
           "endorsementDocumentPeriod": {
                "start": "2021-06-20",
                "end": "2022-06-20"
            },
            "process": {
                "number": "11111111111111111111",
                "court": {
                  "name": "TRIBUNAL REGIONAL",
                  "documentNumber": "1110110101010"
                },
                "department": {
                  "name": "04ª VARA DA ZONA LESTE"
                }
              },    
           "commissionedAgents":[
              {
                 "documentNumber":"11111111111111",
                 "role":"Broker",
                 "commissionPercentage":"0.15",
                 "personId":"1221217ff-4c31-48b8-8be9-01e2543e9122112",
                 "name":"commissionedAgent name"
              },
              {
                 "documentNumber":"22222222222222",
                 "role":"PolicyOwner",
                 "personId":"1221217ff-4c31-48b8-8be9-01e2543e9122112",
                 "name":"commissionedAgent name"
              }
           ],
           "participants":[
              {
                 "documentNumber":"33333333333",
                 "role":"Beneficiary",
                 "personId":"1221217ff-4c31-48b8-8be9-01e2543e9122112",
                 "name":"nome person",
                 "email":"[email protected]",
                 "phoneNumber":"11111111111111",
                 "address":{
                    "street":"Av. Raja Gabáglia",
                    "number":"1143",
                    "district":"Luxemburgo",
                    "city":"Belo Horizonte",
                    "state":"MG",
                    "zipCode":"30380403",
                    "complement":"20º andar"
                 },
                 "type":"Individual",
                 "gender":"",
                 "birthDate":"1999-01-01"
              },
              {
                 "documentNumber":"44444444444",
                 "role":"Insured",
                 "personId":"1221217ff-4c31-48b8-8be9-01e2543e9122112",
                 "name":"nome person",
                 "email":"[email protected]",
                 "phoneNumber":"888888888888",
                 "address":{
                    "street":"Av. Raja Gabáglia",
                    "number":"1143",
                    "district":"Luxemburgo",
                    "city":"Belo Horizonte",
                    "state":"MG",
                    "zipCode":"30380403",
                    "complement":"20º andar"
                 },
                 "type":"Individual",
                 "gender":"",
                 "birthDate":"1999-01-01"
              },
              {
                 "documentNumber":"555555555555555",
                 "role":"PolicyHolder",
                 "personId":"1221217ff-4c31-48b8-8be9-01e2543e9122112",
                 "name":"nome person",
                 "email":"[email protected]",
                 "phoneNumber":"7777777777777777",
                 "address":{
                    "street":"Av. Raja Gabáglia",
                    "number":"1143",
                    "district":"Luxemburgo",
                    "city":"Belo Horizonte",
                    "state":"MG",
                    "zipCode":"30380403",
                    "complement":"20º andar"
                 },
                 "type":"Corporative"
              }
           ],
           "insurers":[
              {
                 "name":"teste 0101",
                 "documentNumber":"22222222222222",
                 "participationPercentage":"0.15",
                 "lead":"true"
              },
              {
                 "name":"teste 0202",
                 "documentNumber":"1111111",
                 "participationPercentage":"0.05",
                 "lead":"false"
              }
           ],
           "product":{
              "key":"imobiliario",
              "group":"01",
              "line":"02"
           },
           "riskObjects":[
              {
                 "type":"Property",
                 "coverages":[
                    {
                       "key":"basica",
                       "insuredAmount":"115000.00"
                    },
                    {
                       "key":"danos-eletricos",
                       "insuredAmount":"2100.00"
                    },
                    {
                       "key":"impacto-veiculos",
                       "insuredAmount":"4700.00"
                    },
                    {
                       "key":"perda-aluguel",
                       "insuredAmount":"12600.00"
                    },
                    {
                       "key":"quebra-vidros",
                       "insuredAmount":"12600.00"
                    },
                    {
                       "key":"rc-familiar",
                       "insuredAmount":"2100.00"
                    },
                    {
                       "key":"roubo-furto",
                       "insuredAmount":"2600.00"
                    },
                    {
                       "key":"ruptura",
                       "insuredAmount":"2100.00"
                    },
                    {
                       "key":"vendaval",
                       "insuredAmount":"4700.00"
                    }
                 ],
                 "historicalProtectedProperty":"false",
                 "sharedProperty":"false",
                 "insuredOwner":"true",
                 "propertyType":"Apartment",
                 "constructionType":"Brick",
                 "propertyUseType":"Usual",
                 "address":{
                    "street":"Av. Raja Gabáglia",
                    "number":"1143",
                    "district":"Luxemburgo",
                    "city":"Belo Horizonte",
                    "state":"MG",
                    "zipCode":"30380403",
                    "complement":"20º andar"
                 }
              }
           ],
           "installmentsQuantity":1,
           "installments":[
              {
                 "currency":"BRL",
                 "paymentType":"Boleto",
                 "dueDate":"2022-03-07T03:00:00",
                 "interest":"10.6",
                 "InstallmentNumber":"1",
                 "installmentAmount":"151151.92",
                 "status":"Pago"
              }
           ],
           "partners":[
              {
                 "documentNumber":"33333333333",
                 "role":"Advisor",
                 "name":"parceiro 1"
              },
              {
                 "documentNumber":"44444444444",
                 "role":"CommercialAgent",
                 "name":"parceiro 2"
              }
           ]
        }
     ]

Schemas e Models

Policy

Representa uma ápolice de um produto.

Campo	Tipo	Regras	Descrição
policyId	string (uuid)	Somente leitura	Identificador único da apólice.
policyNumber	string (string)	Somente leitura	Número da apólice ou endosso.
quoteNumber	string (string)	Somente leitura	Número da cotação.
mainPolicyNumber	string (uuid)	Somente leitura	Número da apólice principal/risco original.
referencePolicyId	string (uuid)	Somente leitura	ID para identificação da apólice anterior.
issuedBy	string (uuid)	Somente leitura	ID único do emitente da apólice (produtor).
issuedByName	string (string)	Somente leitura	Nome do emitente da apólice (produtor).
proposalId	string (uuid)	Somente leitura	ID único da proposta relacionada a apólice atual.
proposalNumber	number	Somente leitura	Número da proposta relacionada a apólice atual.
createdAt	string (date-time)	Somente leitura	Data de criação do registro da apólice
issuanceAt	string (date-time)	Somente leitura	Data de emissão da apólice (assinatura e emissão).
policyPeriodStart	string (date)	Somente leitura	Período de vigência inicial, data em formato UTC.
policyPeriodEnd	string (date)	Somente leitura	Período de vigência final, data em formato UTC.
commercialPremium	number	Somente leitura	Prêmio comercial.
susepPolicyNumber	string	Somente leitura	Número da apólice conforme padrão SUSEP.
grossPremium	number	Somente leitura	Valor do Prêmio bruto.
commissionAmount	number	Somente leitura	Valor total da comissão.
commissionPercentage	number	Somente leitura	Prêmio comercial.
lmg	number	Somente leitura	Limite máximo de garantia da apólice.
issuanceType	string (IssuanceType)	Somente leitura	Tipo de emissão
policyType	string (PolicyType)	Somente leitura	Tipo da apólice informada (relacionado ao LMI - Limite Máximo de Indenização, podendo ser: Único ou Item a Item).
reason	string	Somente leitura	Informação textual livre explicando brevemente motivo da emissão.
susepProcessNumber	string	Somente leitura	Informação Número do processo da Susep.
renewalPolicyNumber	string	Opcional	Número da apólice renovada. Preenchido quando o registro for uma renovação de uma apólice anterior.
susepInsuranceCode	string	Opcional	Informação Código da Seguradora detentora da apólice original.
policyLmg	number	Somente leitura	Valor de Lmg deste documento.
documentType	string (DocumentType)	Somente leitura	Tipo de documento.
commissionedAgents	array de CommissionedAgent	Somente leitura	Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes..
participants	array de Participant	Somente leitura	Lista de participantes da apólice, que inclui segurado, tomador e beneficiário
insurers	array de Insurer	Somente leitura	Lista de seguradoras .
product	Product	Somente leitura	Produto vinculado à apólice.
partners	array de Partners	Opcional	Lista de Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.
riskObjects	array de Property ou Equipment ou Contract ou JudicialProcess ou Construction ou ProductRisk ou RentalProperty ou BusinessProperty ou Person ou Structure	Somente leitura	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado. Imobiliário Enviar um único objeto Property. Residencial Enviar um único objeto Property. Garantia do Licitante Enviar um único objeto Contract. Garantia do Executante Enviar um único objeto Contract. Judicial Depósito Recursal Enviar um único objeto JudicialProcess. Judicial Depósito Recursal - Substituição Enviar um único objeto JudicialProcess. Judicial Trabalhista Enviar um único objeto JudicialProcess. Riscos Diversos Enviar um ou mais objetos Equipment. Vida Enviar um objetos Person. Empresarial Enviar um objetos BusinessProperty. Riscos Nomeados Enviar um objetos BusinessProperty. Aluguel Enviar um objetos RentalProperty. Garantia Estendida Enviar um objetos Product. Riscos Engenharia Enviar um objetos Construction. Qualidade Seguro Estrutural Enviar um objetos Structure.
installments	array de Installment	Somente leitura	Lista dados financeiros da apólice.
installmentsQuantity	number	Somente leitura	Quantidade de parcelas do documento.

PolicyType

Tipo da apólice informada (relacionado ao LMI - Limite Máximo de Indenização, podendo ser: Único ou Item a Item).

Unico.
ItemAItem.

DocumentType

Tipo de documento.

Issuance.
Endorsement.
RenewalIssuance.

IssuanceType

Tipo de emissão ou tipo da movimentação conforme segue:

Apolice: Apólice.
EndossoCobrancaAdicional: Endosso Cobrança Adicional.
EndossoRestituicao: Endosso Restituição.
CancelamentoApoliceComRestituicao: Cancelamento Apólice Com Restituição.
CancelamentoEndossoComRestituicao: Cancelamento Endosso Com Restituição.
CancelamentoApoliceSemRestituicao: Cancelamento Apólice Sem Restituição.
CancelamentoEndossoSemRestituicao: Cancelamento Endosso Sem Restituição.
EndossoSemMovimentacao: Endosso Sem Movimentação.

Participant

Representa um participante dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do participante. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
role	string (ParticipantRole)	Somente leitura	Descrição do tipo de participante.
personId	string (uuid)	Somente leitura	ID único no Person do participante. .
email	string	Somente leitura	Email do participante.
phoneNumber	string	Somente leitura	Telefone do participante.
name	string	Somente leitura	nome do participante.
address	Address	Somente leitura	Endereço do participante.
type	string (enum)	Somente leitura	Tipo de pessoa. 'Individual' ou 'Corporative'
gender	string	Somente leitura	sexo do participante.
birthDate	string (date)	Somente leitura	data de nascimento do participante.

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

CommissionedAgent

Representa um agente comissionado dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	CPF/CNPJ do agente comissionado. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
role	string (CommissionedAgentRole)	Somente leitura	Papel desempenhado pelo agente comissionado. Os papéis obrigatórios variam por produto.
commissionPercentage	number	Somente leitura	Percentual do prêmio a que o agente comissionado tem direito. O valor deve ter no máximo duas casas decimais e estar entre 0.01 e 1.00.
name	string	Somente leitura	nome do agente comissionado.
personId	string (uuid)	Somente leitura	ID único no Person do Agente comissionado

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.

Coverage

Contém informações das coberturas para ápolice.

Campo	Tipo	Regras	Descrição
key	string	Somente leitura	ID da cobertura, conforme cada produto. Imobiliário Incêndio, Queda de Raio, Queda de Aeronave, Fumaça, Explosão de Qualquer Natureza e Implosãos: basica Danos elétricos: danos-eletricos Impacto de veículos terrestres: impacto-veiculos Perda ou pagamento de aluguel: perda-aluguel Quebra de vidros e espelhos, mármore e granito: quebra-vidros Ruptura de tubulações: ruptura Roubo e Furto qualificado de Bens: roubo-furto Responsabilidade Civil Familiar: rc-familiar Vendaval, furacão, ciclone, tornado, granizo e neve: vendaval Residencial Incêndio, Queda de Raio, Queda de Aeronave, Fumaça, Explosão de Qualquer Natureza e Implosãos: basica Danos elétricos: danos-eletricos Impacto de veículos terrestres: impacto-veiculos Perda ou pagamento de aluguel: perda-aluguel Quebra de vidros e espelhos, mármore e granito: quebra-vidros Ruptura de tubulações: ruptura Roubo e Furto qualificado de Bens: roubo-furto Responsabilidade Civil Familiar: rc-familiar Vendaval, furacão, ciclone, tornado, granizo e neve: vendaval Garantia do Licitante Básica: basica Garantia do Executante Básica: basica Trabalhista: trabalhista Multa: multa Judicial Depósito Recursal Básica: basica Judicial Depósito Recursal - Substituição Básica: basica Judicial Trabalhista Básica: basica Judicial Trabalhista - Substituição Básica: basica RD - Equipamentos Cobertura básica: basica Cobertura Adicional de Furto Simples: furto Cobertura Adicional de Içamento, Carga e Descarga: icamento 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 em operação sobre água: operacao-sobre-agua Cobertura Adicional de Equipamentos próximos a água: operacao-proximo-agua Cobertura Adicional de Danos Elétricos: danos-eletricos Cobertura Adicional de Responsabilidade Civil - Operador: rc-operador Vida Básica: basica Auxílio Funeral: auxilio-funeral Despesa médico hospitalar e odontológica: despesa-medico-hospitalar-odontologica Invalidez por acidente: invalidez Aquisição de Jazigo: jazigo Qualidade Seguro Estrutura Básica Seguro de Qualidade Estrutural: basica Danos Elétricos: danos-eletricos Empresarial Básica Incêndio: basica Quebra de vidros e anúncios luminosos: quebra-vidros Fidelidade de empregados: fidelidade-empregados RC Cabeleireiro: rc-cabeleireiro RC Shopping Centers: rc-shopping-centers Despesas fixas: despesas-fixas RC Farmácias e Drogarias: rc-farmacias-drogarias Alagamento e inundação : alagamento-inundacao RC Empregador : rc-empregador Equipamentos portáteis (home office) : equipamentos-portateis-home-office Roubo de Valores : roubo-valores RC Pet shop : rc-petshop Danos elétricos : danos-eletricos RC Garagista – compreensiva : rc-garagista-compreensiva Desmoronamento : desmoronamento RC Postos de serviço e oficinas : rc-servico-oficinas Exposição e demonstração : exposicao-demonstracao RC Operações : rc-operacoes Impacto de veículos terrestres : impacto-veiculos Derrame de sprinklers : derrame-sprinklers Vendaval : vendaval Perda e/ou pagamento de aluguel : perda-aluguel Mercadorias em ambientes frigorificados : mercadorias-ambientes-frigorificados Tumulto : tumulto Delivery (mercadorias em trânsito) : delivery RC Adicional de percurso : rc-adicional-percurso Roubo e/ou furto qualificado de bens : roubo-furto-bens RC Escola : rc-escola Ruptura de tubulações : ruptura-tubulacao Riscos Nomeados Incêndio, queda de raio, queda de aeronave, fumaça, explosão de qualquer natureza e implosão: basica Despesas fixas: despesas-fixas Equipamentos, bens e mercadorias em exposição e demonstração tremor-terra Tremor de terra, terremoto ou maremoto : exposicao-demonstracao Quebra de máquinas : quebra-maquinas RC Pet shop : rc-pet-shop Lucro bruto (lucro líquido + despesas fixas) : lucro-bruto RC Condomínios comerciais \"Shopping Center\ : rc-comercial-shopping Roubo de valores : furto Fidelidade de empregados : fidelidade-empregador RC Adicional de percurso : rc-adicional-percurso Tumultos, greves e \"lock out\", atos dolosos, vandalismo e comoção civil equipamentos-cinematograficos Equipamentos cinematográficos, fotográficos e de televisão operados exclusivamente em estúdios, laboratórios ou reportagens internas e externas : tumultos-greves-locaute Delivery (mercadorias em trânsito) : delivery RC Farmácias e Drogarias : rc-farmacias-drogarias Rouboe/ou furto qualificado de bens : roubo-furto Mercadorias em ambientes frigorificados : mercadorias-ambientes-frigorificados Danos na fabricação [work damage] : danos-fabricacao Concessionária de Veículos - Excluindo veículos ao ar livre : concessionaria-veiculos-excluido-ar-livre Perda e/ou pagamento de aluguel : perda-aluguel Equipamentos ou objetos portáteis (incluindo home office) :equipamentos-portateis RC Empregador : rc-empregador Interdependência : interdependencia Vendaval, furacão, ciclone, tornado, granizo, tsunami, erupção vulcânica e fumaça : vendaval Impedimento de acesso : impedimento-acesso RC Guarda de veículos de terceiros - colisão, incêndio e roubo alagamento-inundacao Alagamento e Inundação : rc-guarda-veiculos-terceiros RC Cabeleireiro : rc-cabeleireiro Responsabilidade Civil operações estabelecimentos comerciais e/ou industriais icamento Operações de carga, descarga, içamento ou descida derrame-sprinklers Derrame de sprinklers : rc-comerciais-industriais Ruptura de tanques e tubulações : ruptura Concessionária de Veículos - Extensão para veículos em exposição, feiras ou amostra : concessionaria-veiculos-incluso-exposicao Despesas : interrupcao-fornecimento-utilidades Interrupção do Fornecimento de Utilidades (Água e esgoto, Energia elétrica, Gás, Telefonia e Internet) - LC rc-oficinas-mecanicas RC Postos de serviço e oficinas mecânicas : despesas-fixas Quebra de vidros e anúncios luminosos : quebra-vidros Equipamentos móveis, próprios ou arrendados : equipamentos-moveis Concessionária de Veículos - Extensão para veículos armazenados em locais de terceiros : concessionaria-veiculos-incluso-locais-terceiros Lucro liquido : lucro-liquido Honorários de peritos : honorarios-peritos RC Estabelecimentos de ensino : rc-estabelecimentos-ensino Extensão da cobertura a fornecedores e/ou compradores especificados desmoronamento Desmoronamento : extensao-fornecedores-compradores-especificos Impacto de veículos terrestres : impacto-veiculos RC Concessionária de veículos : rc-concessionaria-veiculos Danos elétricos : danos-eletricos Concessionária de Veículos - Extensão para veículos ao ar livre : concessionaria-veiculos-incluso-ar-livre Aluguel Cob. Básica - Inadimplência de Aluguel e Encargos Legais (Circ. 587): basica Cobertura básica para modalidades incompletas do legado: basica-aluguel Cob. Adic. de Multa por Rescisão Contratual (Circ. 587): multa-rescisao-contratual Cob. Adic. de Pintura Interna e/ou Externa (Circ. 587): pintura Cob. Adic. de Danos ao Imóvel (Circ. 587): danos-imovel Cob. Adic. de Encargos Legais - Água (Circ. 587): encargos-legais-agua Cob. Adic. Enc. da Locação - Ar Condicionado (Circ. 587): ar-condicionado Cob. Adic. de Encargos Legais - IPTU (Circ. 587): encargos-legais-iptu Cob. Adic. de Danos ao Imóvel (Circ. 587): danos-imovel Cob. Adic. de Encargos Legais - Gás Canalizado (Circ. 587): encargos-legais-gas Cob. Adic. Enc. da Locação - Fundo de Promoção (Circ. 587): locacao-fundo-promocao Cob. Adic. de Encargos Legais - Luz (Circ. 587): encargos-legais-luz Cob. Adic. de Encargos Legais - Despesas Ordinárias Condominiais (Circ. 587): encargos-legais-condominiais Pintura Externa: pintura-externa Condomínio: condominio Gás: gas Luz: luz Água: agua Pintura Interna: pintura-interna Pintura Interna e Externa do Imóvel: pintura Multa por rescisão contratual: multa-rescisao Danos ao Imóvel: danos IPTU : iptu Garantia Estendida Cobertura Trem de Força: trem-forca Cobertura Componentes: componentes Cobertura Premier: premier Riscos Engenharia Básica: basica Obras / instalações contratadas - Aceitas ou Colocadas em operação: obras-operacao Responsabilidade Civil Geral e Cruzada - Sem Fundações: rc-geral-cruzada-sem-fundacoes Danos Morais (Extensão da Cobertura de Responsabilidade Civil Geral e Cruzada): danos-morais Riscos de Engenharia: riscos-engenharia Responsabilidade Civil Geral e Cruzada - Com fundações construcoes-temporarias Construções Temporárias: rc-geral-cruzada-com-fundacoes Manutenção Ampla: manutencao-ampla Despesas Extraordinárias: despesas-extraordinarias Cobertura Adicional de Stands de Vendas: adicional-stands-vendas Ferramentas de Pequeno e Médio Porte: ferramentas-pequeno-medio-porte Propriedades Circunvizinhas: propriedades-circunvizinhas Honorários de Peritos: honorarios-peritos Equipamentos Móveis e estacionários utilizados na Obra: equipamentos-obra Responsabilidade Civil Empregador (Extensão da Cobertura de Responsabilidade Civil Geral e Cruzada: rc-empregador Danos Físicos em Consequência de Riscos do Fabricante para Máquinas e Equipamentos Novos: danos-fisicos-fabricantes-novos Danos Físicos em Consequência de Erro de Projeto para Obras Civis: danos-fisicos-erro-obras Equipamentos de Escritório e Informática: equipamentos-escritorio Riscos de derramamento, infiltração ou descarga de água (Ext. da Cobert. Resp. Civil Geral e Cruzada: derramamento-agua Lucros Cessantes (extensão da cobertura de Responsabiliade Civil Geral e Cruzada): lucros-cessantes Salvamento e Contenção de Sinistro: salvamento-contencao-sinistro Incêndio após Entrega da Obra: incendio-apos-entrega Propriedades Circunvizinhas: propriedades-circunvizinhas Recomposição e Registro de Documentos: recomposicao-registro-documentos Afretamento de Aeronaves: afretamento-aeronaves Manutenção Simples: manutencao-simples Tumultos, Greves e Locaute: tumultos-greves-locaute Manutenção Ampla: manutencao-ampla Despesas de remoção de entulho do local segurado: remocao-entulho Obras Civis, Instalações e Montagens Concluídas: obras-civis-concluidas Construções temporárias:construcoes-temporarias Armazenagem fora do canteiro de obras ou local do risco:armazenagem-fora-canteiro-local-risco Término de Obras - CAVA Básica: basica Término de Obras - Infraestrutura Básica: basica Garantia de Término de Obras Básica: basica Término de Obras - Manutenção Corretiva:termino-obras-corretiva Básica: basica Término de Obras - Banco do Brasil Básica: basica
insuredAmount	number	Somente leitura	Importância segurada, ou valor segurado, deste objeto de risco.

Property

Representa uma propriedade que está sendo segurada nos seguros do grupo Patrimonial.

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Property"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
address	Address	Somente leitura	Endereço da propriedade que está sendo segurada.
historicalProtectedProperty	boolean	Somente leitura	Identifica se a propriedade é protegida pelo patrimônio histórico.
sharedProperty	boolean	Somente leitura	Identifica se a propriedade é uma republica ou pensão.
insuredOwner	boolean	Somente leitura	Identifica se o segurado é dono da propriedade.
constructionType	string (ConstructionType)	Somente leitura	Define o tipo de construção da propriedade.
propertyType	string (PropertyType)	Somente leitura	Tipo da propriedade segurada.
propertyUseType	string (PropertyUseType)	Somente leitura	Tipo de uso da propriedade segurada.

ConstructionType

Lista os possíveis tipos de construção de propriedade.

Brick: Alvenaria.
Wood: Madeira.
WoodAndBrick: Madeira e alvenaria.

PropertyUseType

Lista os possíveis tipos de uso de propriedade.

Usual: Habitual.
Summer: Veraneiro.
Vacate: Desocupada.

PropertyType

Lista os possíveis tipos de propriedade.

Apartment: Apartamentos.
CondominiumApartment: Apartamentos em condomínios.
House: Casas.
CondominiumHouse: Casas em condomínios.
CountrySideHouse: Casas no campo.

Equipment

Representa um equipamento que está sendo segurado.

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Equipment"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
equipmentDetails	EquipmentDetails	Somente leitura	Detalhes do equipamento segurado.
equipmentLocation	EquipmentLocation	Somente leitura	Detalhes da localização do equipamento segurado.
invoiceNumber	string	Somente leitura	Número da Nota Fiscal ou Contrato de aquisição do equipamento.
invoiceDate	string (date)	Somente leitura	Data de emissão da Nota Fiscal ou Contrato de aquisição do equipamento.
operatingInUndergroundSiteOrTunnelDigging	boolean	Somente leitura	Identifica se o equipamento está trabalhando em túneis ou galerias subterrâneas.
cededInGuaranteeOfRuralCredit	boolean	Somente leitura	Identifica se o equipamento foi cedido em garantia de crédito rural?
operatesOnWater	boolean	Somente leitura	Identifica se o equipamento opera na água.
performsPeriodicMaintenance	boolean	Somente leitura	Identifica se o equipamento passa por manutenções periódicas.
operatorsAreTrained	boolean	Somente leitura	Identifica se o equipamento é operado por pessoal treinado.
equipmentCanBeRented	boolean	Somente leitura	Identifica se o equipamento pode ser alugado para terceiros.
feeMultiple	string	Somente leitura	Identifica a taxa múltipla.
indemnityPeriod	string	Somente leitura	Identifica o período de indenização.
privateClauseFranchise	string	Somente leitura	Identifica a cláusula de franquia.
utilizationType	string	Somente leitura	Tipo da utilização do equipamento. civil: CONSTRUÇÃO CIVIL comercio: COMÉRCIO demais: DEMAIS (EXCETO FLORESTAL E USO EXCLUSIVAMENTE EM ATIVIDADE RURAL) locacao: LOCAÇÃO DE EQUIPAMENTOS servico: PRESTAÇÃO DE SERVIÇOS COM OPERADOR PRÓPRIO hospitalar: MÉDICO HOSPITALAR industria: INDÚSTRIA terraplanagem: TERRAPLANAGEM agricolas: ATIVIDADES NÃO AGRÍCOLAS

EquipmentDetails

Contém informações detalhadas sobre o equipamento.

Campo	Tipo	Regras	Descrição
manufacturer	string	Somente leitura	Fabricante do equipamento.
model	string	Somente leitura	Modelo do equipamento.
serialNumber	string	Somente leitura	Número de série do equipamento.
chassis	string	Somente leitura	Chassi do equipamento. Esse campo é obrigatório caso seja um equipamento que tenha chassi.
manufactureYear	number (Int32)	Somente leitura	Ano de fabricação do equipamento
equipmentType	number	Somente leitura	Identificador do Tipo de equipamento segurado.
equipmentValue	number	Somente leitura	Valor do equipamento
equipmentUse	string	Somente leitura	Uso do equipamento.

EquipmentLocation

Campo	Tipo	Regras	Descrição
nationalCoverage	boolean	Somente leitura	Identifica se a cobertura do equipamento é para todo o território nacional.
address	Address	Somente leitura	Representa uma localidade com endereço.

Contract

Representa um contrato.

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Contract"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
contractNumber	string	Somente leitura	Número do contrato.
contractAmount	number	Somente leitura	Valor total do contrato.
processNumber	string	Somente leitura	Número do processo.
noticeNumber	string	Somente leitura	Número do edital.
additionalInformation	string	Somente leitura	Informações adicionais.
observation	string	Somente leitura	Campo informativo para servir como auxílio para a tomada de decisão interna.
duration	number	Somente leitura	Duração do contrato.
civilWorkType	string (CivilWorkType)	Somente leitura	Tipo de obra civil.

CivilWorkType

Tipo de obra civil

InfrastructurePaving: Pavimentação de Infraestrutura.
BasicSanitationDrainage: Drenagem Sanitária Básica.
ResidentialCommercialIndustryBuilding: Edifício Industrial Residencial Comercial.
NonStructuralRemodelingExpansion: Expansão de Remodelação Não Estrutural.

JudicialProcess

Representa um processo judicial.

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "JudicialProcess"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
processNumber	number	Somente leitura	Número do processo judicial. Informar somente os dígitos.
documentValidityPeriod	number (Int32)	Somente leitura	Prazo de validade do documento, em anos. Os valores possíveis são 3, 4 ou 5 anos.
appealType	string (AppealType)	Somente leitura	Tipo do recurso.
courtName	string	Somente leitura	Número da vara e comarca.
resourceType	string	Somente leitura	Tipo Recurso.

AppealType

Lista os possíveis tipos de recurso.

AggravationInstrument: Agravo de instrumento.
Embargo: Embargos.
RevisionAppeal: Recurso revista.
TerminationActionAppeal: Recurso ação rescisória.
ExtraordinaryAppeal: Recurso extraordinário
OrdinaryAppeal: Recurso ordinário.

Address

Representa uma localidade com endereço.

Campo	Tipo	Regras	Descrição
street	string	Somente leitura	Nome da avenida, rua ou praça da localidade.
number	string	Somente leitura	Número da localidade.
district	string	Somente leitura	Bairro do localidade.
city	string	Somente leitura	Nome da cidade da localidade, conforme cadastrado nos Correios.
state	string	Somente leitura	Sigla do estado da localidade, com duas letras.
zipCode	string	Somente leitura	CEP da localidade. Devem ser informados somente os dígitos.
complement	string	Somente leitura	Complemento da localidade. Apartamento, andar.

Installment

Representa os dados referentes ao pagamento da apólice.

Campo	Tipo	Regras	Descrição
currency	string	Somente leitura	Tipo de Moeda.
paymentType	string	Somente leitura	Possíveis formas de pagamento da apólice.
status	string	Opcional	Lista os possíveis status da parcela. Pago: Parcela paga. Aberto: Parcela em aberto.
dueDate	string (date)	Somente leitura	Data de pagamento.
installmentNumber	number	Somente leitura	Número da parcela.
installmentAmount	number	Somente leitura	Valor da parcela.

Product

Representa os dados referentes ao produto

Campo	Tipo	Regras	Descrição
key	string	Somente leitura	key do produto conforme cada produto. Imobiliário : imobiliario Residencial : residencial Seguro Estrutural : estrutural Aluguel Fiança Locaticia : aluguel Riscos de Engenharia : riscos-engenharia Pottencial Riscos Nomeados : riscos-nomeados Riscos Empresariais : empresarial Fiança Locatícia - Integral - PF : aluguel-integral-pf Fiança Locatícia - Integral - PJ : aluguel-integral-pj Fiança Locatícia - Tradicional - PF : aluguel-tradicional-pf Fiança Locatícia - Tradicional - PJ : aluguel-tradicional-pj Fiança Locatícia - Essencial - PJ : aluguel-essencial-pj Seguro Fiança Locatícia - Tradicional - PJ : aluguel-tradicional-pj Seguro Fiança Locatícia - Integral - PF : seguro-aluguel-integral-pf Seguro Fiança Locatícia - Essencial - PF : aluguel-essencial-pf Riscos Diversos Máquinas e Equipamentos : maquinas-equipamentos Riscos Diversos Benfeitorias e Produtos Agropecuários : benfeitorias Riscos Diversos Penhor Rural : penhor-rural Garantia Licitante : garantia-bid Garantia Performance : garantia-performance Judicial Execução Fiscal : Judicial-execucao-fiscal Garantia de pagamentos : garantia-pagamento Construção, Fornecimento ou Prestação de Serviço + Manutenção Corretiva Público : contrucao-fornecimento-servico Judicial Trabalhista : judicial-trabalhista Garantia Judicial Civel : Judicial-civel Garantia Estentida : garantia-estendida Garantia Estentida : garantia-adiantamento Garantia Privado Retenção : garantia-retencao Garantia Judicial Trabalhista : judicial-trabalhista Judicial Depósito Recursal Substituição : judicial-deposito-recursal-substituicao Judicial Trabalhista - Substituição : judicial-trabalhista-substituicao Vida :vida Término de Obras - CAVA : termino-obras-cava Término de Obras - Infraestrutura :termino-obras-infraestrutura Garantia de Término de Obras:termino-obras Término de Obras - Manutenção Corretiva:termino-obras-corretiva Término de Obras - Banco do Brasil:termino-obras-bb Garantia Financeira Pagamentos - FINEP:garantia-pagamento Garantia Financeira - FINEP:garantia-adiantamento Garantia de Compra e venda de Energia:garantia-compra-venda-energia Garantia Parcelamento Administrativo Fiscal:judicial-fiscal
group	string	Somente leitura	codigo do produto
line	string	Somente leitura	linha do produto

Insurer

Representa os dados referentes a seguradora

Campo	Tipo	Regras	Descrição
name	string	Somente leitura	nome da seguradora
documentNumber	string	Somente leitura	Cnpj da seguradora
participationPercentage	string	Somente leitura	porcentagem de participação
lead	boolean	Somente leitura	Seguradora principal

Construction

Representa os dados referentes ao objeto de risco de Riscos Engenharia

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Construction"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
description	string	Somente leitura	descrição Riscos engenharia"
riskLocation	RiskLocation	Somente leitura	Representa o Local do Objeto de Risco.

ProductRisk

Representa os dados referentes ao objeto de risco Garantia Estendida

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo Product
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
productDetails	ProductDetails	Somente leitura	Detalhes do Produto segurado.
preventiveMaintenance	boolean	Somente leitura	Manutenção preventiva
budgetNumber	string	Somente leitura	Numero do orçamento
extendedWarrantyHours	number	Somente leitura	Horas de garantia extendida

RentalProperty

Representa os dados referentes ao Aluguel

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo rentalProperty
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
description	string	Somente leitura	descrição do aluguel
rentalAgreement	string (uuid)	Somente leitura	Idntificador do contrato de aluguel
riskLocation	RiskLocation	Somente leitura	Representa o Local do Objeto de Risco.
tenantDocumentNumber	string	Somente leitura	Número do documento do inquilino
tenants	array de Tenants	Somente leitura	Lista de inquilinos segurados.
expenses	array de Expenses	Somente leitura	Lista de despesas.
planId	string (uuid)	Somente leitura	Identificador unico do plano
occupation	string	Somente leitura	Tipo de Ocupação
inhabited	boolean	Somente leitura	é habitada

BusinessProperty

Representa os dados referentes a seguradora

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo BusinessProperty
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
description	string	Somente leitura	descrição do aluguel
riskLocation	RiskLocation	Somente leitura	Representa o Local do Objeto de Risco.
susepRiskObjectType	string	Somente leitura	Susep Tipo de Objeto de Risco
insuredActivityId	string (uuid)	Somente leitura	ID de atividade segurada
productVersionId	string (uuid)	Somente leitura	ID da versão do produto
securityType	number	Somente leitura	tipo de segurança
buildingType	number	Somente leitura	tipo de construção
protectionForFireFighting	number	Somente leitura	proteção para combate a incêndio [0,1]
protectionForTheft	array number	Lista de proteção contra roubo.
isRiskLocatedInShopping	boolean	Somente leitura	o risco está localizado nas compras
extraRate	number	Somente leitura	Taxa extra
lostProfitsAmount	number	Somente leitura	Valor dos lucros perdidos
susepRiskActivityType	string	Somente leitura	Susep Tipo de Atividade de Risco
susepRiskActivityClassType	string	Somente leitura	Susep Tipo de Classe de Atividade de Risco
documentPeriodStart	string	Somente leitura	Data início da validade do documento
documentPeriodEnd	string	Somente leitura	Data fim da validade do documento
objectsByBeneficiary	array de Beneficiary	Somente leitura	Representa um Beneficiario.

Person

Representa os dados referentes ao objeto de risco de Vida

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Person"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
personId	string (uuid)	Somente leitura	Identificador unico da pessoa
birthDate	string (date-time)	Somente leitura	Data de Aniversario da pessoa
gender	string	Somente leitura	Genero da pessoa
haveNoSeriousOrAutoimmuneDisease	boolean	Somente leitura	Não tem doença grave ou autoimune

Structure

Representa os dados referentes ao objeto de risco de Seguro Qualidade Estrutural

Campo	Tipo	Regras	Descrição
type	string	Somente leitura	Nome do tipo do objeto de risco. Valor fixo "Structure"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
description	string	Somente leitura	descrição Riscos engenharia"
riskLocation	RiskLocation	Somente leitura	Representa o Local do Objeto de Risco.
documentPeriod	DocumentPeriod	Somente leitura	Representa um documento.

ProductDetails

Representa os dados referentes ao Produto seguradoro

Campo	Tipo	Regras	Descrição
category	number	Somente leitura	Categoria do Produto
name	string	Somente leitura	Nome do Produto
manufacturer	string	Somente leitura	Nome do Fabricante
model	string	Somente leitura	Modelo do produto
year	number	Somente leitura	Ano do Produto
serialNumber	string	Somente leitura	Numero Serial do produto
serviceMeter	number	Somente leitura	Medidor do Produto
invoiceNumber	string	Somente leitura	Numero nota fiscal do produto
guaranteeDateStart	string (date-time)	Somente leitura	Data de inicio da Garantia
guaranteeDateEnd	string (date-time)	Somente leitura	Data de inicio da Garantia

Tenants

Representa um inquilino.

Campo	Tipo	Regras	Descrição
personId	string (uuid)	Somente leitura	Identificador unico do Inquilino
documentNumber	string	Somente leitura	Cpf do Inquilino
resident	boolean	Somente leitura	Residente
composeIncome	boolean	Somente leitura	compor Renda
income	number	Somente leitura	Renda

DocumentPeriod

Representa um documento.

Campo	Tipo	Regras	Descrição
periodType	string (PeriodType)	Somente leitura	Tempo do Documento
value	number	Somente leitura	Valor do documento

PeriodType

Enum Tempo do Documento

Month: Mês.
Year: Ano(s).

Expenses

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
description	string	Somente leitura	Descrição da despesa
value	number	Somente leitura	Valor da despesa

Beneficiary

Representa um Beneficiario.

Campo	Tipo	Regras	Descrição
documentNumber	string	Somente leitura	numero CPF do Beneficiario
objectValue	number	Somente leitura	Valor do objeto
objectDescription	string	Somente leitura	Descricao sobre o Beneficiario
observations	string	Somente leitura	Observação sobre o Beneficiario

Gender

Sexo da pessoa

Female
Male

RiskLocation

Representa o Local do Objeto de Risco.

Campo	Tipo	Regras	Descrição
street	string	Somente leitura	Nome da avenida, rua ou praça da localidade.
number	string	Somente leitura	Número da localidade.
district	string	Somente leitura	Bairro do localidade.
city	string	Somente leitura	Nome da cidade da localidade, conforme cadastrado nos Correios.
state	string	Somente leitura	Sigla do estado da localidade, com duas letras.
zipCode	string	Somente leitura	CEP da localidade. Devem ser informados somente os dígitos.
complement	string	Somente leitura	Complemento da localidade. Apartamento, andar.

Dicionário

Campo	Tipo	Regras	Descrição
Policy
policyId	string (uuid)	Somente leitura	Identificador único da apólice.
policyNumber	string (string)	Somente leitura	Número da apólice ou endosso.
quoteNumber	string (string)	Somente leitura	Número da cotação.
mainPolicyNumber	string (uuid)	Somente leitura	Número da apólice principal/risco original.
referencePolicyId	string (uuid)	Somente leitura	ID para identificação da apólice anterior.
issuedBy	string (uuid)	Opcional	ID único do emitente da apólice (produtor).
issuedByName	string (string)	Somente leitura	Nome do emitente da apólice (produtor).
proposalNumber	number	Somente leitura	Número da proposta relacionada a apólice atual.
proposalId	string (uuid)	Somente leitura	ID único da proposta relacionada a apólice atual.
reason	string	Somente leitura	Informação textual livre explicando brevemente motivo da emissão.
susepProcessNumber	string	Somente leitura	Informação Número do processo da Susep.
renewalPolicyNumber	string	Opcional	Número da apólice renovada. Preenchido quando o registro for uma renovação de uma apólice anterior.
susepInsuranceCode	string	Opcional	Informação Código da Seguradora detentora da apólice original.
createdAt	string (date-time)	Somente leitura	Data de criação do registro da apólice
issuanceAt	string (date-time)	Somente leitura	Data de emissão da apólice (assinatura e emissão).
policyPeriodStart	string (date)	Somente leitura	Período de vigência inicial.
policyPeriodEnd	string (date)	Somente leitura	Período de vigência final, data em formato UTC.
commercialPremium	number	Somente leitura	Prêmio comercial.
susepPolicyNumber	string	Somente leitura	Número da apólice conforme padrão SUSEP.
grossPremium	number	Somente leitura	Valor do Prêmio bruto.
commissionAmount	number	Somente leitura	Valor total da comissão.
commissionPercentage	number	Somente leitura	Prêmio comercial.
lmg	number	Somente leitura	Limite máximo de garantia da apólice.
issuanceType	string (IssuanceType)	Somente leitura	Tipo de emissão ou tipo da movimentação conforme segue: Apolice: Apólice. EndossoCobrancaAdicional: Endosso Cobrança Adicional. EndossoRestituicao: Endosso Restituição. CancelamentoApoliceComRestituicao: Cancelamento Apólice Com Restituição. CancelamentoEndossoComRestituicao: Cancelamento Endosso Com Restituição. CancelamentoApoliceSemRestituicao: Cancelamento Apólice Sem Restituição. CancelamentoEndossoSemRestituicao: Cancelamento Endosso Sem Restituição. EndossoSemMovimentacao: Endosso Sem Movimentação.
policyType	string (PolicyType)	Opcional	Tipo da apólice informada (relacionado ao LMI - Limite Máximo de Indenização, podendo ser: Único ou Item a Item). Tipo da apólice informada (relacionado ao LMI, podendo ser: Único ou Item a Item contendo um dos valores baixo: Unico. ItemAItem.
endorsementDocumentPeriod	object de EndorsementDocumentPeriod	Opcional	Dados do Endosso.
process	object de Process	Opcional	Processo vinculado à apólice.
externalControlNumber	string	Opcional	Indetificador externo para uso da corretora.
commissionedAgents	array de CommissionedAgent	Somente leitura	Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes..
participants	array de Participant	Somente leitura	Lista de participantes da apólice, que inclui segurado, tomador e beneficiário
insurers	array de Insurer	Somente leitura	Lista de seguradoras .
product	Product	Somente leitura	Produto vinculado à apólice.
riskObjects	array conforme produto array de Property array de Equipment array de Contract array de JudicialProcess array de Construction array de ProductRisk array de RentalProperty array de BusinessProperty array de Person array de Structure	Somente leitura	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado. Property Imobiliario Residencial Enviar um único objeto Property. Contract Garantia Bid Performance Enviar um único objeto Contract. JudicialProcess Garantia Judicial Depósito Recursal e Garantia Judicial Trabalhista Enviar um único objeto JudicialProcess. Equipment Riscos Diversos Maquinas e Equipamentos, Penhor Rural e Benfeitorias Enviar um ou mais objetos Equipment. Person Vida Enviar um objetos Person. BusinessProperty Riscos Nomeados e Empresarial Enviar um objetos BusinessProperty. BusinessProperty Riscos Nomeados e Empresarial Enviar um objetos BusinessProperty. RentalProperty Aluguel Enviar um objetos RentalProperty. Product Garantia Estendida Enviar um objetos Product. Construction Riscos Engenharia Enviar um objetos Construction. Structure Qualidade Seguro Estrutural Enviar um objetos Structure.
installments	array de Installment	Opcional	Lista dados financeiros da apólice.
installmentsQuantity	number	Somente leitura	Quantidade de parcelas do documento.
Participant
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 vizíveis. Os demais são substituídos por asterísco (). Exemplos de retorno: 11699534000174 -> 11699\\\0001\\ 12345678909 -> 123\\\789\\*
role	string (ParticipantRole)	Obrigatório	Descrição do tipo de participante. 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, 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).
personId	string (uuid)	Somente leitura	ID único no Person do participante.
email	string	Somente leitura	Email do participante.
phoneNumber	string	Somente leitura	Telefone do participante.
name	string	Opcional	Nome do participante.
address	Address	Opcional	Endereço do participante.
type	string (enum)	Somente leitura	Tipo de pessoa. 'Individual' ou 'Corporative'
gender	string	Somente leitura	sexo do participante.
birthDate	string (date)	Somente leitura	data de nascimento do participante.
CommissionedAgent
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 vizíveis. Os demais são substituídos por asterísco (). Exemplos de retorno: 11699534000174 -> 11699\\\0001\\ 12345678909 -> 123\\\789\\*
role	string (CommissionedAgentRole)	Obrigatório	Papel desempenhado pelo agente comissionado. Os papéis obrigatórios variam por produto. 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.
commissionPercentage	number	Opcional	Percentual do prêmio a que o agente comissionado tem direito. O valor deve ter no máximo duas casas decimais e estar entre 0.01 e 1.00.
name	string	Opcional	nome do agente comissionado.
personId	string (uuid)	Somente leitura	ID único no Person do Agente comissionado
Coverage
key	string	Obrigatório	ID da cobertura, conforme cada produto.	Imobiliário Incêndio, Queda de Raio, Queda de Aeronave, Fumaça, Explosão de Qualquer Natureza e Implosãos: basica Danos elétricos: danos-eletricos Impacto de veículos terrestres: impacto-veiculos Perda ou pagamento de aluguel: perda-aluguel Quebra de vidros e espelhos, mármore e granito: quebra-vidros Ruptura de tubulações: ruptura Roubo e Furto qualificado de Bens: roubo-furto Responsabilidade Civil Familiar: rc-familiar Vendaval, furacão, ciclone, tornado, granizo e neve: vendaval Residencial Incêndio, Queda de Raio, Queda de Aeronave, Fumaça, Explosão de Qualquer Natureza e Implosãos: basica Danos elétricos: danos-eletricos Impacto de veículos terrestres: impacto-veiculos Perda ou pagamento de aluguel: perda-aluguel Quebra de vidros e espelhos, mármore e granito: quebra-vidros Ruptura de tubulações: ruptura Roubo e Furto qualificado de Bens: roubo-furto Responsabilidade Civil Familiar: rc-familiar Vendaval, furacão, ciclone, tornado, granizo e neve: vendaval Garantia do Licitante Básica: basica Trabalhista: trabalhista Garantia do Executante Básica: basica Trabalhista: trabalhista Multa: multa Judicial Depósito Recursal Básica: basica Judicial Depósito Recursal - Substituição Básica: basica Judicial Trabalhista Básica: basica Judicial Trabalhista - Substituição Básica: basica Riscos Diversos - Equipamentos, Penhor Rural e Benfeitorias Cobertura básica: basica Cobertura Adicional de Furto Simples: furto Cobertura Adicional de Içamento, Carga e Descarga: icamento 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 em operação sobre água: operacao-sobre-agua Cobertura Adicional de Equipamentos próximos a água: operacao-proximo-agua Cobertura Adicional de Danos Elétricos: danos-eletricos Cobertura Adicional de Responsabilidade Civil - Operador: rc-operador Vida Básica: basica Qualidade Seguro Estrutura a produto. Básica Seguro de Qualidade Estrutural: basica Danos Elétricos: danos-eletricos Empresarial Básica Incêndio: basica Quebra de vidros e anúncios luminosos: quebra-vidros Fidelidade de empregados: fidelidade-empregados RC Cabeleireiro: rc-cabeleireiro RC Shopping Centers: rc-shopping-centers Despesas fixas: despesas-fixas RC Farmácias e Drogarias: rc-farmacias-drogarias Alagamento e inundação : alagamento-inundacao RC Empregador : rc-empregador Equipamentos portáteis (home office) : equipamentos-portateis-home-office Roubo de Valores : roubo-valores RC Pet shop : rc-petshop Danos elétricos : danos-eletricos RC Garagista – compreensiva : rc-garagista-compreensiva Desmoronamento : desmoronamento RC Postos de serviço e oficinas : rc-servico-oficinas Exposição e demonstração : exposicao-demonstracao RC Operações : rc-operacoes Impacto de veículos terrestres : impacto-veiculos Derrame de sprinklers : derrame-sprinklers Vendaval : vendaval Perda e/ou pagamento de aluguel : perda-aluguel Mercadorias em ambientes frigorificados : mercadorias-ambientes-frigorificados Tumulto : tumulto Delivery (mercadorias em trânsito) : delivery RC Adicional de percurso : rc-adicional-percurso Roubo e/ou furto qualificado de bens : roubo-furto-bens RC Escola : rc-escola Ruptura de tubulações : ruptura-tubulacao Riscos Nomeados Incêndio, queda de raio, queda de aeronave, fumaça, explosão de qualquer natureza e implosão: basica Despesas fixas: despesas-fixas Equipamentos, bens e mercadorias em exposição e demonstração tremor-terra Tremor de terra, terremoto ou maremoto : exposicao-demonstracao Quebra de máquinas : quebra-maquinas RC Pet shop : rc-pet-shop Lucro bruto (lucro líquido + despesas fixas) : lucro-bruto RC Condomínios comerciais \"Shopping Center\ : rc-comercial-shopping Roubo de valores : furto Fidelidade de empregados : fidelidade-empregador RC Adicional de percurso : rc-adicional-percurso Tumultos, greves e \"lock out\", atos dolosos, vandalismo e comoção civil equipamentos-cinematograficos Equipamentos cinematográficos, fotográficos e de televisão operados exclusivamente em estúdios, laboratórios ou reportagens internas e externas : tumultos-greves-locaute Delivery (mercadorias em trânsito) : delivery RC Farmácias e Drogarias : rc-farmacias-drogarias Rouboe/ou furto qualificado de bens : roubo-furto Mercadorias em ambientes frigorificados : mercadorias-ambientes-frigorificados Danos na fabricação [work damage] : danos-fabricacao Concessionária de Veículos - Excluindo veículos ao ar livre : concessionaria-veiculos-excluido-ar-livre Perda e/ou pagamento de aluguel : perda-aluguel Equipamentos ou objetos portáteis (incluindo home office) :equipamentos-portateis RC Empregador : rc-empregador Interdependência : interdependencia Vendaval, furacão, ciclone, tornado, granizo, tsunami, erupção vulcânica e fumaça : vendaval Impedimento de acesso : impedimento-acesso RC Guarda de veículos de terceiros - colisão, incêndio e roubo alagamento-inundacao Alagamento e Inundação : rc-guarda-veiculos-terceiros RC Cabeleireiro : rc-cabeleireiro Responsabilidade Civil operações estabelecimentos comerciais e/ou industriais icamento Operações de carga, descarga, içamento ou descida derrame-sprinklers Derrame de sprinklers : rc-comerciais-industriais Ruptura de tanques e tubulações : ruptura Concessionária de Veículos - Extensão para veículos em exposição, feiras ou amostra : concessionaria-veiculos-incluso-exposicao Despesas : interrupcao-fornecimento-utilidades Interrupção do Fornecimento de Utilidades (Água e esgoto, Energia elétrica, Gás, Telefonia e Internet) - LC rc-oficinas-mecanicas RC Postos de serviço e oficinas mecânicas : despesas-fixas Quebra de vidros e anúncios luminosos : quebra-vidros Equipamentos móveis, próprios ou arrendados : equipamentos-moveis Concessionária de Veículos - Extensão para veículos armazenados em locais de terceiros : concessionaria-veiculos-incluso-locais-terceiros Lucro liquido : lucro-liquido Honorários de peritos : honorarios-peritos RC Estabelecimentos de ensino : rc-estabelecimentos-ensino Extensão da cobertura a fornecedores e/ou compradores especificados desmoronamento Desmoronamento : extensao-fornecedores-compradores-especificos Impacto de veículos terrestres : impacto-veiculos RC Concessionária de veículos : rc-concessionaria-veiculos Danos elétricos : danos-eletricos Concessionária de Veículos - Extensão para veículos ao ar livre : concessionaria-veiculos-incluso-ar-livre Aluguel Cob. Básica - Inadimplência de Aluguel e Encargos Legais (Circ. 587): basica Cobertura básica para modalidades incompletas do legado: basica-aluguel Cob. Adic. de Multa por Rescisão Contratual (Circ. 587): multa-rescisao-contratual Cob. Adic. de Pintura Interna e/ou Externa (Circ. 587): pintura Cob. Adic. de Danos ao Imóvel (Circ. 587): danos-imovel Cob. Adic. de Encargos Legais - Água (Circ. 587): encargos-legais-agua Cob. Adic. Enc. da Locação - Ar Condicionado (Circ. 587): ar-condicionado Cob. Adic. de Encargos Legais - IPTU (Circ. 587): encargos-legais-iptu Cob. Adic. de Danos ao Imóvel (Circ. 587): danos-imovel Cob. Adic. de Encargos Legais - Gás Canalizado (Circ. 587): encargos-legais-gas Cob. Adic. Enc. da Locação - Fundo de Promoção (Circ. 587): locacao-fundo-promocao Cob. Adic. de Encargos Legais - Luz (Circ. 587): encargos-legais-luz Cob. Adic. de Encargos Legais - Despesas Ordinárias Condominiais (Circ. 587): encargos-legais-condominiais Pintura Externa: pintura-externa Condomínio: condominio Gás: gas Luz: luz Água: agua Pintura Interna: pintura-interna Pintura Interna e Externa do Imóvel: pintura Multa por rescisão contratual: multa-rescisao Danos ao Imóvel: danos IPTU : iptu Garantia Estendida Cobertura Trem de Força: trem-forca Cobertura Componentes: componentes Cobertura Premier: premier Riscos Engenharia Básica: basica Obras / instalações contratadas - Aceitas ou Colocadas em operação: obras-operacao Responsabilidade Civil Geral e Cruzada - Sem Fundações: rc-geral-cruzada-sem-fundacoes Danos Morais (Extensão da Cobertura de Responsabilidade Civil Geral e Cruzada): danos-morais Riscos de Engenharia: riscos-engenharia Responsabilidade Civil Geral e Cruzada - Com fundações construcoes-temporarias Construções Temporárias: rc-geral-cruzada-com-fundacoes Manutenção Ampla: manutencao-ampla Despesas Extraordinárias: despesas-extraordinarias Cobertura Adicional de Stands de Vendas: adicional-stands-vendas Ferramentas de Pequeno e Médio Porte: ferramentas-pequeno-medio-porte Propriedades Circunvizinhas: propriedades-circunvizinhas Honorários de Peritos: honorarios-peritos Equipamentos Móveis e estacionários utilizados na Obra: equipamentos-obra Responsabilidade Civil Empregador (Extensão da Cobertura de Responsabilidade Civil Geral e Cruzada: rc-empregador Danos Físicos em Consequência de Riscos do Fabricante para Máquinas e Equipamentos Novos: danos-fisicos-fabricantes-novos Danos Físicos em Consequência de Erro de Projeto para Obras Civis: danos-fisicos-erro-obras Equipamentos de Escritório e Informática: equipamentos-escritorio Riscos de derramamento, infiltração ou descarga de água (Ext. da Cobert. Resp. Civil Geral e Cruzada: derramamento-agua Lucros Cessantes (extensão da cobertura de Responsabiliade Civil Geral e Cruzada): lucros-cessantes Salvamento e Contenção de Sinistro: salvamento-contencao-sinistro Incêndio após Entrega da Obra: incendio-apos-entrega Propriedades Circunvizinhas: propriedades-circunvizinhas Recomposição e Registro de Documentos: recomposicao-registro-documentos Afretamento de Aeronaves: afretamento-aeronaves Manutenção Simples: manutencao-simples Tumultos, Greves e Locaute: tumultos-greves-locaute Manutenção Ampla: manutencao-ampla Despesas de remoção de entulho do local segurado: remocao-entulho Obras Civis, Instalações e Montagens Concluídas: obras-civis-concluidas Construções temporárias:construcoes-temporarias Armazenagem fora do canteiro de obras ou local do risco:armazenagem-fora-canteiro-local-risco Término de Obras - CAVA Básica: basica Término de Obras - Infraestrutura Básica: basica Garantia de Término de Obras Básica: basica Término de Obras - Manutenção Corretiva:termino-obras-corretiva Básica: basica Término de Obras - Banco do Brasil Básica: basica
insuredAmount	number	Opcional	Importância segurada, ou valor segurado, deste objeto de risco.
Property
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "Property"
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
address	Address	Obrigatório	Endereço da propriedade que está sendo segurada.
historicalProtectedProperty	boolean	Obrigatório	Identifica se a propriedade é protegida pelo patrimônio histórico.
sharedProperty	boolean	Obrigatório	Identifica se a propriedade é uma republica ou pensão.
insuredOwner	boolean	Obrigatório	Identifica se o segurado é dono da propriedade.
constructionType	string (ConstructionType)	Obrigatório	Define o tipo de construção da propriedade. Lista os possíveis tipos de construção de propriedade. Brick: Alvenaria. Wood: Madeira. WoodAndBrick: Madeira e alvenaria.
propertyType	string (PropertyType)	Obrigatório	Tipo da propriedade segurada. Lista os possíveis tipos de propriedade. Apartment: Apartamentos. CondominiumApartment: Apartamentos em condomínios. House: Casas. CondominiumHouse: Casas em condomínios. CountrySideHouse: Casas no campo.
propertyUseType	string (PropertyUseType)	Obrigatório	Tipo de uso da propriedade segurada. Lista os possíveis tipos de uso de propriedade. Usual: Habitual. Summer: Veraneiro. Vacate: Desocupada.
Equipment
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "Equipment"
coverages	array de Coverage	Somente leitura	Lista de coberturas para o objeto segurado.
equipmentDetails	EquipmentDetails	Somente leitura	Detalhes do equipamento segurado.
equipmentLocation	EquipmentLocation	Somente leitura	Detalhes da localização do equipamento segurado.
invoiceNumber	string	Opcional	Número da Nota Fiscal ou Contrato de aquisição do equipamento.
invoiceDate	string (date)	Opcional	Data de emissão da Nota Fiscal ou Contrato de aquisição do equipamento.
operatingInUndergroundSiteOrTunnelDigging	boolean	Opcional	Identifica se o equipamento está trabalhando em túneis ou galerias subterrâneas.
cededInGuaranteeOfRuralCredit	boolean	Opcional	Identifica se o equipamento foi cedido em garantia de crédito rural?
operatesOnWater	boolean	Opcional	Identifica se o equipamento opera na água.
performsPeriodicMaintenance	boolean	Opcional	Identifica se o equipamento passa por manutenções periódicas.
operatorsAreTrained	boolean	Opcional	Identifica se o equipamento é operado por pessoal treinado.
equipmentCanBeRented	boolean	Opcional	Identifica se o equipamento pode ser alugado para terceiros.
feeMultiple	string	Opcional	Identifica a taxa múltipla.
indemnityPeriod	string	Opcional	Identifica o período de indenização.
privateClauseFranchise	string	Opcional	Identifica a cláusula de franquia.
utilizationType	string	Opcional	Tipo da utilização do equipamento. civil: CONSTRUÇÃO CIVIL comercio: COMÉRCIO demais: DEMAIS (EXCETO FLORESTAL E USO EXCLUSIVAMENTE EM ATIVIDADE RURAL) locacao: LOCAÇÃO DE EQUIPAMENTOS servico: PRESTAÇÃO DE SERVIÇOS COM OPERADOR PRÓPRIO hospitalar: MÉDICO HOSPITALAR industria: INDÚSTRIA terraplanagem: TERRAPLANAGEM agricolas: ATIVIDADES NÃO AGRÍCOLAS
EquipmentDetails
manufacturer	string	Obrigatório	Fabricante do equipamento.
model	string	Obrigatório	Modelo 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.
manufactureYear	number (Int32)	Opcional	Ano de fabricação do equipamento
equipmentType	number	Obrigatório	Identificador do Tipo de equipamento segurado.
equipmentValue	number	Obrigatório	Valor do equipamento
equipmentUse	string	Obrigatório	Uso do equipamento.
EquipmentLocation
nationalCoverage	boolean	Opcional	Identifica se a cobertura do equipamento é para todo o território nacional.
address	object	Opcional	Representa uma localidade com endereço.
Contract
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "Contract"
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
contractNumber	string	Opcional	Número do contrato.
contractAmount	number	Obrigatório	Valor total do contrato.
processNumber	string	Opcional	Número do processo.
noticeNumber	string	Obrigatório	Número do edital.
additionalInformation	string	Opcional	Informações adicionais.
observation	string	Opcional	Campo informativo para servir como auxílio para a tomada de decisão interna.
duration	number	Opcional	Duração do contrato.
civilWorkType	string (CivilWorkType)	Opcional	Tipo de obra civil. Tipo de obra civil InfrastructurePaving: Pavimentação de Infraestrutura. BasicSanitationDrainage: Drenagem Sanitária Básica. ResidentialCommercialIndustryBuilding: Edifício Industrial Residencial Comercial. NonStructuralRemodelingExpansion: Expansão de Remodelação Não Estrutural.
JudicialProcess
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "JudicialProcess"
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
processNumber	number	Obrigatório	Número do processo judicial. Informar somente os dígitos.
documentValidityPeriod	number (Int32)	Obrigatório	Prazo de validade do documento, em anos. Os valores possíveis são 3, 4 ou 5 anos.
appealType	string (AppealType)	Obrigatório	Tipo do recurso. Lista os possíveis tipos de recurso. AggravationInstrument: Agravo de instrumento. Embargo: Embargos. RevisionAppeal: Recurso revista. TerminationActionAppeal: Recurso ação rescisória. ExtraordinaryAppeal: Recurso extraordinário OrdinaryAppeal: Recurso ordinário.
courtName	string	Obrigatório	Número da vara e comarca.
resourceType	string	Opcional	Tipo Recurso.
Address
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	Opcional	Complemento da localidade. Apartamento, andar.
Installment
currency	string	Opcional	Tipo de Moeda.
status	string	Opcional	Lista os possíveis status da parcela. Pago: Parcela paga. Aberto: Parcela em aberto.
paymentType	string	Opcional	Possíveis formas de pagamento da apólice.
dueDate	string (date)	Somente leitura	Data de pagamento.
installmentNumber	number	Opcional	Número da parcela.
installmentAmount	number	Opcional	Valor da parcela.
Product
key	string	Opcional	Imobiliário : imobiliario Residencial : residencial Seguro Estrutural : estrutural Aluguel Fiança Locaticia : aluguel Riscos de Engenharia : riscos-engenharia Pottencial Riscos Nomeados : riscos-nomeados Riscos Empresariais : empresarial Fiança Locatícia - Integral - PF : aluguel-integral-pf Fiança Locatícia - Integral - PJ : aluguel-integral-pj Fiança Locatícia - Tradicional - PF : aluguel-tradicional-pf Fiança Locatícia - Tradicional - PJ : aluguel-tradicional-pj Fiança Locatícia - Essencial - PJ : aluguel-essencial-pj Seguro Fiança Locatícia - Tradicional - PJ : aluguel-tradicional-pj Seguro Fiança Locatícia - Integral - PF : seguro-aluguel-integral-pf Seguro Fiança Locatícia - Essencial - PF : aluguel-essencial-pf Riscos Diversos Máquinas e Equipamentos : maquinas-equipamentos Riscos Diversos Benfeitorias e Produtos Agropecuários : benfeitorias Riscos Diversos Penhor Rural : penhor-rural Garantia Licitante : garantia-bid Garantia Performance : garantia-performance Judicial Execução Fiscal : Judicial-execucao-fical Garantia de pagamentos : garantia-pagamento Construção, Fornecimento ou Prestação de Serviço + Manutenção Corretiva Público : contrucao-fornecimento-servico Judicial Trabalhista : judicial-trabalhista Garantia Judicial Civel : Judicial-civel Garantia Estentida : garantia-estendida Garantia Estentida : garantia-adiantamento Garantia Privado Retenção : garantia-retencao Garantia Judicial Trabalhista : judicial-trabalhista Judicial Depósito Recursal Substituição : judicial-deposito-recursal-substituicao Judicial Trabalhista - Substituição : judicial-trabalhista-substituicao Judicial Execução Fiscal : Judicial-execucao-fiscal Garantia Depósito Recursal : judicial-deposito-recursal Término de Obras - CAVA : termino-obras-cava Término de Obras - Infraestrutura :termino-obras-infraestrutura Garantia de Término de Obras:termino-obras Término de Obras - Manutenção Corretiva:termino-obras-corretiva Término de Obras - Banco do Brasil:termino-obras-bb Garantia Financeira Pagamentos - FINEP:garantia-pagamento Garantia Financeira - FINEP:garantia-adiantamento Garantia de Compra e venda de Energia:garantia-compra-venda-energia Garantia Parcelamento Administrativo Fiscal:judicial-fiscal
group	string	Opcional	codigo do grupo
line	string	Opcional	linha do produto
Insurer
name	string	Opcional	nome da seguradora
documentNumber	string	Opcional	documento da seguradora
participationPercentage	string	Opcional	porcentagem de participação
lead	boolean	Opcional	seguradora principal
Construction
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo "Construction"
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
description	string	Opcional	descrição Riscos engenharia"
riskLocation	object	Opcional	Representa o Local do Objeto de Risco.
ProductRisk
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo Product
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
productDetails	ProductDetails	Opcional	Detalhes do Produto segurado.
preventiveMaintenance	boolean	Opcional	Manutenção preventiva
budgetNumber	string	Opcional	Numero do orçamento
extendedWarrantyHours	number	Opcional	Horas de garantia extendida
RentalProperty
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo BusinessProperty
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
description	string	Opcional	descrição do aluguel
rentalAgreement	string (uuid)	Opcional	Idntificador do contrato de aluguel
riskLocation	object	Opcional	Representa o Local do Objeto de Risco.
tenantDocumentNumber	string	Opcional	Número do documento do inquilino
tenants	array de Tenants	Opcional	Lista de inquilinos segurados.
expenses	array de Expenses	Opcional	Lista de despesas.
planId	string (uuid)	Opcional	Identificador unico do plano
occupation	string	Opcional	Tipo de Ocupação
inhabited	boolean	Opcional	é habitada
BusinessProperty
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo BusinessProperty
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
description	string	Opcional	descrição do aluguel
riskLocation	object	Opcional	Representa o Local do Objeto de Risco.
susepRiskObjectType	string	Opcional	Susep Tipo de Objeto de Risco
insuredActivityId	string (uuid)	Opcional	ID de atividade segurada
productVersionId	string (uuid)	Opcional	ID da versão do produto
securityType	number	Opcional	tipo de segurança
buildingType	number	Opcional	tipo de construção
protectionForFireFighting	number	Opcional	proteção para combate a incêndio [0,1]
protectionForTheft	Opcional	Lista de proteção contra roubo.
isRiskLocatedInShopping	boolean	Opcional	o risco está localizado nas compras
extraRate	number	Opcional	Taxa extra
lostProfitsAmount	number	Opcional	Valor dos lucros perdidos
susepRiskActivityType	string	Opcional	Susep Tipo de Atividade de Risco
susepRiskActivityClassType	string	Opcional	Susep Tipo de Classe de Atividade de Risco
objectsByBeneficiary	array de Beneficiary	Somente leitura	Representa um Beneficiario.
documentPeriodStart	string	Opcional	Data início da validade do documento
documentPeriodEnd	string	Opcional	Data fim da validade do documento
Person
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo "Person"
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
personId	string (uuid)	Opcional	Identificador unico da pessoa
birthDate	string (date-time)	Opcional	Data de Aniversario da pessoa
gender	string	Opcional	Genero da pessoa
haveNoSeriousOrAutoimmuneDisease	boolean	Opcional	Não tem doença grave ou autoimune
Structure
type	string	Opcional	Nome do tipo do objeto de risco. Valor fixo "Structure"
coverages	array de Coverage	Opcional	Lista de coberturas para o objeto segurado.
description	string	Opcional	descrição Riscos engenharia"
riskLocation	RiskLocation	Somente leitura	Representa o Local do Objeto de Risco.
documentPeriod	DocumentPeriod	Somente leitura	Representa um documento.
ProductDetails
category	number	Opcional	Categoria do Produto
name	string	Opcional	Nome do Produto
manufacturer	string	Opcional	Nome do Fabricante
model	string	Opcional	Modelo do produto
year	number	Opcional	Ano do Produto
serialNumber	string	Opcional	Numero Serial do produto
serviceMeter	number	Opcional	Medidor do Produto
invoiceNumber	string	Opcional	Numero nota fiscal do produto
guaranteeDateStart	string (date-time)	Opcional	Data de inicio da Garantia
guaranteeDateEnd	string (date-time)	Opcional	Data de inicio da Garantia
Tenants
personId	string (uuid)	Opcional	Identificador unico do Inquilino
documentNumber	string	Opcional	Cpf do Inquilino
resident	boolean	Opcional	Residente
composeIncome	boolean	Opcional	compor Renda
income	number	Opcional	Renda
DocumentPeriod
periodType	string (PeriodType)	Opcional	Tempo do Documento Enum Tempo do Documento Month: Mês. Year: Ano(s).
value	number	Opcional	Valor do documento
Expenses
description	string	Opcional	Descrição da despesa
value	number	Opcional	Valor da despesa
Beneficiary
documentNumber	string	Opcional	numero CPF do Beneficiario
objectValue	number	Opcional	Valor do objeto
objectDescription	string	Opcional	Descricao sobre o Beneficiario
observations	string	Opcional	Observação sobre o Beneficiario
RiskLocation

Campo	Tipo	Regras	Descrição
street	string	Somente leitura	Nome da avenida, rua ou praça da localidade.
number	string	Somente leitura	Número da localidade.
district	string	Somente leitura	Bairro do localidade.
city	string	Somente leitura	Nome da cidade da localidade, conforme cadastrado nos Correios.
state	string	Somente leitura	Sigla do estado da localidade, com duas letras.
zipCode	string	Somente leitura	CEP da localidade. Devem ser informados somente os dígitos.
complement	string	Somente leitura	Complemento da localidade. Apartamento, andar.

ErrorResult errors array de ErrorMessage Opcional

Lista de erros da solicitação.

ErrorMessage code string Opcional

Código de identificação do erro.

message string Opcional

Descrição do erro.

Partners

Representa um Parceiros comerciais 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	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. Os demais são substituídos por asterisco (). Exemplos de retorno: 11699534000174 -> 11699\\\0001\\ 12345678909 -> 123\\\789\\*
role	string (PartnerRole)	Obrigatório	Papel do parceiro na cotação. Os participantes que são obrigatórios varia por produto.
name	string	Opcional	nome do parceiro

PartnerRole

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

Advisor:Assessor.
CommercialAgent: Agente Comercial .

EndorsementDocumentPeriod

Representa os dados da Data do Endosso.

Campo	Tipo	Regras	Descrição
start	string (date)	Obrigatório	Data informada do Inicio do Endosso.
end	string (date)	Obrigatório	Data informada do Fim do Endosso.

Process

Representa os dados do Tribunal.

Campo	Tipo	Regras	Descrição
number	string	Obrigatório	Numero do Processo.
department	object Department	Obrigatório	Representa os dados da Vara Regional.
court	object Court	Opcional	Representa os dados do tribunal.

Court

Representa os dados do Tribunal.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	Numero do CNPJ do Tribunal.
name	string	Obrigatório	Nome do Tribunal.

Department

Representa os dados da Vara Regional.

Campo	Tipo	Regras	Descrição
name	string	Obrigatório	Nome da Vara relacionado ao Tribunal.

IncludesType

Adicionar ou remover informações conforme necessário.

CommissionedAgents: Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes.
Participants: Lista de participantes da apólice, que inclui segurado, tomador e beneficiário.
RiskObjects: Lista de Objeto de risco conforme cada produto.
Insurers: Lista de seguradoras.
Product: dados do Produto vinculado à apólice, como grupo e ramo.
Partners: Lista de Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.
Installments: Lista dados financeiros da apólice.
Process: Dados do processo como Vara e Tribunal.

Consultar documento de apólices e endossos

Essa operação permite consultar o documento no formato PDF (BLOB) de uma apólice ou endosso a partir do ID ou PolicyNumber (O mesmo que endorsement number para o caso de endosso).

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/policymanager/v1/policies/document
Method	Get
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Query	policyId	string (uuid)	Identificador único da apólice ou endosso.
Query	policyNumber	string	Número da apólice ou endosso.

Respostas (Response)

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

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

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array de ErrorMessage	Somente leitura	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

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

Idioma

Undefined

PolicyManagement

Formulário de busca

Pré-requisitos

Consultar Apólices e Endossos

Requisição (Request)

Respostas (Response)

Histórico de apólices/endossos - Clientes Nomeados

Observação

Exemplo

Schemas e Models

Policy

PolicyType

DocumentType

IssuanceType

Participant

ParticipantRole

CommissionedAgent

CommissionedAgentRole

Coverage

Property

ConstructionType

PropertyUseType

PropertyType

Equipment

EquipmentDetails

EquipmentLocation

Contract

CivilWorkType

JudicialProcess

AppealType

Address

Installment

Product

Insurer

Construction

ProductRisk

RentalProperty

BusinessProperty

Person

Structure

ProductDetails

Tenants

DocumentPeriod

PeriodType

Expenses

Beneficiary

Gender

RiskLocation

Dicionário

Partners

PartnerRole

EndorsementDocumentPeriod

Process

Court

Department

IncludesType

Consultar documento de apólices e endossos

Requisição (Request)

Respostas (Response)

Resolução de erros

Estrutura da mensagem de erro

ErrorResult

ErrorMessage

Menu do rodapé