Permite obter a Apólices e ou Endossos Emitidos na Pottencial.
Representa uma resposta que está sendo enviada para os parceiros.
{
"policyId": "c03ab663-3d5c-4014-aa5e-cae727103392",
"policyNumber": "1234567890",
"quoteNumber": "78232",
"mainPolicyNumber": "1234567890",
"referencePolicyId": "c03ab663-3d5c-4014-aa5e-cae727103392",
"issuedBy": "c03ab663-3d5c-4014-aa5e-cae727103392",
"issuedByName": "Teste 0101",
"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": "ItemAItem",
"renewalPolicyNumber": "1234567890",
"susepInsuranceCode": "1234",
"commissionedAgents": [
{
"documentNumber": "11111111111111",
"role": "Broker",
"commissionPercentage": "0.15",
"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": "benfeitorias ",
"group": "01",
"line": "02"
},
"riskObjects": [
{
"type": "Equipment ",
"ulilizationType": "comercio",
"coverages": [
{
"key": "basica",
"insuredAmount": "50000.00"
},
{
"key": "furto",
"insuredAmount": "10000.00"
},
{
"key": "icamento",
"insuredAmount": "10000.00"
},
{
"key": "perda-aluguel",
"insuredAmount": "10000.00"
},
{
"key": "rc-maquinas",
"insuredAmount": "10000.00"
},
{
"key": "operacao-sobre-agua",
"insuredAmount": "10000.00"
},
{
"key": "operacao-proximo-agua",
"insuredAmount": "10000.00"
},
{
"key": "danos-eletricos",
"insuredAmount": "10000.00"
},
{
"key": "rc-operador",
"insuredAmount": "10000.00"
}
],
"participation": [
{
"documentNumber": "22222222222222",
"participationPercentage": "0.4"
},
{
"documentNumber": "33333333333333",
"participationPercentage": "0.6"
}
],
"equipmentDetails": {
"manufacturer": "Fabricante",
"model": "Modelo do equipamento",
"serialNumber": "Número de série do equipamento",
"chassis": "Número do chassi",
"manufactureYear": "2021",
"equipmentType": "1",
"equipmentValue": "2500000.00",
"equipmentUse": "Comércio"
},
"equipmentLocation": {
"nationalCoverage": "false",
"address": {
"street": "Av. Raja Gabáglia",
"number": "1143",
"district": "Luxemburgo",
"city": "Belo Horizonte",
"state": "MG",
"zipCode": "30380403",
"complement": "20º andar"
}
},
"invoiceNumber": "NF1111",
"invoiceDate": "2021-01-01",
"operatingInUndergroundSiteOrTunnelDigging": "false",
"cededInGuaranteeOfRuralCredit": "false",
"operatesOnWater": "false",
"performsPeriodicMaintenance": "false",
"operatorsAreTrained": "false",
"equipmentCanBeRented": "false",
"feeMultiple": "1",
"indemnityPeriod": "0",
"privateClauseFranchise": "false"
}
],
"installmentsQuantity": "1",
"installments": [
{
"currency": "BRL",
"paymentType": "Boleto",
"dueDate": "2022-03-07T03:00:00",
"interest": "10.6",
"InstallmentNumber": "1",
"installmentAmount": "151151.92",
"status": "Aberto"
}
]
}
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. |
endorsementDocumentPeriod | object de EndorsementDocumentPeriod | Opcional | Dados do Endosso. |
court | object de Court | Opcional | Tribunal vinculado à apólice. |
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
|
Somente leitura |
Lista de objetos segurados. Os objetos segurados variam conforme o produto informado. ImobiliárioEnviar um único objeto Property. ResidencialEnviar um único objeto Property. Garantia do LicitanteEnviar um único objeto Contract. Garantia do ExecutanteEnviar um único objeto Contract. Judicial Depósito RecursalEnviar um único objeto JudicialProcess. Judicial Depósito Recursal - SubstituiçãoEnviar um único objeto JudicialProcess. Judicial TrabalhistaEnviar um único objeto JudicialProcess. Riscos DiversosEnviar um ou mais objetos Equipment. VidaEnviar um objetos Person. EmpresarialEnviar um objetos BusinessProperty. Riscos NomeadosEnviar um objetos BusinessProperty. AluguelEnviar um objetos RentalProperty. Garantia EstendidaEnviar um objetos Product. Riscos EngenhariaEnviar um objetos Construction. Qualidade Seguro EstruturalEnviar um objetos Structure. |
installments | array de Installment | Somente leitura |
Lista dados financeiros da apólice. |
installmentsQuantity | number | Somente leitura |
Quantidade de parcelas do documento. |
Tipo da apólice informada (relacionado ao LMI - Limite Máximo de Indenização, podendo ser: Único ou Item a Item).
Tipo de documento.
Tipo de emissão ou tipo da movimentação conforme segue:
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. . |
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. |
Lista de possíveis valores para os participantes da apólice.
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 |
Lista de possíveis valores para os agentes comissionados da apólice.
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
Residencial
Garantia do Licitante
Garantia do Executante
Judicial Depósito Recursal
Judicial Depósito Recursal - Substituição
Judicial Trabalhista
Judicial Trabalhista - Substituição
RD - Equipamentos
Vida
Qualidade Seguro Estrutura
Empresarial
Riscos Nomeados
Aluguel
Garantia Estendida
Riscos Engenharia
Término de Obras - CAVA
Término de Obras - Infraestrutura
Garantia de Término de Obras
Término de Obras - Manutenção Corretiva:termino-obras-corretiva
Término de Obras - Banco do Brasil
|
insuredAmount | number | Somente leitura |
Importância segurada, ou valor segurado, deste objeto de risco. |
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. |
Lista os possíveis tipos de construção de propriedade.
Lista os possíveis tipos de uso de propriedade.
Lista os possíveis tipos de propriedade.
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.
|
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. |
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. |
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. |
Tipo de obra civil
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. |
Lista os possíveis tipos de recurso.
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. |
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.
|
dueDate | string (date) | Somente leitura |
Data de pagamento. |
installmentNumber | number | Somente leitura |
Número da parcela. |
installmentAmount | number | Somente leitura |
Valor da parcela. |
Representa os dados referentes ao produto
Campo | Tipo | Regras | Descrição |
key | string | Somente leitura |
key do produto conforme cada produto.
|
group | string | Somente leitura |
codigo do produto |
line | string | Somente leitura |
linha do produto |
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 |
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. |
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 |
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 |
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. |
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 |
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. |
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 |
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 |
Representa um documento.
Campo | Tipo | Regras | Descrição |
periodType | string (PeriodType) | Somente leitura |
Tempo do Documento |
value | number | Somente leitura |
Valor do documento |
Enum Tempo do Documento
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 |
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 |
Sexo da pessoa
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. |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Contract Garantia Bid Performance
JudicialProcess Garantia Judicial Depósito Recursal e Garantia Judicial Trabalhista
Equipment Riscos Diversos Maquinas e Equipamentos, Penhor Rural e Benfeitorias
Person Vida
BusinessProperty Riscos Nomeados e Empresarial
BusinessProperty Riscos Nomeados e Empresarial
RentalProperty Aluguel
Product Garantia Estendida
Construction Riscos Engenharia
Structure Qualidade Seguro Estrutural
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
personId | string (uuid) | Somente leitura |
ID único no Person do participante. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Residencial
Garantia do Licitante
Garantia do Executante
Judicial Depósito Recursal
Judicial Depósito Recursal - Substituição
Judicial Trabalhista
Judicial Trabalhista - Substituição
Riscos Diversos - Equipamentos, Penhor Rural e Benfeitorias
Vida
Qualidade Seguro Estruturaa produto.
Empresarial
Riscos Nomeados
Aluguel
Garantia Estendida
Riscos Engenharia
Término de Obras - CAVA
Término de Obras - Infraestrutura
Garantia de Término de Obras
Término de Obras - Manutenção Corretiva:termino-obras-corretiva
Término de Obras - Banco do Brasil
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
propertyType | string (PropertyType) | Obrigatório |
Tipo da propriedade segurada. Lista os possíveis tipos de propriedade.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
propertyUseType | string (PropertyUseType) | Obrigatório |
Tipo de uso da propriedade segurada. Lista os possíveis tipos de uso de propriedade.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Lista de erros da solicitação.
Código de identificação do erro.
Descrição do erro.
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 |
Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.
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. |
Representa os dados do Tribunal.
Campo | Tipo | Regras | Descrição |
regionalCourtName | string | Obrigatório | Nome do Tribunal regionalo. |
regionalCourtCnpj | string | Obrigatório | Cnpj do Tribunal regional. |
courtName | string | Obrigatório | Nome do Tribunal. |
processNumber | string | Obrigatório | Numero do Processo. |