{
"openapi": "3.0.1",
"info": {
"title": "API RE",
"description": "Esta API tem objetivo de criar e integrar jornadas de negócios da Bradesco Seguros e seus Parceiros para a comercialização dos produtos de Ramos Elementares.",
"termsOfService": "https://wwws.bradescoseguros.com.br/wps/portal/SHSG/home/home",
"contact": {
"name": "Bradesco Seguros",
"url": "https://wwws.bradescoseguros.com.br/wps/portal/SHSG/home/home",
"email": "bradescoseguros@bradescoseguros.com.br"
},
"license": {
"name": "Apache License Version 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "v2.3.49"
},
"servers": [
{
"url": "https://parceiros.tu.digiseg.com.br",
"description": "Desenvolvimento"
},
{
"url": "https://parceiros.th.digiseg.com.br",
"description": "Homologação"
},
{
"url": "https://parceiros.bradescoseguros.com.br",
"description": "Produção"
}
],
"paths": {
"/re-analise-comercial/v2/gerarAnaliseComercial": {
"post": {
"tags": [
"Análise Comercial"
],
"summary": "Realiza análise comercial de CPF e CNPJ aplicando regras de restrições de crédito.",
"description": "Realiza análise comercial de CPF e CNPJ aplicando regras de restrições de crédito retornando a aprovação / reprovação e também dados cadastrais vinculados ao documento, quando encontrados.",
"operationId": "gerarAnaliseComercial",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Escolha o tipo de análise a ser realizada nos exemplos abaixo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnaliseComercialREEntity"
},
"examples": {
"AnaliseComercialResidencialPF": {
"summary": "Residencial - Proponente PF",
"description": "**Atende os cenários (A01) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Residencial - Proponente PF\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "100",
"cep": "82250040"
},
"proponente": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataNascimento": "01/01/1990"
}
}
},
"AnaliseComercialResidencialPetPF": {
"summary": "Residencial PET - Proponente PF",
"description": "**Atende os cenários (A01-10) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Residencial - Proponente PF\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "110",
"cep": "82250040"
},
"proponente": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataNascimento": "01/01/1990"
}
}
},
"AnaliseComercialResidencialPJ": {
"summary": "Residencial - Proponente PJ",
"description": "**Atende os cenários (A02) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Residencial com Proponente PJ\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "100",
"cep": "83566000"
},
"proponente": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121"
}
}
},
"AnaliseComercialEmpresarialPF": {
"summary": "Empresarial - Proponente PF",
"description": "**Atende os cenários (B01) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Empresarial com Proponente PF\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "200",
"cep": "82250040"
},
"proponente": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataNascimento": "01/01/1990"
}
}
},
"AnaliseComercialEmpresarialPJ": {
"summary": "Empresarial - Proponente PJ",
"description": "**Atende os cenários (B02) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Empresarial com Proponente PJ\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "200",
"cep": "83566000"
},
"proponente": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121"
}
}
},
"AnaliseComercialEmpresarialPJxPF": {
"summary": "Empresarial - Proponente PJ e Representante PF",
"description": "**Atende os cenários (B03) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Residencial com Proponente PJ e Representante PF\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "200",
"cep": "83566000"
},
"proponente": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121"
},
"representante": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataNascimento": "01/01/1986"
}
}
},
"AnaliseComercialEmpresairalPJxPJ": {
"summary": "Empresarial - Proponente PJ e Representante PJ",
"description": "**Atende os cenários (B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nObjeto de Risco Empresarial com Proponente PJ e Representante PJ\n",
"value": {
"idParceiro": "85684242",
"risco": {
"idTipoRisco": "200",
"cep": "03566000"
},
"proponente": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121"
},
"representante": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "81731250000132"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnaliseComercialRE"
}
}
}
},
"400": {
"description": "Parametro(s) de requisição informado não são valido(s)"
},
"500": {
"description": "Erro inesperado \n\nErro ao tentar gerar o token de autorização."
},
"504": {
"description": "Tempo limite de conexão excedido"
},
"511": {
"description": "Token inválido ou expirado."
}
}
}
},
"/re/v1/parceiro/{idParceiro}/produtos/{idProduto}/plano/{idPlano}/parcelamento": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte as opções de parcelamento de produtos.",
"description": "Obtém as opções de parcelamento para um determinado parceiro, produto e plano.",
"operationId": "opcoesDeParcelamento",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idPlano",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Consulta realizada com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpcoesParcelamentoResponse"
},
"examples": {
"Exemplo de resposta com sucesso": {
"summary": "Resposta JSON contendo status, parceiro, produto e parcelamento",
"description": "Exemplo de resposta com sucesso",
"value": {
"requestStatus": {
"code": "200",
"message": "OK",
"description": "N/A",
"requestStatusId": "2a10c69e-da21-48f4-9fe6-503b2f3e93f9"
},
"parceiro": {
"parceria": {
"idParceiro": "12345678"
}
},
"produto": {
"id": "123",
"idPlano": "4"
},
"parcelamento": [
{
"opcao": "1",
"quantidadeParcelas": "2",
"valorPrimeiraParcela": 36000,
"valorDemaisParcelas": 36000,
"valorTotal": 72000,
"percentualJurosTotal": 0
},
{
"opcao": "2",
"quantidadeParcelas": "5",
"valorPrimeiraParcela": 18000,
"valorDemaisParcelas": 18000,
"valorTotal": 90000,
"percentualJurosTotal": 0
}
]
}
}
}
}
}
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"404": {
"description": "Opções de parcelamento não configuradas para o produto e parceiro informados."
},
"500": {
"description": "Erro inesperado."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido.\n\nToken inválido ou expirado."
}
}
}
},
"/re/v1/parceiro/{idParceiro}&{idCanal}&{numeroBloco}/produtos": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte os produtos disponíveis para comercialização.",
"description": "Obtém dados de produtos para a realização de cotação de produtos residenciais pré-formatados.",
"operationId": "getProduto",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idCanal",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutoResponseEntity"
}
}
}
},
"206": {
"description": "Produto(s) não encontrado(s) para o parceiro informado."
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"401": {
"description": "Não Autorizado."
},
"403": {
"description": "Acesso Proibido."
},
"404": {
"description": "Não encontrado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/{idParceiro}&{numeroBloco}/produtos/{idProduto}/planos/": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte a relação de planos vinculados aos produtos comercializados.",
"description": "Obtém dados de planos para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getPlano",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanoResponseEntity"
}
}
}
},
"206": {
"description": "Produto(s) não encontrado(s) para o parceiro informado. \n\nPlano(s) não encontrado(s) para o produto informado. \n\nCobertura(s) não encontrado(s) para o plano informado. \n\n"
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"401": {
"description": "Não Autorizado."
},
"403": {
"description": "Acesso Proibido."
},
"404": {
"description": "Não encontrado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/{idParceiro}&{numeroBloco}/produtos/{idProduto}/planos/{idPlano}/coberturas/": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte as coberturas para os planos e produtos.",
"description": "Obtém dados de coberturas para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getCobertura",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idPlano",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoberturaResponseEntity"
}
}
}
},
"206": {
"description": "Produto(s) não encontrado(s) para o parceiro informado. \n\nPlano(s) não encontrado(s) para o produto informado. \n\nCobertura(s) não encontrado(s) para o plano informado. \n\n"
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"401": {
"description": "Não Autorizado."
},
"403": {
"description": "Acesso Proibido."
},
"404": {
"description": "Não encontrado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/{idParceiro}/produtos/{idProduto}/assistencias": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte as assistências e kits assistências dos produtos comercializados.",
"description": "Obtém dados de assistências para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getAssistencia",
"parameters": [
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssistenciaResponse"
}
}
}
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"404": {
"description": "Não encontrado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/produtos/{idProduto}/capitalizacao": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte os títulos de capitalização disponíveis.",
"description": "Obtém dados de capitalização para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getCapitalizacao",
"parameters": [
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapitalizacaoResponse"
}
}
}
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"404": {
"description": "Não encontrado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/{idParceiro}/produto/{idProduto}/formasPagamento": {
"get": {
"tags": [
"Produtos"
],
"summary": "Consulte as formas de pagamento dos produtos comercializados.",
"description": "Obtém as formas de pagamento para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getFormaPagamento",
"parameters": [
{
"name": "idProduto",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormaPagamentoResponse"
}
}
}
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"404": {
"description": "Forma(s) de pagamento não configurada(s) para o produto informado."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/produtos": {
"get": {
"tags": [
"Produtos"
],
"summary": "Realize a cotação do seguro.",
"description": "Obtém dados de produtos, planos e coberturas para a realização de cotação de produtos residenciais pré-formatados",
"operationId": "getCotacao",
"parameters": [
{
"name": "idParceiro",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idCanal",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "codigoOperacao",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParceiroResponse"
}
}
}
},
"206": {
"description": "Produto(s) não encontrado(s) para o parceiro informado. \n\nPlano(s) não encontrado(s) para o produto informado. \n\nCobertura(s) não encontrado(s) para o plano informado. \n\n"
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"401": {
"description": "Não Autorizado."
},
"403": {
"description": "Acesso Proibido."
},
"422": {
"description": "O CPF correspondente ao codigoOperacao informado não está elegível."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\nNão foi possível concluir a cotação do seguro \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/parceiro/{idParceiro}/canal/{idCanal}/bloco/{idBloco}/produtos": {
"get": {
"tags": [
"Produtos"
],
"summary": "Realize a cotação do seguro.",
"description": "Obtém dados de produtos, planos e coberturas para a realização de cotação de produtos residenciais pré-formatados\n",
"operationId": "getCotacaoPorPath",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"description": "Identificação de um parceiro.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idCanal",
"in": "path",
"description": "Identificação de um canal.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "idBloco",
"in": "path",
"description": "Número do bloco.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "codigoOperacao",
"in": "query",
"description": "Código da operação (URL-encoded), opcional.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "env",
"in": "header",
"description": "Ambiente da consulta.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParceiroResponse"
}
}
}
},
"206": {
"description": "Produto(s) não encontrado(s) para o parceiro informado. \n\nPlano(s) não encontrado(s) para o produto informado. \n\nCobertura(s) não encontrado(s) para o plano informado.\n"
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"401": {
"description": "Não Autorizado."
},
"403": {
"description": "Acesso Proibido."
},
"422": {
"description": "O CPF correspondente ao codigoOperacao informado não está elegível."
},
"500": {
"description": "Erro inesperado. \n\nErro ao tentar gerar o token de autorização. \n\nNão foi possível concluir a cotação do seguro.\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado.\n"
}
}
}
},
"/re/v1/seguro/analisar-dados-proposta": {
"post": {
"tags": [
"Seguro - Proposta"
],
"summary": "Analise dos dados informados para a proposta de seguro.",
"description": "Analise dos dados informados para a proposta de seguro.",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Escolha o tipo de produto a ser analisado: seguro Residencial ou Empresarial, nos exemplos abaixo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosSegurosPCIRequest"
},
"examples": {
"residencialPF": {
"summary": "A01 - Residencial com Proponente PF",
"description": "**Regras para análise deste cenário:**\n\n- O proponente deve ser pessoa física.\n- O objeto de risco deve ser residencial.\n- O CEP do objeto de risco deve estar dentro da área de cobertura do produto.\n\n**Referência para a validação dos dados de entrada:**\n- Vide cenário \"A01 - Residencial com Proponente PF\" do endpoint \"/re/v1/seguro/efetivar/dados-seguros\"",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "RESIDENCIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"residencialPJ": {
"summary": "A02 - Residencial com Proponente PJ",
"description": "**Regras para análise deste cenário:**\n\n- O proponente deve ser pessoa jurídica.\n- O objeto de risco deve ser residencial.\n- O CEP do objeto de risco deve estar dentro da área de cobertura do produto.\n\n**Referência para a validação dos dados de entrada:**\n- Vide cenário \"A02 - Residencial com Proponente PJ\" do endpoint \"/re/v1/seguro/efetivar/dados-seguros\"",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "2",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "RESIDENCIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPF": {
"summary": "B01 - Empresarial com Proponente PF",
"description": "**Regras para análise deste cenário:**\n\n- O proponente deve ser pessoa física.\n- O objeto de risco deve ser empresarial.\n- O CEP do objeto de risco deve estar dentro da área de cobertura do produto.\n\n**Referência para a validação dos dados de entrada:**\n- Vide cenário \"B01 - Empresarial com Proponente PF\" do endpoint \"/re/v1/seguro/efetivar/dados-seguros\"",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPJ": {
"summary": "B02 - Empresarial com Proponente PJ",
"description": "**Regras para análise deste cenário:**\n\n- O proponente deve ser pessoa jurídica.\n- O objeto de risco deve ser empresarial.\n- O CEP do objeto de risco deve estar dentro da área de cobertura do produto.\n\n**Referência para a validação dos dados de entrada:**\n- Vide cenário \"B02 - Empresarial com Proponente PJ\" do endpoint \"/re/v1/seguro/efetivar/dados-seguros\"",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "2",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Consulta realizada com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalisarProposta"
},
"example": {
"requestStatus": {
"code": "200",
"message": "Dados da proposta analisados com sucesso",
"description": "N/A.",
"requestStatusId": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON.\n",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErroGenerico"
},
{
"$ref": "#/components/schemas/ErroAnaliseDados"
}
]
},
"examples": {
"Erro inesperado": {
"summary": "Erro inesperado",
"description": "Exemplo de erro genérico",
"value": {
"code": "500",
"message": "Erro inesperado.",
"description": "N/A.",
"requestStatusId": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
},
"Falha na análise dos dados": {
"summary": "Falha na análise dos dados",
"description": "Exemplo de erro retornado pela análise",
"value": {
"requestStatus": {
"code": "500",
"message": "Ocorreu uma falha durante a análise dos dados",
"description": "MENSAGEM CONTENDO A CRÍTICA NomePrograma: AFPF0562 SinalSQLCode: + NumSQLCode: 13 SQLCode: 0100",
"requestStatusId": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
}
}
}
}
}
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/efetivar/participantes/dados-pagamentos": {
"post": {
"tags": [
"Seguro - Contratação"
],
"summary": "Realiza o registro de dados de pagamento para a efetivação.",
"description": "Realiza o registro de dados de pagamento de um cliente.",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosPagamentosPCIRequest"
},
"examples": {
"cartaoCredito": {
"summary": "Pagamento via Cartão de Crédito",
"description": "**Atende os cenários de efetivação (A01 a B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de\npagamento via cartão de crédito.\n\n
\n**- Tabela de Domínios de Referência**\n\n**formaPagamento** em v1/seguro/tabelas/dados-cobranca (formaPagamento)\n\n**bandeira** em v1/seguro/tabelas/dados-cobranca (codigoAdmCartaoCredito)\n\n
\n**- Atributos opcionais:**\n\n**cartaoCredito[].codigoSeguranca**\n",
"value": {
"pagamentos": [
{
"formaPagamento": "5",
"cartaoCredito": {
"bandeira": "40002",
"numero": "8353276659629461",
"validade": "082028",
"codigoSeguranca": ""
}
}
]
}
},
"debitoConta": {
"summary": "Pagamento via Débito em Conta",
"description": "**Atende os cenários de efetivação (A01 a B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de\npagamento via débito em conta.\n\n
\n**- Tabela de Domínios de Referência**\n\n**formaPagamento** em v1/seguro/tabelas/dados-cobranca (formaPagamento)\n\n**tipoConta** em v1/seguro/tabelas/dados-cobranca (tipoContaBancaria)\n\n
\n**- Atributos opcionais:**\n\n**contaBancaria[].contaDigito2**\n\n**parcela[].valor**\n",
"value": {
"pagamentos": [
{
"formaPagamento": "2",
"contaBancaria": {
"codigoBanco": "237",
"agenciaNumero": "888",
"agenciaDigito": "8",
"tipoConta": "1",
"contaNumero": "888888",
"contaDigito1": "8",
"contaDigito2": ""
},
"parcelas": [
{
"parcela": {
"dataVencimento": "12/11/2024",
"valor": ""
}
}
]
}
]
}
},
"pagamentoPix": {
"summary": "Pagamento via PIX QRCode",
"description": "**Atende os cenários de efetivação (A01 a B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de\npagamento via débito em conta.\n\n
\n**- Tabela de Domínios de Referência**\n\n**formaPagamento** em v1/seguro/tabelas/dados-cobranca (formaPagamento)\n\n**tipoConta** em v1/seguro/tabelas/dados-cobranca (tipoContaBancaria)\n\n
\n**- Atributo obrigátorio:**\n\n**formaPagamento:**\n\n**Valor 6:** Para pagamento pix parcela unica\n\n**Valor 7:** Para pagamento primeira parcela no pix e demais no débito\n\n\n**- Atributos opcionais:**\n\n**contaBancaria[].contaDigito2**\n\n**parcela[].valor**\n",
"value": {
"pagamentos": [
{
"formaPagamento": "",
"contaBancaria": {
"codigoBanco": "237",
"agenciaNumero": "888",
"agenciaDigito": "8",
"tipoConta": "1",
"contaNumero": "888888",
"contaDigito1": "8",
"contaDigito2": ""
},
"parcelas": [
{
"parcela": {
"dataVencimento": "12/11/2024",
"valor": ""
}
}
]
}
]
}
},
"fatura": {
"summary": "Pagamento via Fatura",
"description": "**Atende os cenários de efetivação (A01 a B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de pagamento via fatura bancária.\n\n**- Tabela de Domínios de Referência**\n\n**formaPagamento** em v1/seguro/tabelas/dados-cobranca (formaPagamento)\n",
"value": {
"pagamentos": [
{
"formaPagamento": "1"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosPagamentosPCIResponse"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/efetivar/participantes/dados-documentos": {
"post": {
"tags": [
"Seguro - Contratação"
],
"summary": "Realiza o registro de dados documentais para a efetivação.",
"description": "Realiza o registro de dados documentais de um cliente.",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosDocumentosPCIRequest"
},
"examples": {
"segmentoPF": {
"summary": "Pessoa Física",
"description": "**Atende os cenários (A01) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de\ndocumento de uma pessoa física.\n\n
\n**- Tabela de Domínios de Referência**\n\n**tipoDocumento** em v1/seguro/tabelas/documentos (tipoDocumento)\n\n
\n**- Atributos opcionais:**\n\n**documentos[].documento[].dataEmissao**\n\n**documentos[].documento[].orgaoExpedidor**\n",
"value": {
"documentos": [
{
"documento": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataEmissao": "13/02/1976",
"orgaoExpedidor": ""
}
}
]
}
},
"segmentoPJ": {
"summary": "Pessoa Jurídica",
"description": "**Atende os cenários (A02, B02, B03 e B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados de\ndocumento de uma pessoa jurídica.\n\n
\n**- Tabela de Domínios de Referência**\n\n**tipoDocumento**: tipoDocumento em v1/seguro/tabelas/documentos (tipoDocumento)\n\n
\n**- Atributos opcionais:**\n\n**documentos[].documento[].dataEmissao**\n\n**documentos[].documento[].orgaoExpedidor**\n\n**quadroSocietario[]**\n",
"value": {
"documentos": [
{
"documento": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121",
"dataEmissao": "",
"orgaoExpedidor": ""
}
}
],
"quadroSocietario": [
{
"nome": "MARIA AMELIA",
"atribuicoes": {
"funcao": "1"
},
"documentos": [
{
"documento": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataEmissao": "",
"orgaoExpedidor": ""
}
}
]
}
]
}
},
"segmentoPFPJ": {
"summary": "Pessoa Física e Jurídica",
"description": "Atende os cenários (B01) da operação \"/v1/seguro/efetivar/dados-seguros\"\n\nEste exemplo mostra os detalhes para a inclusão de dados de\ndocumento de uma pessoa física.\n \n
\n**- Tabela de Domínios de Referência**\n\n**tipoDocumento**: tipoDocumento em v1/seguro/tabelas/documentos (tipoDocumento)\n\n
\n**- Atributos opcionais:**\n\n**documentos[].documento[].dataEmissao**\n\n**documentos[].documento[].orgaoExpedidor**\n",
"value": {
"documentos": [
{
"documento": {
"tipoDocumento": "CPF",
"numeroDocumento": "82542760756",
"dataEmissao": "13/02/1976",
"orgaoExpedidor": "IFP"
}
},
{
"documento": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121",
"dataEmissao": "",
"orgaoExpedidor": ""
}
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosDocumentosPCIResponse"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/efetivar/participantes/dados-cadastrais": {
"post": {
"tags": [
"Seguro - Contratação"
],
"summary": "Realiza o cadastro de dados cadastrais para a efetivação.",
"description": "Realiza o cadastro de dados cadastrais de um cliente.",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosCadastraisPCIRequest"
},
"examples": {
"segmentoPF": {
"summary": "Pessoa Física",
"description": "**Atende os cenários (A01) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados\ncadastrais de uma pessoa física.\n\n
\n**- Tabela de Domínios de Referência**\n\n**sexo** em v1/seguro/tabelas/dados-pessoais (sexo)\n\n**estadoCivil** em v1/seguro/tabelas/dados-pessoais (estadoCivil)\n\n**codigoProfissao** em v1/seguro/tabelas/dados-pessoais (profissao)\n\n**codigoRenda** em v1/seguro/tabelas/dados-pessoais (renda)\n\n**tipo (contato)** em v1/seguro/tabelas/dados-pessoais (tipoContato)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Residencial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**pessoaFisica[].profissao[].atividadePrincipal**\n\n**pessoaFisica[].profissao[].codigoRenda**\n\n**endereco[].complemento**\n\n**endereco[].pais**\n\n**endereco[].tipoEndereco**\n",
"value": {
"dadosCadastrais": {
"pessoaFisica": {
"dataNascimento": "13/02/1976",
"estadoCivil": "7",
"nome": "MARIA AMELIA",
"sexo": "F",
"tipoPessoa": "1",
"profissao": {
"atividadePrincipal": "Supervisor de estagiários",
"codigoProfissao": "1",
"codigoRenda": "1000.00",
"descricaoProfissao": "Outros"
}
}
},
"contatos": [
{
"contato": {
"tipo": "telefonefixo",
"valor": "(81)83809085"
}
},
{
"contato": {
"tipo": "celular",
"valor": "(81)886548722"
}
},
{
"contato": {
"tipo": "email",
"valor": "renatymenezyz@pol.com.br"
}
}
],
"enderecos": [
{
"endereco": {
"logradouro": "BOTAFUEGO",
"complemento": "BL C AP 830",
"numero": "856",
"uf": "RJ",
"bairro": "BOTAFUEGO",
"cep": "82250040",
"cidade": "Rio de Janeiro",
"tipoLogradouro": "RUA",
"pais": "BR",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
]
}
},
"segmentoPJ": {
"summary": "Pessoa Jurídica",
"description": "**Atende os cenários (A02, B02, B03, B04) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados\ncadastrais de uma pessoa jurídica.\n\n
\n**- Tabela de Domínios de Referência**\n\n**classe** em v1/seguro/tabelas/dados-classificacao-risco-produtos (classe)\n\n**tipo (contato)** em v1/seguro/tabelas/dados-pessoais (tipoContato)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**pessoaJuridica[].nomeFantasia**\n\n**pessoaJuridica[].tabelaGrupo**\n\n**pessoaJuridica[].grupoAtividade**\n\n**endereco[].complemento**\n\n**endereco[].pais**\n \n**endereco[].tipoEndereco**\n",
"value": {
"dadosCadastrais": {
"pessoaJuridica": {
"razaoSocial": "LOJA DA FEIRA S/A",
"nomeFantasia": "Feira",
"descricaoAtividadeEconomica": "LOJAS DE DEPARTAMENTOS OU MAGAZINES, EXCETO LOJAS FRANCAS (DUTY FREE)",
"cnae": "8713004",
"classe": "03",
"tabelaGrupo": "",
"grupoAtividade": "",
"renda": "52300,78"
}
},
"contatos": [
{
"contato": {
"tipo": "telefonefixo",
"valor": "(81)83809085"
}
},
{
"contato": {
"tipo": "celular",
"valor": "(81)886548722"
}
},
{
"contato": {
"tipo": "email",
"valor": "renatmenezys@pol.com.br"
}
}
],
"enderecos": [
{
"endereco": {
"logradouro": "Rua Marcos Ribeiro",
"complemento": "",
"numero": "8000",
"uf": "SP",
"bairro": "VILA SANTO AMARO",
"cep": "83566000",
"cidade": "CAMPINAS",
"tipoLogradouro": "RUA",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
]
}
},
"segmentoPJPF": {
"summary": "Pessoa Jurídica e Física",
"description": "**Atende os cenários (B01) da operação \"/v1/seguro/efetivar/dados-seguros\"**\n\nEste exemplo mostra os detalhes para a inclusão de dados\ncadastrais de PF e PJ quando o proponente é um PF mas os dados de Risco são de um PJ.\n\n
\n**- Tabela de Domínios de Referência**\n\n**sexo** em v1/seguro/tabelas/dados-pessoais (sexo)\n\n**estadoCivil** em v1/seguro/tabelas/dados-pessoais (estadoCivil)\n\n**codigoProfissao** em v1/seguro/tabelas/dados-pessoais (profissao)\n\n**codigoRenda** em v1/seguro/tabelas/dados-pessoais (renda)\n\n**classe** em v1/seguro/tabelas/dados-classificacao-risco-produtos (classe)\n\n**tipo (contato)** em v1/seguro/tabelas/dados-pessoais (tipoContato)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**profissao[].atividadePrincipal**\n\n**profissao[].codigoRenda**\n\n**endereco[].complemento**\n\n**endereco[].pais**\n\n**endereco[].tipoEndereco**\n",
"value": {
"dadosCadastrais": {
"pessoaJuridica": {
"razaoSocial": "LOJA DA FEIRA S/A",
"nomeFantasia": "Feira",
"descricaoAtividadeEconomica": "LOJAS DE DEPARTAMENTOS OU MAGAZINES, EXCETO LOJAS FRANCAS (DUTY FREE)",
"cnae": "4713004",
"classe": "03",
"tabelaGrupo": "",
"grupoAtividade": "",
"renda": "52300,78"
},
"pessoaFisica": {
"dataNascimento": "13/02/1976",
"estadoCivil": "3",
"nome": "MARIA AMELIA",
"sexo": "F",
"tipoPessoa": "1",
"profissao": {
"atividadePrincipal": "Supervisor de estagiários",
"codigoProfissao": "1",
"codigoRenda": "1000.00",
"descricaoProfissao": "Outros"
}
}
},
"contatos": [
{
"contato": {
"tipo": "telefonefixo",
"valor": "(81)83809085"
}
},
{
"contato": {
"tipo": "celular",
"valor": "(81)886548722"
}
},
{
"contato": {
"tipo": "email",
"valor": "renatymenezyz@pol.com.br"
}
}
],
"enderecos": [
{
"endereco": {
"logradouro": "Rua Marcos Ribeiro",
"complemento": "",
"numero": "8000",
"uf": "SP",
"bairro": "VILA SANTO AMARO",
"cep": "83566000",
"cidade": "SAO PAULO",
"tipoLogradouro": "RUA",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosCadastraisPCIResponse"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/efetivar/dados-seguros": {
"post": {
"tags": [
"Seguro - Contratação"
],
"summary": "Realiza a efetivação de um seguro.",
"description": "Deve conter o hashs gerados nas operações(dados-pagamentos, dados-documentos e dados-cadastrais)",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Escolha o tipo de produto a ser contratado: seguro Residencial ou Empresarial, nos exemplos abaixo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosSegurosPCIRequest"
},
"examples": {
"residencialPF": {
"summary": "A01 - Residencial com Proponente PF",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro residencial por uma pessoa física.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco (Risco)** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Residencial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idControle**\n\n**produto[].numeroTituloCap**\n\n**produto[].inicioVigencia**\n\n**produto[].fimVigencia**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "RESIDENCIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"ResidencialPETPF": {
"summary": "A01-10 - Residencial PET com Proponente PF",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro residencial por uma pessoa física, **com inclusão de\ninformações de PET**.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Residencial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**produto[].inicioVigencia**\n\n**produto[].fimVigencia**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "RESIDENCIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
},
"adicionalInfo": {
"itens": [
{
"id": "pet",
"caracteristicas": [
{
"chave": "tipo",
"valor": "1"
},
{
"chave": "nome",
"valor": "cachorroLatidor"
}
]
},
{
"id": "pet",
"caracteristicas": [
{
"chave": "tipo",
"valor": "2"
},
{
"chave": "nome",
"valor": "gatoMestre"
}
]
}
]
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"residencialPJ": {
"summary": "A02 - Residencial com Proponente PJ",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro residencial por uma pessoa jurídica.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Residencial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**produto[].inicioVigencia**\n\n**produto[].fimVigencia**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "534",
"cia": "531",
"idCorretor": "878707"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005B7a",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "233",
"canal": "43",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "13/10/2024",
"fimVigencia": "13/10/2025",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "RESIDENCIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 130",
"numero": "356",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPF": {
"summary": "B01 - Empresarial com Proponente PF",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro Empresarial por uma pessoa física.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "915",
"cia": "531",
"idCorretor": "486521"
}
},
"proponente": {
"analiseComercial": {
"etapa": "1",
"codigosOperacao": [
{
"codigoOperacao": "0005CSM",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "237",
"canal": "44",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "03/12/2024",
"fimVigencia": "07/11/2029",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "BOTAFUEGO",
"tipoLogradouro": "RUA",
"complemento": "BL C AP 830",
"numero": "856",
"bairro": "BOTAFUEGO",
"cep": "22250040",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "8599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPJ": {
"summary": "B02 - Empresarial com Proponente PJ",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro empresarial por uma pessoa jurídica.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "915",
"cia": "531",
"idCorretor": "486521"
}
},
"proponente": {
"analiseComercial": {
"etapa": "2",
"codigosOperacao": [
{
"codigoOperacao": "0005CSh",
"tipo": "proponente"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "237",
"canal": "44",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "03/12/2024",
"fimVigencia": "07/11/2029",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "Rua Marcos Ribeiro",
"tipoLogradouro": "RUA",
"complemento": "",
"numero": "881",
"bairro": "VILA SANTO AMARO",
"cep": "82250040",
"cidade": "CAMPINAS",
"uf": "SP",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPJRepresentantePF": {
"summary": "B03 - Empresarial com Proponente PJ e Representante PF",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro empresarial por uma pessoa jurídica com um\nrepresentante pessoa física.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**sexo (Representante)** em v1/seguro/tabelas/dados-pessoais (sexo)\n\n**estadoCivil (Representante)** em v1/seguro/tabelas/dados-pessoais (estadoCivil)\n\n**codigoProfissao (Representante)** em v1/seguro/tabelas/dados-pessoais (profissao)\n\n**codigoRenda (Representante)** em v1/seguro/tabelas/dados-pessoais (renda)\n\n**tipoEndereco (Representante)** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Residencial - tipoEndereco)\n\n**tipoDocumento (Representante)** em v1/seguro/tabelas/documentos (tipoDocumento)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "915",
"cia": "531",
"idCorretor": "886521"
}
},
"proponente": {
"analiseComercial": {
"etapa": "3",
"codigosOperacao": [
{
"codigoOperacao": "0005CKK",
"tipo": "proponente"
},
{
"codigoOperacao": "0005CKL",
"tipo": "representante"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
},
"representante": {
"dadosCadastrais": {
"pessoaFisica": {
"dataNascimento": "13/02/1976",
"estadoCivil": "7",
"nome": "MARIA AMELIA",
"sexo": "F",
"tipoPessoa": "1",
"profissao": {
"atividadePrincipal": "Supervisor de estagiários",
"codigoProfissao": "01",
"codigoRenda": "1000.00",
"descricaoProfissao": "Outros"
}
}
},
"enderecos": [
{
"endereco": {
"logradouro": "BOTAFUEGO",
"complemento": "BL C AP 830",
"numero": "856",
"uf": "RJ",
"bairro": "BOTAFUEGO",
"cep": "82250040",
"cidade": "Rio de Janeiro",
"tipoLogradouro": "RUA",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
],
"documentos": [
{
"documento": {
"tipoDocumento": "RG",
"numeroDocumento": "123456789",
"dataEmissao": "01/01/0001",
"orgaoExpedidor": "IFP"
}
}
]
}
},
"objetosSegurados": [
{
"produto": {
"id": "237",
"canal": "44",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "03/12/2024",
"fimVigencia": "07/11/2029",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "Rua das Arribas",
"tipoLogradouro": "RUA",
"complemento": "AP805",
"numero": "878",
"bairro": "VILA SANTO AMARO",
"cep": "83566000",
"cidade": "CAMPINAS",
"uf": "SP",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "8599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
},
"empresarialPJRepresentantePJ": {
"summary": "B04 - Empresarial com Proponente PJ e Representante PJ",
"description": "Este exemplo mostra os detalhes para a contratação de um\nseguro empresarial por uma pessoa jurídica com um\nrepresentante pessoa jurídica.\n\n
\n**- Tabela de Domínios de Referência**\n\n**etapa** em v1/seguro/tabelas/analise-comercial (etapa)\n\n**classe (Representante)** em v1/seguro/tabelas/dados-classificacao-risco-produtos (classe)\n\n**tipoEndereco (Representante)** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n**tipoDocumento (Representante)** em v1/seguro/tabelas/documentos (tipoDocumento)\n\n**tipoModalidade** em v1/seguro/tabelas/objeto-segurado (tipoModalidade)\n\n**tipo (Risco)** em v1/seguro/tabelas/objetos-risco (tipo)\n\n**tipoEndereco** em v1/seguro/tabelas/dados-classificacao-risco-produtos (Empresarial - tipoEndereco)\n\n
\n**- Atributos opcionais:**\n\n**parceria[].usuario**\n\n**gerente[]**\n\n**vendedor[]** OBS: vendedor[].remuneracaoVenda - Obrigatório quando a contratação for comissionada (CORBAN)\n\n**produto[].idCertificado**\n\n**produto[].numeroTituloCap**\n\n**coberturas[]**\n\n**enderecos[].complemento**\n \n**endereco[].pais**\n\n**recursosAdicionais[]**\n",
"value": {
"seguros": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "85684242",
"usuario": "API_RE",
"sucursal": "915",
"cia": "531",
"idCorretor": "886521"
}
},
"proponente": {
"analiseComercial": {
"etapa": "4",
"codigosOperacao": [
{
"codigoOperacao": "0005CMr",
"tipo": "proponente"
},
{
"codigoOperacao": "0005CMs",
"tipo": "representante"
}
]
},
"dadosEfetivacao": {
"idEfetivacaoDadosCadastrais": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274",
"idEfetivacaoDadosDocumentos": "a99b361c-f777-4991-828f-0b7a68974772",
"idEfetivacaoDadosPagamentos": "0ce089d9-cbd7-49a0-9ccb-13fa0f37642b"
}
},
"vendedor": {
"remuneracaoVenda": {
"idRemuneracao": "100012",
"percentual": 1750
}
},
"representante": {
"dadosCadastrais": {
"pessoaJuridica": {
"razaoSocial": "51.731.250 SILVA GOMES",
"nomeFantasia": "SILVA",
"descricaoAtividadeEconomica": "SERVICOS DE MALOTE NAO REALIZADOS PELO CORREIO NACIONAL",
"cnae": "8320201",
"classe": "03",
"tabelaGrupo": "",
"grupoAtividade": ""
}
},
"documentos": [
{
"documento": {
"tipoDocumento": "CNPJ",
"numeroDocumento": "81731250000132",
"dataEmissao": "",
"orgaoExpedidor": ""
}
}
]
}
},
"objetosSegurados": [
{
"produto": {
"id": "237",
"canal": "44",
"fase": "9",
"idBloco": "1",
"idControle": "",
"idplano": "1",
"numeroTituloCap": "",
"inicioVigencia": "03/12/2024",
"fimVigencia": "07/11/2029",
"modalidade": {
"tipoModalidade": "PRE-FORMATADO",
"campoDisponivel": "",
"opcao": "",
"valorTotal": "",
"valorPrimeiraParcela": "",
"quantidadeParcelas": "",
"valorDemaisParcelas": "",
"percentualJurosTotal": "",
"percentualComissaoCorretor": "",
"codigoUsoObjetoRisco": "",
"fracionamentoProdutoTotal": "",
"custoEmissaoDocumentoTotal": "",
"descontoComercialVendaCorretorTotal": "",
"tipoConstrucaoObjetoRisco": "",
"tipoUsoComercialObjetoRisco": "",
"valorAgravoPremioCoberturaTotal": "",
"valorPremioBrutoCoberturaTotal": "",
"valorPremioCoberturaTotal": "",
"premioLiquidoCoberturaTotal": "",
"limiteMaxIndenizacaoCoberturaTotal": "",
"valorCoberturaIOFTotal": ""
},
"coberturas": [
{
"fracionamentoCoberturaContratada": "",
"descricaoCoberturaContratada": "",
"custoEmissaoCobertura": "",
"descontoComercialVendaCorretorCobertura": "",
"valorAgravoPremioCobertura": "",
"valorPremioBrutoCobertura": "",
"valorPremioFinalCobertura": "",
"premioLiquidoCobertura": "",
"franquiaSUSEPCobertura": "",
"valorFranquiaCobertura": "",
"valorIOFCobertura": "",
"valorMaxFranquiaCobertura": "",
"valorMinFranquiaCobertura": "",
"limiteMaxIndenizacaoCobertura": "",
"percentualFranquiaCobertura": ""
}
]
},
"objetosRisco": [
{
"risco": {
"tipo": "EMPRESARIAL",
"endereco": {
"logradouro": "Rua MArcos Ribeiro",
"tipoLogradouro": "RUA",
"complemento": "",
"numero": "880",
"bairro": "VILA SANTA TERESA",
"cep": "83566000",
"cidade": "CAMPINAS",
"uf": "SP",
"pais": "BR",
"tipoEndereco": "3",
"objetoEndereco": "1"
}
}
}
]
}
],
"produtora": {
"agencia": "3599",
"digitoAgencia": "8",
"unidade": "1"
},
"recursosAdicionais": [
{
"id": "",
"valor": ""
}
]
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EfetivarSeguro"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/endosso/dados-cadastrais": {
"get": {
"tags": [
"Seguro - Endosso"
],
"summary": "Consulte os dados cadastrais do cliente.",
"description": "Realiza uma consulta de dados cadastrais",
"operationId": "consultarDadosCadastrais",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "idCertificado",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versaoDocumento",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosCadastrais"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"404": {
"description": "Dados cadastrais nao encontrados."
},
"500": {
"description": "Erro inesperado.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
},
"post": {
"tags": [
"Seguro - Endosso"
],
"summary": "Efetivar pedido de alteração cadastral.",
"description": "Realiza a alteração de dados cadastrais",
"operationId": "alterarCadastro",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosCadastraisEntity"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlteracaoCadastral"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\nNao foi possivel alterar os dados cadastrais.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
}
},
"/re/v1/seguro/endosso/endosso-cadastral": {
"get": {
"tags": [
"Seguro - Endosso V2"
],
"summary": "Consulte os dados cadastrais do cliente.",
"description": "Realiza uma consulta de dados cadastrais",
"operationId": "consultarDadosCadastraisV2",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "idCertificado",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versaoDocumento",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"examples": {
"DadosCadastraisPF": {
"summary": "Consulta - PF",
"description": "Dados retornado de uma consulta pessoa fisica.",
"value": {
"parceiro": {
"idParceiro": "12345",
"idCertificado": "2699590",
"versaoDocumento": "1",
"usuario": "API-RE"
},
"dadosPessoais": {
"nome": "João Manoel",
"dataNascimento": "01/01/1070",
"sexo": "M",
"estadoCivil": "1"
},
"contato": {
"dddTelefone": "21",
"numeroTelefone": "82920196",
"dddCelular": "21",
"numeroCelular": "885311777",
"email": "email@provedor.com.br"
},
"documento": {
"tipoDocumento": "RG",
"numeroDocumento": "812578028",
"dataExpedicaoDocumento": "01/01/1985",
"orgaoExpeditorDocumento": "IFP"
},
"profissao": {
"codigoProfissao": "1",
"descicaoProfissao": "Professor",
"codigoRenda": "3500.00"
},
"endereco": {
"logradouro": "Rua das Couves",
"numero": "100",
"complemento": "Casa B",
"bairro": "Tijuca",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"cep": "83097833"
},
"enderecoRisco": {
"logradouro": "Rua das Couves",
"numero": "100",
"complemento": "Casa B",
"bairro": "Tijuca",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"cep": "83097833",
"tipoResidencia": "C",
"objeto": "Objeto"
}
}
},
"DadosCadastraisPJ": {
"summary": "Consulta - PJ",
"description": "Dados retornado de uma consulta pessoa juridica.",
"value": {
"parceiro": {
"idParceiro": "12345",
"idCertificado": "2699590",
"versaoDocumento": "1",
"usuario": "API-RE"
},
"pessoaJuridica": {
"razaoSocial": "SENSEDIA S/A",
"cnae": "82914389",
"classe": "A",
"cnpj": "43471859000191"
},
"contato": {
"dddTelefone": "21",
"numeroTelefone": "82920196",
"dddCelular": "21",
"numeroCelular": "885311777",
"email": "email@provedor.com.br"
},
"documento": {
"tipoDocumento": "RG",
"numeroDocumento": "812578028",
"dataExpedicaoDocumento": "01/01/1985",
"orgaoExpeditorDocumento": "IFP"
},
"profissao": {
"codigoProfissao": "1",
"descicaoProfissao": "Professor",
"codigoRenda": "3500.00"
},
"endereco": {
"logradouro": "Rua das Couves",
"numero": "100",
"complemento": "Casa B",
"bairro": "Tijuca",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"cep": "83097833"
},
"enderecoRisco": {
"logradouro": "Rua das Couves",
"numero": "100",
"complemento": "Casa B",
"bairro": "Tijuca",
"cidade": "Rio de Janeiro",
"uf": "RJ",
"cep": "83097833",
"tipoResidencia": "C",
"objeto": "Objeto"
}
}
}
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"404": {
"description": "Dados cadastrais nao encontrados."
},
"500": {
"description": "Erro inesperado.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
},
"post": {
"tags": [
"Seguro - Endosso V2"
],
"summary": "Efetiva pedido de alteração cadastral residencial ou empresarial.",
"description": "Realiza alteração de dados cadastrais residencial ou empresarial",
"operationId": "alterarCadastroV2",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndossoEntity"
},
"examples": {
"EndossoPF": {
"summary": "Endosso - PF",
"description": "Realiza a alteração cadastral para o cenário pessoa fisica",
"value": {
"seguro": {
"participantes": {
"parceiro": {
"idParceiro": "15684242",
"idCertificado": "3807575",
"versaoDocumento": "1",
"usuario": "API_RE"
},
"proponente": {
"dadosCadastrais": {
"pessoaFisica": {
"dataNascimento": "01/01/1950",
"estadoCivil": "7",
"nome": "João da Silva",
"sexo": "M",
"tipoPessoa": "1",
"profissao": {
"atividadePrincipal": "Supervisor de estagiários",
"codigoProfissao": "01",
"codigoRenda": "3000.00",
"descricaoProfissao": "Outros"
}
}
},
"documentos": [
{
"cpfCnpj": "82345678900",
"tipoDocumento": "RG",
"numeroDocumento": "823456789",
"dataExpedicaoDocumento": "01/01/1970",
"orgaoExpedidorDocumento": "IFP"
}
],
"enderecos": [
{
"logradouro": "Rua das Aroeiras",
"complemento": "AP105",
"numero": "1000",
"uf": "RJ",
"bairro": "Tijuca",
"cep": "846660000",
"cidade": "Rio de Janeiro",
"tipoLogradouro": "RUA"
}
],
"contatos": [
{
"tipo": "telefoneFixo",
"valor": "(21)-98235566"
},
{
"tipo": "celular",
"valor": "(21)-981235566"
},
{
"tipo": "email",
"valor": "asd@sensedia.com"
}
]
}
},
"objetoSegurados": [
{
"idCertificado": "3807575"
}
],
"objetosRisco": [
{
"risco": {
"logradouro": "Rua das Aroeiras",
"complemento": "AP105",
"numero": "1000",
"uf": "RJ",
"bairro": "Tijuca",
"cep": "246660000",
"cidade": "Rio de Janeiro",
"tipoLogradouro": "RUA",
"tipoResidencia": "C"
}
}
]
}
}
},
"EndossoPJ": {
"summary": "Endosso - PJ",
"description": "Realiza alteração cadastral para o cenario de pessoa juridica",
"value": {
"seguro": {
"participantes": {
"parceiro": {
"idParceiro": "15684242",
"idCertificado": "3807878",
"versaoDocumento": "1",
"usuario": "API_RE"
},
"proponente": {
"dadosCadastrais": {
"pessoaJuridica": {
"razaoSocial": "MAGAZINE LUIZA S/A",
"cnae": "82348112500",
"classe": "3",
"cnpj": "87960950000121"
}
},
"documentos": [
{
"cpfCnpj": "87960950000121",
"tipoDocumento": "CNPJ",
"numeroDocumento": "87960950000121"
}
],
"enderecos": [
{
"logradouro": "JOAQUIM DE QUEIROZ",
"tipoLogradouro": "RUA",
"complemento": "CS 2 FU",
"numero": "100",
"bairro": "SANTA CLARA",
"cep": "87340510",
"cidade": "BARRA MANSA",
"uf": "RJ",
"pais": "BR",
"tipoEndereco": "A",
"objetoEndereco": "1"
}
],
"contatos": [
{
"tipo": "telefoneFixo",
"valor": "(21)-98235566"
},
{
"tipo": "celular",
"valor": "(21)-981235566"
},
{
"tipo": "email",
"valor": "asd@sensedia.com"
}
]
}
},
"objetoSegurados": [
{
"idCertificado": "3807878"
}
],
"objetosRisco": [
{
"risco": {
"logradouro": "LOGRADOURO",
"tipoLogradouro": "RUA",
"complemento": "CS 2 FU",
"numero": "90",
"bairro": "BENTO RIBEIRO",
"cep": "83566000",
"cidade": "RIO DE JANEIRO",
"uf": "RJ",
"pais": "BR",
"tipoResidencia": "A",
"objetoEndereco": "1"
}
}
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlteracaoCadastral"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\nNao foi possivel alterar os dados cadastrais.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
}
},
"/re/v1/seguro/seguro-cancelar/segurado/dados-pessoais/dados-pagamento": {
"post": {
"tags": [
"Seguro - Cancelamento"
],
"summary": "Realiza o cadastro dos dados de pagamento para o cancelamento do seguro.",
"description": "Realiza o cadastro dos dados de pagamento (restituição) para o cancelamento.",
"operationId": "postCancelarDadosPagamento",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarDadosPagamentoContaBancariaEntity"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarDadosPagamentoResponse"
}
}
}
},
"400": {
"description": "Não foi possível processar os dados fornecidos.\n\nParametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/seguro-cancelar/segurado/dados-pessoais/dados-documento": {
"post": {
"tags": [
"Seguro - Cancelamento"
],
"summary": "Realiza o cadastro dos dados de documento para o cancelamento do seguro.",
"description": "Realiza o cadastro dos dados do documento para o cancelamento.",
"operationId": "postCancelarDadosDocumento",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarDadosDocumentoEntity"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarDadosDocumentoResponse"
}
}
}
},
"400": {
"description": "Não foi possível processar os dados fornecidos.\n\nParametro(s) de entrada invalido(s)."
},
"404": {
"description": "Forma de pagamento nao configurada.\n\nO cliente já possui um seguro ativo.\n\nDado(s) para cancelamento do seguro nao encontrado(s).\n\nErro na validação da conta bancária.\n\nSituação do documento não permite cancelamento.\n\nCódigo de situação do seguro válido somente para proposta.\n\nCNPJ inválido\n\nCPF inválido"
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/seguro/seguro-cancelar/dados-seguro": {
"post": {
"tags": [
"Seguro - Cancelamento"
],
"summary": "Realiza o cancelamento de um seguro.",
"description": "Realiza o cancelamento de um seguro.",
"operationId": "postCancelarDadosSeguro",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarDadosSeguroEntity"
}
}
}
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarSeguro"
}
}
}
},
"400": {
"description": "Não foi possível processar os dados fornecidos.\n\nParametro(s) de entrada invalido(s)."
},
"500": {
"description": "Erro inesperado.\n\nErro ao transformar o objeto JSON."
},
"504": {
"description": "Conexão indisponível com o serviço."
}
}
}
},
"/re/v1/proposta/cancelar": {
"post": {
"tags": [
"Seguro - Proposta"
],
"summary": "Cancelamento de proposta.",
"description": "Efetua o cancelamento de proposta.",
"operationId": "postCancelarProposta",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarPropostaEntity"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelarProposta"
}
}
}
},
"400": {
"description": "Dado(s) invalido(s) \n\nParametro(s) de entrada invalido(s)"
},
"404": {
"description": "Dado(s) para cancelamento da proposta nao encontrado(s)"
},
"500": {
"description": "Erro inesperado \n\nErro ao tentar gerar o token de autorização na API Auth."
},
"504": {
"description": "Tempo limite de conexao excedido"
},
"511": {
"description": "Token nao informado, favor incluir um token valido \n\nToken invalido ou expirado"
}
}
}
},
"/re/v1/seguro/certificado": {
"get": {
"tags": [
"Seguro - Certificados"
],
"summary": "Consulte os documentos por parceiro.",
"description": "Realiza a consulta do(s) documento(s) do parceiro",
"operationId": "consultarBilhete",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "idParceiro",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tipoDocumento",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroDocumento",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BilheteEntity"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"404": {
"description": "Bilhete(s) nao encontrado(s) para o parceiro informado.\n\nDocumento(s) nao encontrado(s) para o status informado."
},
"500": {
"description": "Erro inesperado.\n\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\n\nToken invalido ou expirado."
}
}
}
},
"/v1/seguro/impressao": {
"post": {
"tags": [
"Seguro - Papelaria"
],
"summary": "Imprima os documentos de Apólice, Bilhete ou Certificado do seguro.",
"description": "Realiza a geração de um ou mais documentos de apólice, bilhete ou certificado da papelaria.",
"operationId": "geraDocumentos",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"Impressão": {
"description": "Exemplo de request para impressao de papelaria.\n
\nTodos os atributos são obrigatórios.",
"value": {
"impressao": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "12345678"
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "123",
"numeroProposta": "1234567"
}
}
]
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"examples": {
"Papelaria": {
"description": "Exemplo de response para impressao de papelaria.\n",
"value": {
"requestStatus": {
"code": "200",
"message": "Requisição realizada com sucesso.",
"description": "N/A.",
"requestStatusId": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
},
"impressao": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "12345678"
}
}
},
"objetosSegurados": [
{
"produto": {
"id": "123",
"numeroProposta": "1234567",
"pdfStatus": "OK",
"pdf": "kUyN0ZDMzU0N0VCRDk+PDlGQURBO UFGODZENjFDMTJGNUJFMjdGQzM1NDdFQk Q5Pl0KPj4Kc3RhcnR4cmVmCjgxOTIyOAolJUVPRgo="
}
}
]
}
]
}
}
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"404": {
"description": "Nenhum registro encontrado para os valores informados"
},
"500": {
"description": "Erro inesperado.\n\nErro ao tentar gerar o token de autorizacao.\n\nNao foi possível concluir a impressão do documento.\n\nDados invalidos para efetivacao de proposta para o documento:"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\n\nToken invalido ou expirado."
}
}
}
},
"/re/v1/seguro/certificado/parcelas": {
"get": {
"tags": [
"Seguro - Certificados"
],
"summary": "Consulte as parcelas por certificado.",
"description": "Realiza a consulta de parcelas(s) do certificado",
"operationId": "consultarParcelas",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "idCertificado",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versaoDocumento",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numeroBloco",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BilheteCertificadoParcelasResponseEntity"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s)."
},
"404": {
"description": "Parcela(s) nao encontrada(s) para o certificado informado.\nParcela(s) nao encontrada(s) para o status informado."
},
"500": {
"description": "Erro inesperado.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
}
},
"/re/v1/parceiro/seguro/parcelas": {
"post": {
"tags": [
"Seguro - Certificados"
],
"summary": "Consulte as parcelas da proposta.",
"description": "Realiza a consulta da(S) parcelas(s) da proposta informada.",
"operationId": "consultarParcelasProposta",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestConsultarParcelas"
},
"examples": {
"consultarParcelas": {
"summary": "consultarParcelas",
"description": "\n**- Tabela de Domínios de Referência**\n\n**situacao** em v1/seguro/tabelas/parcela - Dados da parcela\n
\n**formaPagamento** em v1/seguro/tabelas/parcela - Dados da parcela\n
\n
\n**- Atributos opcionais:**\n
\nidCertificado\n
\nnumeroInterno\n
\ndataInicio\n
\ndataFim\n"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseConsultarParcelas"
}
}
}
},
"400": {
"description": "Parametro(s) de entrada invalido(s).",
"content": {}
},
"500": {
"description": "Erro inesperado.\nOcorreu uma falha na requisicao.\nErro ao tentar gerar o token de autorizacao."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido.\nToken invalido ou expirado."
}
}
}
},
"/re/v1/seguro/parceiro/{idParceiro}/certificado/idCertificado={idCertificado}/produto/idTipoRisco={idTipoRisco}": {
"get": {
"tags": [
"Seguro - Certificados"
],
"summary": "Consulte os detalhes de uma proposta de seguro efetivado.",
"description": "Obtém os dados de um seguro efetivado a partir do parceiro, certificado e tipo de risco.",
"operationId": "consultarDadosSeguroEfetivado",
"parameters": [
{
"name": "idParceiro",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Identificador do parceiro."
},
{
"name": "idCertificado",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Identificador do certificado (utilizado nas camadas de serviço)."
},
{
"name": "idTipoRisco",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Identificador do tipo de risco."
},
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Ambiente de execução (header opcional)."
}
],
"responses": {
"200": {
"description": "Consulta realizada com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DadosSeguroResponse"
},
"example": {
"requestStatus": {
"code": "200",
"message": "Solicitação realizada com sucesso.",
"description": "N/A.",
"requestStatusId": "014db57a-d638-4cc6-a9da-f615676af564"
},
"certificado": {
"idCertificado": "5500041",
"versaoDocumento": "1",
"adicionalInfo": {
"qtdePets": "1",
"itens": [
{
"idPet": "1",
"nomePet": "cachorroLatidor",
"idCtpoRisco": "1",
"descricaoCtpoRisco": "CACHORRO"
}
]
}
}
}
}
}
},
"400": {
"description": "Parâmetros de entrada inválidos."
},
"404": {
"description": "Registro não encontrado para os parâmetros informados."
},
"500": {
"description": "Erro inesperado."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido.\n\nToken inválido ou expirado."
}
}
}
},
"/re/v1/seguro/analisar-dados-proposta/identificador-controle": {
"post": {
"tags": [
"Seguro - Proposta"
],
"summary": "Gerar ID Controle.",
"description": "Utilize para obter um idControle válido para realizar a análise dos dados da proposta e posterior efetivação.\n",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CertificadoRequest"
},
"example": {
"certificado": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "12345678",
"idBloco": "1",
"idCanal": "39"
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CertificadoResponse"
}
}
}
},
"400": {
"description": "Parâmetro(s) de entrada inválido(s):\n- Parceiro, bloco e canal não pode(m) ser nulo(s)/vazio(s) ou conter caracteres especiais.\n"
},
"500": {
"description": "Erros inesperados:\n- Erro inesperado.\n- Erro ao tentar gerar o token de autorização.\n- Dados inválidos para gerar o certificado do parceiro.\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Falhas de autenticação:\n- Token não informado ou inválido.\n- Token expirado.\n"
}
}
}
},
"/re/v1/pagamento/cartao/validar": {
"post": {
"tags": [
"Pagamento"
],
"summary": "Consulte a existência/validade de um cartão de crédito.",
"description": "Verifica a existência e a validade de um cartão de crédito para determinar se ele pode ser utilizado em uma transação",
"operationId": "postValidaCartaoUsingPost",
"parameters": [
{
"name": "env",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagamentoRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExemploSucesso"
}
}
}
},
"400": {
"description": "Parâmetro(s) de entrada inválido(s).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExemploFalhaParametro"
}
}
}
},
"500": {
"description": "Erro inesperado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExemploFalhaServico"
}
}
}
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado."
}
}
}
},
"/re/v1/pagamento/pix": {
"post": {
"tags": [
"Pagamento"
],
"summary": "Gera qrCode e evPIXCC para pagamento.",
"description": "Gera o qrCode e a evPIXCC para pagamento via PIX de um seguro residencial",
"operationId": "postGerarPagamentoPix",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"examples": {
"Cenário 1 - Consulta utilizando dgReferencia": {
"summary": "Cenário 1 – dgReferencia",
"value": {
"pagamento": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "12345678"
}
}
},
"propostas": [
{
"proposta": {
"dgReferencia": "9999999999999999999999999999999999999999999999999999"
}
}
]
}
]
}
},
"Cenário 2 - Consulta utilizando dados da proposta": {
"summary": "Cenário 2 - Dados da proposta",
"value": {
"pagamento": [
{
"participantes": {
"parceiro": {
"parceria": {
"idParceiro": "12345678"
}
}
},
"propostas": [
{
"proposta": {
"idEmpresa": "001",
"idSucursal": "002",
"idProposta": "003",
"idEndosso": "004",
"idRamoPrincipal": "005",
"identificadorUnico": "006",
"idParcela": "007",
"idSinistro": "008"
}
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/PixPagamentoRequest"
}
}
}
},
"responses": {
"200": {
"description": "Consulta efetuada com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PixPagamentoResponse"
}
}
}
},
"400": {
"description": "Parâmetro(s) de entrada inválido(s)."
},
"422": {
"description": "Erro de cast ou dados inconsistentes na requisição."
},
"500": {
"description": "Erro inesperado."
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido.\n\nToken inválido ou expirado."
}
}
}
},
"/re/v1/seguro/tabelas/status-parcela": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os status possíveis de parcelas do seguro",
"operationId": "getTabelaStatusParcela",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/status-parcela-cancelamento": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os status possíveis das parcelas para o cancelamento",
"operationId": "getTabelaStatusParcelaCancelamento",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/renda": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições das faixas de renda",
"operationId": "getTabelaRenda",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/profissao": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições das profissões",
"operationId": "getTabelaProfissao",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/motivo-cancelamento": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de motivos de cancelamento",
"operationId": "getTabelaMotivoCancelamento",
"parameters": [
{
"name": "codigoParceiro",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/imovel": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições dos tipos de imóveis e suas características",
"operationId": "getTabelaImovel",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/dados-pessoais": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de sexo e estado civil",
"operationId": "getTabelaDadosPessoais",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/dados-cobranca": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de cobrança",
"operationId": "getTabelaDadosCobranca",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/analise-comercial": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições das etapas da analise comercial",
"operationId": "getTabelaAnaliseComercialUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/contatos": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de contatos",
"operationId": "getTabelaContatosUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/documentos": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de documentos",
"operationId": "getTabelaDocumentosUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/objetos-risco": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de objetos de risco",
"operationId": "getTabelaObjetosRiscoUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/objeto-segurado": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de objetos segurados",
"operationId": "getTabelaObjetosSeguradosUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/mensagens": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições do agrupamento de mensagens",
"operationId": "getTabelaMensagensUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/dados-classificacao-risco-produtos": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de classificações de riscos",
"operationId": "getTabelaDadosClassificacaoRiscoProdutosUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/dados-socio": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e descrições de dados de um socio",
"operationId": "getTabelaDadosSociosUsingGet",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/dados-pet": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Obtém dados dos TIPOS de Pet a serem utilizados na contratação de seguro de Produtos Pet",
"operationId": "getTabelaDadosPetUsingGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapitalizacaoResponse"
},
"example": {
"requestStatus": {
"code": "200",
"message": "Consulta realizada com sucesso.",
"description": "N/A.",
"requestStatusId": "b5fc834a-b9e4-4800-a7e8-b5c17125dee5"
},
"dados-pet": [
{
"descricao": "Cachorro",
"tipo": "1"
},
{
"descricao": "Gato",
"tipo": "2"
}
]
}
}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re/v1/seguro/tabelas/classe-empresarial": {
"get": {
"tags": [
"Tabela de Domínios de Referência"
],
"description": "Consulte os códigos e valores das classes empresariais",
"operationId": "getTabelaClasseEmpresarial",
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapitalizacaoResponse"
},
"example": {
"requestStatus": {
"code": "200",
"message": "Consulta realizada com sucesso.",
"description": "N/A.",
"requestStatusId": "b5fc834a-b9e4-4800-a7e8-b5c17125dee5"
},
"classeEmpresarial": [
{
"descricao": "Empresarial Comércio",
"valor": "1"
},
{
"descricao": "Empresarial Indústria",
"valor": "2"
},
{
"descricao": "Empresarial Serviços",
"valor": "3"
},
{
"descricao": "Empresarial Hotéis",
"valor": "4"
},
{
"descricao": "Empresarial Outros (*)",
"valor": "99"
}
]
}
}
}
},
"500": {
"description": "Erro inesperado."
}
}
}
},
"/re-analise-comercial/v1/analise-comercial/health-check": {
"get": {
"tags": [
"Health Check"
],
"summary": "Apresenta informações da versao do build e o status dos servicos de análise comercial",
"description": "Realiza uma checagem de disponibilidade dos servicos de análise comercial e de consulta ao histórico de uma análise comercial (UP ou DOWN)",
"operationId": "getHealthCheck",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "UP",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckAnaliseComercial"
}
}
}
},
"500": {
"description": "DOWN"
},
"504": {
"description": "Tempo limite de conexão excedido"
},
"511": {
"description": "Token inválido ou expirado."
}
}
}
},
"/re/v1/produtos/health-check": {
"get": {
"tags": [
"Health Check"
],
"summary": "Apresenta informações da versão do build e o status dos serviços de Produtos.",
"description": "Realiza uma checagem de disponibilidade dos servicos usados na aplicação(UP ou DOWN).",
"operationId": "HealthCheckProdutos",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "UP",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckProduto"
}
}
}
},
"500": {
"description": "DOWN \n\nErro ao tentar gerar o token de autorização. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token não informado, favor incluir um token válido. \n\nToken inválido ou expirado. \n"
}
}
}
},
"/re/v1/seguro/health-check": {
"get": {
"tags": [
"Health Check"
],
"summary": "Apresenta informações da versão do build e o status dos serviços de Seguro.",
"description": "Realiza uma checagem de disponibilidade dos servicos usados na aplicação(UP ou DOWN).",
"operationId": "HealthCheckSeguro",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "UP",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckSeguro"
}
}
}
},
"500": {
"description": "DOWN \n\nErro ao tentar gerar o token de autorizacao. \n\n"
},
"504": {
"description": "Connection timeout."
},
"511": {
"description": "Token nao informado, favor incluir um token valido. \n\nToken invalido ou expirado. \n"
}
}
}
},
"/re/v1/proposta/health-check": {
"get": {
"tags": [
"Health Check"
],
"summary": "Apresenta informações da versão do build e o status dos serviços de Proposta",
"description": "Realiza uma checagem de disponibilidade dos servicos de proposta (UP ou DOWN)",
"operationId": "HealthCheckProposta",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "UP",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckProposta"
}
}
}
},
"500": {
"description": "DOWN \n\nErro ao tentar gerar o token de autorização na API Auth."
},
"504": {
"description": "Tempo limite de conexao excedido"
},
"511": {
"description": "Token nao informado, favor incluir um token valido \n\nToken invalido ou expirado"
}
}
}
},
"/v1/pagamento/health-check": {
"get": {
"tags": [
"Health Check"
],
"summary": "Apresenta informações da versão do build e o status dos serviços de Proposta",
"description": "Realiza uma checagem de disponibilidade dos servicos de proposta (UP ou DOWN)",
"operationId": "HealthCheckPagamento",
"parameters": [
{
"name": "env",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "UP",
"content": {
"application/json": {
"example": {
"info": {
"reParcerias": "Pagamento",
"version": "2306251000-0018",
"status": "UP",
"operations": [
{
"operacao": "RSAP-API-COBRANCA(incluirCobrancaEcommerceRequest)",
"status": "UP"
},
{
"operacao": "SI_MovimentoSap_Out(DTMovimentoSapReq)",
"status": "UP"
},
{
"operacao": "SAP-PI - PIX (SI_ConsultaSap_Out)",
"status": "UP"
},
{
"operacao": "RSAP-Cobranca/validarCartao",
"status": "UP"
}
]
}
}
}
}
},
"500": {
"description": "DOWN \n\nErro ao tentar gerar o token de autorização na API Auth."
},
"504": {
"description": "Tempo limite de conexao excedido"
},
"511": {
"description": "Token nao informado, favor incluir um token valido \n\nToken invalido ou expirado"
}
}
}
}
},
"components": {
"schemas": {
"DadosSeguroResponse": {
"type": "object",
"description": "Resposta contendo status da requisição e informações do certificado PET.",
"properties": {
"requestStatus": {
"allOf": [
{
"$ref": "#/components/schemas/RequestStatus"
}
],
"description": "Informações de controle da requisição."
},
"certificado": {
"allOf": [
{
"$ref": "#/components/schemas/Certificado"
}
],
"description": "Informações do certificado PET."
}
},
"required": [
"requestStatus",
"certificado"
]
},
"Certificado": {
"type": "object",
"description": "Informações do certificado do seguro PET.",
"properties": {
"idCertificado": {
"type": "string",
"description": "Identificador do certificado.",
"example": "123456"
},
"versaoDocumento": {
"type": "string",
"description": "Versão do documento.",
"example": "1"
},
"adicionalInfo": {
"allOf": [
{
"$ref": "#/components/schemas/AdicionalInfo"
}
],
"description": "Informações adicionais do certificado (pets)."
}
},
"required": [
"idCertificado"
]
},
"AdicionalInfo": {
"type": "object",
"description": "Informações adicionais do certificado, incluindo lista de pets.",
"properties": {
"qtdePets": {
"type": "string",
"description": "Quantidade de pets na apólice.",
"example": "3"
},
"itens": {
"type": "array",
"description": "Lista de pets vinculados ao certificado.",
"items": {
"$ref": "#/components/schemas/ItemPet"
}
}
},
"required": [
"qtdePets",
"itens"
]
},
"ItemPet": {
"type": "object",
"description": "Informações de um pet vinculado ao certificado.",
"properties": {
"idPet": {
"type": "string",
"description": "Identificador único do pet.",
"example": "1"
},
"nomePet": {
"type": "string",
"description": "Nome do pet.",
"example": "cachorroLatidor"
},
"idCtpoRisco": {
"type": "string",
"description": "Código do tipo de risco.",
"example": "1"
},
"descricaoCtpoRisco": {
"type": "string",
"description": "Descrição do risco do pet.",
"example": "CACHORRO"
}
},
"required": [
"idPet",
"nomePet",
"idCtpoRisco",
"descricaoCtpoRisco"
]
},
"DadosConsultarParcelas": {
"type": "object",
"description": "Classe com dados da Parcela.",
"properties": {
"numeroDocumento": {
"type": "string",
"description": "Número do documento.",
"example": 12345678900
},
"idCertificado": {
"type": "string",
"description": "Identificação do certificado.",
"example": 123456
},
"numeroInterno": {
"type": "string",
"description": "Número interno.",
"example": "0987"
},
"situacao": {
"type": "string",
"description": "Identificador da situação da parcela.",
"example": 2
},
"dataInicio": {
"type": "string",
"description": "Data de início das parcelas.",
"example": "14/08/2025"
},
"dataFim": {
"type": "string",
"description": "Data de término das parcelas.",
"example": "14/08/2025"
},
"pagina": {
"type": "string",
"description": "Página de consulta.",
"example": 20
}
}
},
"ParceiroConsultarParcelas": {
"type": "object",
"description": "Classe com dados do Parceiro.",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificação do parceiro",
"example": 15684242
}
}
},
"RequestConsultarParcelas": {
"type": "object",
"description": "Classe com dados da requisição da consulta de parcelas.",
"properties": {
"parceria": {
"$ref": "#/components/schemas/ParceiroConsultarParcelas",
"description": "Dados do parceiro."
},
"parametros": {
"$ref": "#/components/schemas/DadosConsultarParcelas",
"description": "Dados da Parcela."
}
}
},
"Paginacao": {
"type": "object",
"description": "Classe com dados da paginação.",
"properties": {
"totalPaginas": {
"type": "string",
"description": "Total de páginas.",
"example": 20
},
"totalParcelas": {
"type": "string",
"description": "Total de parcelas..",
"example": 60
},
"parcelasPagina": {
"type": "string",
"description": "Total de parcelas por páginas..",
"example": 12
}
}
},
"Parcela": {
"type": "object",
"description": "Classe com dados da Parcela.",
"properties": {
"codigoInterno": {
"type": "string",
"description": "Código interno.",
"example": 123456
},
"versao": {
"type": "string",
"description": "Versão.",
"example": 1
},
"dataVencimento": {
"type": "string",
"description": "Data de vencimento da parcela.",
"example": "14/08/2025"
},
"idCertificado": {
"type": "string",
"description": "Identificador do certificado.",
"example": "09876"
},
"idProduto": {
"type": "string",
"description": "Identificador do produto.",
"example": 123
},
"idFormaPagamento": {
"type": "string",
"description": "Identificador da forma de pagamento.",
"example": 5
},
"descricaoFormaPagamento": {
"type": "string",
"description": "Descrição da forma de pagamento.",
"example": "débito em conta"
},
"idSituacaoParcela": {
"type": "string",
"description": "Identificador da situação da parcela.",
"example": 3
},
"descricaoSituacaoParcela": {
"type": "string",
"description": "Descrição da situação da parcela.",
"example": "PAGA"
},
"dgReferencia": {
"type": "string",
"description": "DG Referencia.",
"example": "120564P0F00635787800000009290000054973990001F00689787800000000000"
},
"numeroParcela": {
"type": "string",
"description": "Número da parcela.",
"example": 100
},
"idSituacaoSeguro": {
"type": "string",
"description": "Identificador da situação do seguro."
},
"situacaoSeguro": {
"type": "string",
"description": "Situação do seguro.",
"example": "EMITIDO"
},
"quantidadeParcelas": {
"type": "string",
"description": "Quantidade de parcelas.",
"example": 5
},
"valorPremioLiquido": {
"type": "string",
"description": "Valor do prêmio líquido.",
"example": 1000
},
"adicionalFracionamento": {
"type": "string",
"description": "Adicional de fracionamento.",
"example": 20
},
"iof": {
"type": "string",
"description": "Imposto sobre Operações Financeiras.",
"example": 0
},
"premioTotal": {
"type": "string",
"description": "Prêmio total.",
"example": 1000
},
"dataEnvioCobranca": {
"type": "string",
"description": "Data de envio da cobrança.",
"example": "14/08/2025"
},
"dataControle": {
"type": "string",
"description": "Data de controle.",
"example": "14/08/2025"
},
"dataPagamentoRealizado": {
"type": "string",
"description": "Data de pagamento realizado.",
"example": "14/08/2025"
}
}
},
"ParcelaObject": {
"type": "object",
"description": "Classe com objeto Parcela.",
"properties": {
"Parcela": {
"$ref": "#/components/schemas/Parcela",
"description": "Dados da parcela."
}
}
},
"ResponseConsultarParcelas": {
"type": "object",
"description": "Classe com informações de resposta da consulta de parcelas.",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus",
"description": "Status da requisição."
},
"paginacao": {
"$ref": "#/components/schemas/Paginacao",
"description": "Informações de paginação"
},
"parceria": {
"$ref": "#/components/schemas/ParceiroConsultarParcelas",
"description": "Dados da parceria."
},
"parcelas": {
"type": "array",
"description": "Lista de objetos de Parcela.",
"items": {
"$ref": "#/components/schemas/ParcelaObject"
}
}
}
},
"Assistencia": {
"type": "object",
"properties": {
"idProduto": {
"type": "string",
"description": "Id de um produto",
"example": "182"
},
"idParceiro": {
"type": "string",
"description": "Id de um Parceiro",
"example": "14424268"
},
"listaKitAssitencia": {
"type": "array",
"description": "Lista de Kit Assistencia",
"items": {
"$ref": "#/components/schemas/KitAssistencia"
}
}
},
"description": "Entidade que reúne os dados de um Kit Assistencia com Planos Assistencia"
},
"AssistenciaResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"assistencia": {
"$ref": "#/components/schemas/Assistencia"
}
},
"description": "Retorno dos dados das assistencias"
},
"KitAssistencia": {
"type": "object",
"properties": {
"codigo": {
"type": "integer",
"description": "Codigo do Kit Assistencia",
"format": "int32",
"example": 1
},
"descricao": {
"type": "string",
"description": "Descrição do Kit Assistencia",
"example": "RESIDENCIAL PLUS"
},
"listaPlanoAssistencia": {
"type": "array",
"description": "Lista de Plano Assistencia",
"items": {
"$ref": "#/components/schemas/PlanoAssistencia"
}
}
},
"description": "Entidade que reune as informações dos kits de assistência"
},
"PlanoAssistencia": {
"type": "object",
"properties": {
"codigo": {
"type": "integer",
"description": "Codigo Plano Assistencia",
"format": "int32",
"example": 2
},
"descricao": {
"type": "string",
"description": "Descriçao Plano Assistencia",
"example": "Descricao do plano de assistência"
}
},
"description": "Entidade que reune as informações dos planos de assitência"
},
"FormaPagamentoResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"formasPagamento": {
"$ref": "#/components/schemas/FormasPagamentoResponseList"
}
},
"description": "Retorno das formas de pagamento"
},
"FormasPagamentoResponse": {
"type": "object",
"properties": {
"codigoFormaPagamento": {
"type": "string",
"description": "Código da forma de pagamento (Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "5"
},
"descricaoFormaPagamento": {
"type": "string",
"description": "Descrição da forma de pagamento",
"example": "Cartão de crédito"
},
"codigoCartao": {
"type": "string",
"description": "Código do cartão",
"example": "40003"
},
"descricaoCartao": {
"type": "string",
"description": "Nome da bandeira do cartão",
"example": "VISA"
}
},
"description": "Lista das formas de pagamento"
},
"FormasPagamentoResponseList": {
"type": "object",
"properties": {
"listaFormaPagamento": {
"type": "array",
"description": "Lista das formas de pagamento",
"items": {
"$ref": "#/components/schemas/FormasPagamentoResponse"
}
}
},
"description": "Entidade que possui os atributos da estrutura de formas de pagamento por produto"
},
"CoberturaResponseEntity": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"coberturas": {
"type": "array",
"description": "Lista de coberturas",
"items": {
"$ref": "#/components/schemas/PlanoCobertura"
}
}
},
"description": "Retorno da consulta a uma cobertura"
},
"PlanoCobertura": {
"type": "object",
"properties": {
"codigoCobertura": {
"type": "integer",
"description": "Codigo da cobertura",
"format": "int64",
"example": 123456
},
"descricaoCobertura": {
"type": "string",
"description": "Descrição da cobertura",
"example": "Descrição cobertura ABC"
},
"detalhamentoCobertura": {
"type": "string",
"description": "Detalhamento da cobertura",
"example": "Detalhamento cobertura ABC"
},
"valorLMI": {
"type": "string",
"description": "Valor do LMI",
"example": "1000.15"
},
"codigoRamo": {
"type": "integer",
"description": "Código do ramo",
"format": "int64",
"example": 123456
},
"codigoSubRamo": {
"type": "integer",
"description": "Código do sub-ramo",
"format": "int64",
"example": 123456
},
"indicadorCoberturaOpcional": {
"type": "string",
"description": "Indicador da cobertura opcional",
"example": "N"
},
"indicadorCoberturaBasica": {
"type": "string",
"description": "Indicador da cobertura básica",
"example": "S"
},
"percentualFranquia": {
"type": "string",
"description": "Percentual da franquia",
"example": "1.25"
},
"valorFranquia": {
"type": "string",
"description": "Valor da franquia",
"example": "2000.25"
},
"valorMinFranquia": {
"type": "string",
"description": "Valor mínimo da franquia",
"example": "100.15"
},
"valorMaxFranquia": {
"type": "string",
"description": "Valor máximo da franquia",
"example": "1000.15"
},
"description": {
"type": "string",
"description": "descricao",
"example": "Cobertura(s) referentes ao plano informado"
}
},
"description": "Entidade que possui os atributos da estrutura de coberturas comercializadas pelos parceiros"
},
"PlanoResponse": {
"type": "object",
"properties": {
"idPlano": {
"type": "integer",
"description": "Id do plano",
"format": "int64",
"example": 123456
},
"valorPremioTotal": {
"type": "string",
"description": "Valor do prêmio total",
"example": "1000.15"
}
},
"description": "Classe que representa um plano"
},
"PlanoResponseEntity": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"planos": {
"type": "array",
"description": "Lista de planos",
"items": {
"$ref": "#/components/schemas/PlanoResponse"
}
}
},
"description": "Retorno da consulta a um plano"
},
"ProdutoResponse": {
"type": "object",
"properties": {
"idProduto": {
"type": "integer",
"description": "Id de um produto",
"format": "int64",
"example": 181
},
"idSucursal": {
"type": "integer",
"description": "Id de uma sucursal",
"format": "int64",
"example": 0
},
"descricaoProduto": {
"type": "string",
"description": "Descrição de um produto",
"example": "Produto ABC"
}
},
"description": "DTO que representa um produto"
},
"OpcoesParcelamentoResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"parceiro": {
"$ref": "#/components/schemas/ParceiroParcelamentoResponse"
},
"produto": {
"$ref": "#/components/schemas/ProdutoParcelamentoResponse"
},
"parcelamento": {
"type": "array",
"description": "Lista de opções de parcelamento disponíveis",
"items": {
"$ref": "#/components/schemas/OpcaoParcelamentoResponse"
}
}
},
"description": "Retorno da consulta às opções de parcelamento de um produto"
},
"OpcaoParcelamentoResponse": {
"type": "object",
"properties": {
"opcao": {
"type": "string",
"description": "Identificador da opção",
"example": "1"
},
"quantidadeParcelas": {
"type": "string",
"description": "Quantidade de parcelas",
"example": "3"
},
"valorPrimeiraParcela": {
"type": "string",
"description": "Valor da primeira parcela",
"example": 10000
},
"valorDemaisParcelas": {
"type": "string",
"description": "Valor das demais parcelas",
"example": 9000
},
"valorTotal": {
"type": "string",
"description": "Valor total do parcelamento",
"example": 27000
},
"percentualJurosTotal": {
"type": "string",
"description": "Percentual total de juros aplicado",
"example": 500
}
},
"description": "Detalhes de uma opção de parcelamento"
},
"ParceiroParcelamentoResponse": {
"type": "object",
"properties": {
"parceria": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "12345678"
}
}
}
},
"description": "Informações do parceiro usadas na resposta de parcelamento"
},
"ProdutoParcelamentoResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "256"
},
"idPlano": {
"type": "string",
"example": "1"
}
},
"description": "Informações do produto usadas na resposta de parcelamento"
},
"ProdutoResponseEntity": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"produtos": {
"type": "array",
"description": "Lista de produtos",
"items": {
"$ref": "#/components/schemas/ProdutoResponse"
}
}
},
"description": "Retorno da consulta a um produto"
},
"CapitalizacaoEntity": {
"type": "object",
"properties": {
"idProduto": {
"type": "string",
"description": "Identificador do produto",
"example": "181"
},
"planoCapitalizacao": {
"$ref": "#/components/schemas/PlanoCapitalizacao"
}
},
"description": "Entidade que reune as informações de capitalização"
},
"ParceiroResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"parceiro": {
"$ref": "#/components/schemas/ParceiroResponseEntity"
}
},
"description": "Retorno dos dados do parceiro - cotação"
},
"ParceiroResponseEntity": {
"type": "object",
"properties": {
"idParceiro": {
"type": "integer",
"description": "Id do parceiro",
"format": "int64",
"example": 15698584
},
"nomeParceiro": {
"type": "string",
"description": "Nome do parceiro",
"example": "Lojas Tabajara"
},
"nomeParceria": {
"type": "string",
"description": "Nome da parceria",
"example": "Parceria ABC"
},
"produtos": {
"type": "array",
"description": "Lista de produtos",
"items": {
"$ref": "#/components/schemas/Produto"
}
}
},
"description": "Entidade que possui os atributos da estrutura de produtos comercializados pelos parceiros"
},
"PlanoCapitalizacao": {
"type": "object",
"properties": {
"tipoTituloCapitalizacao": {
"type": "integer",
"description": "Tipo titulo do Plano Capitalizacao",
"format": "int32",
"example": 2
},
"valorPremio": {
"type": "string",
"description": "Valor do prêmio do Plano Capitalizacao",
"example": "R$ 300.000,00"
},
"descricaoPremio": {
"type": "string",
"description": "Descrição do prêmio do Plano Capitalizacao",
"example": "TREZENTOS MIL REAIS"
}
},
"description": "Entidade que reune as informações do plano de capitalização"
},
"Planos": {
"type": "object",
"properties": {
"idPlano": {
"type": "integer",
"description": "Id do plano",
"format": "int64",
"example": 15
},
"valorPremioTotal": {
"type": "string",
"description": "Valor do prêmio total",
"example": "1000.15"
},
"description": {
"type": "string",
"description": "descricao",
"example": "Planos referentes ao produto informado"
},
"planosCobertura": {
"type": "array",
"description": "Lista de planos de cobertura",
"items": {
"$ref": "#/components/schemas/PlanoCobertura"
}
}
},
"description": "Entidade que possui os atributos da estrutura de planos comercializados pelos parceiros"
},
"Produto": {
"type": "object",
"properties": {
"idProduto": {
"type": "integer",
"description": "Id de um produto",
"format": "int64",
"example": 15
},
"idSucursal": {
"type": "integer",
"description": "Id de uma sucursal",
"format": "int64",
"example": 0
},
"descricaoProduto": {
"type": "string",
"description": "Descrição de um produto",
"example": "Produto ABC"
},
"planos": {
"type": "array",
"description": "Lista de planos",
"items": {
"$ref": "#/components/schemas/Planos"
}
},
"assistencia": {
"$ref": "#/components/schemas/Assistencia"
},
"capitalizacao": {
"$ref": "#/components/schemas/CapitalizacaoEntity"
},
"formaPagamento": {
"$ref": "#/components/schemas/FormasPagamentoResponseList"
}
},
"description": "Entidade que possui os atributos da estrutura de planos comercializados pelos parceiros"
},
"CapitalizacaoResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"capitalizacao": {
"$ref": "#/components/schemas/CapitalizacaoEntity"
}
},
"description": "Retorno dos dados do produto"
},
"CancelarPropostaEntity": {
"required": [
"idCertificado",
"idParceiro",
"motivoCancelamento",
"versaoDocumento"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "identificador do parceiro vinculado a proposta",
"example": "15689595"
},
"idCertificado": {
"type": "string",
"description": "Identificador da proposta a ser cancelada",
"example": "3206676"
},
"versaoDocumento": {
"type": "string",
"description": "Versao do documento",
"example": "1"
},
"motivoCancelamento": {
"type": "string",
"description": "Motivo do cancelamento(Na URL /v1/seguro/tabelas/motivo-cancelamento)",
"example": "1"
},
"usuario": {
"type": "string",
"description": "Usuario do servico",
"example": "API_RE"
}
},
"description": "Entidade que reune os dados de entrada (request body) para realizar o cancelamento de uma proposta"
},
"CancelarProposta": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
}
},
"description": "Entidade que reune os dados de um cancelamento de proposta"
},
"EfetivarSeguro": {
"required": [
"RequestStatus",
"chaveIdentificacao",
"codigoRamo",
"dataControle",
"dataEmissao",
"dataVencimento",
"finalVigencia",
"idCertificado",
"inicioVigencia",
"numeroProposta",
"idControle"
],
"type": "object",
"properties": {
"RequestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"codigoRamo": {
"type": "string",
"description": "Código do ramo",
"example": "928"
},
"numeroProposta": {
"type": "string",
"description": "Número da proposta",
"example": "621972"
},
"inicioVigencia": {
"type": "string",
"description": "Inicio da vigência",
"example": "01/01/2001"
},
"finalVigencia": {
"type": "string",
"description": "Final da vigência",
"example": "01/01/2006"
},
"dataEmissao": {
"type": "string",
"description": "Data de emissão",
"example": "01/01/2001"
},
"dataVencimento": {
"type": "string",
"description": "Data de vencimento",
"example": "31/12/2005"
},
"dataControle": {
"type": "string",
"description": "Data de controle",
"example": "05/10/2023"
},
"chaveIdentificacao": {
"type": "string",
"description": "Chave de identificação",
"example": "1003848524171696"
},
"idControle": {
"type": "string",
"description": "Identificador de Controle",
"example": "5136"
},
"idCertificado": {
"type": "string",
"description": "Identicação do certificado",
"example": "3686647"
}
},
"description": "Informações da efetivação do seguro"
},
"RequestStatus": {
"type": "object",
"properties": {
"codigoErro": {
"type": "string",
"description": "Código do erro",
"example": "200"
},
"message": {
"type": "string",
"description": "Mensagem do erro",
"example": "Requisição realizada com sucesso"
},
"description": {
"type": "string",
"description": "Descrição do erro",
"example": "N/A"
},
"requestStatusId": {
"type": "string",
"description": "Identificador da requisição(Gerado pela aplicação)",
"example": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
},
"description": "Informações de controle do resultado da requisição"
},
"CancelarDadosPagamentoContaBancaria": {
"required": [
"codigoAgencia",
"codigoBanco",
"digitoAgencia",
"digitoContaBancaria",
"formaPagamento",
"numeroContaBancaria",
"tipoContaBancaria"
],
"type": "object",
"properties": {
"codigoBanco": {
"type": "string",
"description": "Código do banco",
"example": "237"
},
"codigoAgencia": {
"type": "string",
"description": "Código da agência",
"example": "0"
},
"digitoAgencia": {
"type": "string",
"description": "Dígito da agência",
"example": "0"
},
"numeroContaBancaria": {
"type": "string",
"description": "Número da conta bancária",
"example": "12345"
},
"digitoContaBancaria": {
"type": "string",
"description": "Dígito da conta bancária",
"example": "0"
},
"tipoContaBancaria": {
"type": "string",
"description": "Tipo de conta bancária (Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "1"
},
"formaPagamento": {
"type": "string",
"description": " (Forma de pagamento (restituição) Na URL: v1/seguro/tabelas/dados-cobranca.)",
"example": "2"
}
},
"description": "Informações para o pagamento (restituição) no cancelamento do seguro"
},
"CancelarDadosPagamentoContaBancariaEntity": {
"required": [
"dadosPagamento"
],
"type": "object",
"properties": {
"dadosPagamento": {
"$ref": "#/components/schemas/CancelarDadosPagamentoContaBancaria"
}
},
"description": "Informações cadastrais de pagamento (restituição) para o cancelamento do seguro"
},
"CancelarDadosPagamentoResponse": {
"required": [
"idCancelamentoDadosPagamento"
],
"type": "object",
"properties": {
"idCancelamentoDadosPagamento": {
"type": "string",
"description": "Identificador do registro dos dados de pagamento para o cancelamento de um seguro",
"example": "dados-pagamento:c17ea59c-d86b-46b9-b898-56834abaa178"
}
},
"description": "Informação de gravação dos dados de pagamento (restituição) para o cancelamento de um seguro"
},
"CancelarDadosDocumento": {
"required": [
"cpfCnpj",
"tipoPessoa"
],
"type": "object",
"properties": {
"cpfCnpj": {
"type": "string",
"description": "CPF/CNPJ",
"example": "12345678900"
},
"tipoPessoa": {
"type": "string",
"description": "Tipo de pessoa (1 – Física, 2 - Jurídica)",
"example": "1"
}
},
"description": "Informações do documento para o cancelamento do seguro"
},
"CancelarDadosDocumentoEntity": {
"required": [
"dadosDocumento"
],
"type": "object",
"properties": {
"dadosDocumento": {
"$ref": "#/components/schemas/CancelarDadosDocumento"
}
},
"description": "Informações cadastrais (documentais) para o cancelamento dao seguro"
},
"CancelarDadosDocumentoResponse": {
"required": [
"idCancelamentoDadosDocumento"
],
"type": "object",
"properties": {
"idCancelamentoDadosDocumento": {
"type": "string",
"description": "Identificador do registro da lista de documentos para o cancelamento de um seguro",
"example": "dados-documento:c17ea59c-d86b-46b9-b898-56834abaa178"
}
},
"description": "Informação de gravação da lista de documentos para o cancelamento de um seguro"
},
"CancelarAllDadosSeguro": {
"required": [
"dadosSeguro",
"idCancelamentoDadosDocumento",
"idCancelamentoDadosPagamento"
],
"type": "object",
"properties": {
"dadosSeguro": {
"$ref": "#/components/schemas/CancelarDadosSeguro"
},
"idCancelamentoDadosDocumento": {
"type": "string",
"description": "Identificador da lista de documentos cadastrados para o cancelamento do seguro",
"example": "c17ea59c-d86b-46b9-b898-56834abaa178"
},
"idCancelamentoDadosPagamento": {
"type": "string",
"description": "Identificador dos dados de pagamento para o cancelamento do seguro",
"example": "c17ea59c-d86b-46b9-b898-56834abaa178"
}
},
"description": "Informações reunidas para o cancelamento do seguro"
},
"CancelarDadosSeguro": {
"required": [
"idCertificado",
"idParceiro",
"motivoCancelamento",
"versaoDocumento"
],
"type": "object",
"properties": {
"idCertificado": {
"type": "string",
"description": "Identificador do certificado",
"example": "2698949"
},
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro comercial",
"example": "85684242"
},
"versaoDocumento": {
"type": "string",
"description": "Versão do documento",
"example": "1"
},
"motivoCancelamento": {
"type": "string",
"description": "Motivo de cancelamento (Na URL: /v1/seguro/tabelas/motivo-cancelamento)",
"example": "1"
}
},
"description": "Informações para o cancelamento do seguro"
},
"CancelarDadosSeguroEntity": {
"required": [
"seguro"
],
"type": "object",
"properties": {
"seguro": {
"$ref": "#/components/schemas/CancelarAllDadosSeguro"
}
},
"description": "Informações cadastrais (reunidas) para o cancelamento do seguro"
},
"CancelarSeguro": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
}
},
"description": "Informações da efetivação do cancelamento"
},
"ContatoEntity": {
"required": [
"dddCelular",
"dddTelefone",
"email",
"numeroCelular",
"numeroTelefone"
],
"type": "object",
"properties": {
"dddTelefone": {
"type": "string",
"description": "DDD do telefone fixo do segurado",
"example": "11"
},
"numeroTelefone": {
"type": "string",
"description": "Número do telefone fixo do segurado",
"example": "999990000"
},
"dddCelular": {
"type": "string",
"description": "DDD do telefone móvel do segurado",
"example": "11"
},
"numeroCelular": {
"type": "string",
"description": "Número do telefone móvel do segurado",
"example": "99990000"
},
"email": {
"type": "string",
"description": "Email do segurado",
"example": "email@email.com"
}
},
"description": "Informações de contato do segurado"
},
"DadosCadastraisEntity": {
"required": [
"parceiro",
"segurado"
],
"type": "object",
"properties": {
"parceiro": {
"$ref": "#/components/schemas/ParceiroEntity"
},
"segurado": {
"$ref": "#/components/schemas/SeguradoEntity"
}
},
"description": "Informações cadastrais"
},
"EndossoEntity": {
"required": [
"seguro"
],
"type": "object",
"properties": {
"seguro": {
"$ref": "#/components/schemas/EndossoSeguroEntity"
}
},
"description": "Informações cadastrais"
},
"DadosPessoaisEntity": {
"required": [
"dataNascimento",
"estadoCivil",
"nome",
"sexo"
],
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome do segurado",
"example": "Marcos Prime"
},
"dataNascimento": {
"type": "string",
"description": "Data de nascimento do segurado",
"example": "25/02/2011"
},
"sexo": {
"type": "string",
"description": "Sexo do segurado(Na URL /v1/seguro/tabelas/dados-pessoais)",
"example": "M"
},
"estadoCivil": {
"type": "string",
"description": "Estado Civil do segurado(Na URL /v1/seguro/tabelas/dados-pessoais)",
"example": "3"
}
},
"description": "Informações pessoais do segurado"
},
"DocumentoEntity": {
"required": [
"dataExpedicaoDocumento",
"numeroDocumento",
"orgaoExpedidorDocumento",
"tipoDocumento"
],
"type": "object",
"properties": {
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento do segurado",
"example": "ID"
},
"numeroDocumento": {
"type": "string",
"description": "Número do documento do segurado",
"example": "118552505"
},
"dataExpedicaoDocumento": {
"type": "string",
"description": "Data de expedição do documento do segurado",
"example": "30/02/1989"
},
"orgaoExpedidorDocumento": {
"type": "string",
"description": "Orgão expedidor do documento do segurado",
"example": "DETRAN"
}
},
"description": "Informações dos documentos do segurado"
},
"EnderecoEntity": {
"required": [
"bairro",
"cep",
"cidade",
"logradouro",
"numero",
"uf"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"description": "Logradouro do segurado",
"example": "Rua das Pedras"
},
"numero": {
"type": "string",
"description": "Número residêncial do segurado",
"example": "00"
},
"complemento": {
"type": "string",
"description": "Complemento residêncial do segurado",
"example": "Casa"
},
"bairro": {
"type": "string",
"description": "Bairro do segurado",
"example": "Centro"
},
"cidade": {
"type": "string",
"description": "Cidade do segurado",
"example": "São Paulo"
},
"uf": {
"type": "string",
"description": "UF do segurado",
"example": "SP"
},
"cep": {
"type": "string",
"description": "CEP do segurado",
"example": "00.000-000"
}
},
"description": "Informações de endereço do segurado"
},
"EnderecoRiscoEntity": {
"required": [
"bairro",
"cep",
"cidade",
"logradouro",
"numero",
"tipoResidencia",
"uf"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"description": "Logradouro do segurado",
"example": "Rua das Pedras"
},
"numero": {
"type": "string",
"description": "Número residêncial do segurado",
"example": "00"
},
"complemento": {
"type": "string",
"description": "Complemento residêncial do segurado",
"example": "Casa"
},
"bairro": {
"type": "string",
"description": "Bairro do segurado",
"example": "Centro"
},
"cidade": {
"type": "string",
"description": "Cidade do segurado",
"example": "São Paulo"
},
"uf": {
"type": "string",
"description": "UF do segurado",
"example": "SP"
},
"tipoResidencia": {
"type": "string",
"description": "Tipo de residência do objeto segurado(C - Casa, A - Apartamento, R - Residência) ",
"example": "C"
},
"cep": {
"type": "string",
"description": "CEP do segurado",
"example": "00.000-000"
}
},
"description": "Informaçõesdo endereço de risco do segurado"
},
"ParceiroEntity": {
"required": [
"idCertificado",
"idParceiro",
"versaoDocumento"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro",
"example": "85684242"
},
"idCertificado": {
"type": "string",
"description": "Identificador do certificado",
"example": "24360"
},
"versaoDocumento": {
"type": "string",
"description": "Versão do documento",
"example": "1"
},
"usuario": {
"type": "string",
"description": "Usuário do endosso de alteração",
"example": "API_RE"
}
},
"description": "Informações cadastrais do parceiro"
},
"ProfissaoEntity": {
"required": [
"codigoProfissao",
"codigoRenda"
],
"type": "object",
"properties": {
"codigoProfissao": {
"type": "string",
"description": "Código da profissão(tabela) do segurado",
"example": "131"
},
"codigoRenda": {
"type": "string",
"description": "Código do valor da renda(tabela) do segurado",
"example": "10000.01"
}
},
"description": "Informações da profissão do segurado"
},
"SeguradoEntity": {
"required": [
"contato",
"dadosPessoais",
"documento",
"endereco",
"enderecoRisco",
"profissao"
],
"type": "object",
"properties": {
"dadosPessoais": {
"$ref": "#/components/schemas/DadosPessoaisEntity"
},
"documento": {
"$ref": "#/components/schemas/DocumentoEntity"
},
"contato": {
"$ref": "#/components/schemas/ContatoEntity"
},
"endereco": {
"$ref": "#/components/schemas/EnderecoEntity"
},
"enderecoRisco": {
"$ref": "#/components/schemas/EnderecoRiscoEntity"
},
"profissao": {
"$ref": "#/components/schemas/ProfissaoEntity"
}
},
"description": "Informações cadastrais do segurado"
},
"AlteracaoCadastral": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
}
},
"description": "Informações de alteração cadastral"
},
"EndossoSeguroEntity": {
"required": [
"participantes",
"objetoSegurados",
"objetosRisco"
],
"type": "object",
"properties": {
"participantes": {
"$ref": "#/components/schemas/EndossoParticipantesEntity"
},
"objetoSegurados": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndossoObjetoSegurado"
}
},
"objetosRisco": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndossoEnderecosRiscoEntity"
}
}
},
"description": "Informações seguro"
},
"EndossoParticipantesEntity": {
"required": [
"parceiro",
"proponente"
],
"type": "object",
"properties": {
"parceiro": {
"$ref": "#/components/schemas/EndossoParceriaEntity"
},
"proponente": {
"$ref": "#/components/schemas/EndossoProponenteEntity"
}
},
"description": "Informações participantes"
},
"EndossoParceriaEntity": {
"required": [
"idParceiro",
"versaoDocumento"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "15684242"
},
"versaoDocumento": {
"type": "string",
"example": "1"
},
"usuario": {
"type": "string",
"example": "API-RE"
}
},
"description": "Informações cadastrais da parceria"
},
"EndossoProponenteEntity": {
"required": [
"dadosCadastrais",
"documentos",
"enderecos",
"contatos"
],
"type": "object",
"properties": {
"dadosCadastrais": {
"$ref": "#/components/schemas/EndossoDadosCadastraisEntity"
},
"documentos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndossoDocumentoEntity"
}
},
"enderecos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndossoEnderecoEntity"
}
},
"contatos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndossoContatoEntity"
}
}
},
"description": "Informações proponente"
},
"EndossoDadosCadastraisEntity": {
"type": "object",
"properties": {
"pessoaFisica": {
"$ref": "#/components/schemas/EndossoPessoaFisicaEntity"
},
"pessoaJuridica": {
"$ref": "#/components/schemas/EndossoPessoaJuridicaEntity"
}
},
"description": "Informações cadastrais"
},
"EndossoPessoaFisicaEntity": {
"required": [
"dataNascimento",
"estadoCivil",
"nome",
"sexo",
"tipoPessoa",
"profissao"
],
"type": "object",
"properties": {
"dataNascimento": {
"type": "string",
"example": "01/01/1950"
},
"estadoCivil": {
"type": "string",
"example": "7"
},
"nome": {
"type": "string",
"example": "João da Silva"
},
"sexo": {
"type": "string",
"example": "M"
},
"tipoPessoa": {
"type": "string",
"example": "1"
},
"profissao": {
"$ref": "#/components/schemas/EndossoProfissaoEntity"
}
},
"description": "Informações de pessoa fisica do proponente do seguro"
},
"EndossoProfissaoEntity": {
"required": [
"codigoProfissao",
"descricaoProfissao"
],
"type": "object",
"properties": {
"atividadePrincipal": {
"type": "string",
"example": "Supervisor de estagiários"
},
"codigoProfissao": {
"type": "string",
"example": "01"
},
"codigoRenda": {
"type": "string",
"example": "3000.00"
},
"descricaoProfissao": {
"type": "string",
"example": "descricaoProfissao"
}
},
"description": "Informações de profissao do proponente do seguro"
},
"EndossoPessoaJuridicaEntity": {
"required": [
"cnae",
"classe",
"cnpj"
],
"type": "object",
"properties": {
"razaoSocial": {
"type": "string",
"example": "Sensedia SA"
},
"cnae": {
"type": "string",
"example": "1234508"
},
"classe": {
"type": "string",
"example": "A"
},
"cnpj": {
"type": "string",
"example": "82345678000190"
}
},
"description": "Informações de pessoa juridica do proponente do seguro"
},
"EndossoDocumentoEntity": {
"type": "object",
"properties": {
"cpfCnpj": {
"type": "string",
"example": "82345678900"
},
"tipoDocumento": {
"type": "string",
"example": "RG"
},
"numeroDocumento": {
"type": "string",
"example": "82345678900"
},
"dataExpedicaoDocumento": {
"type": "string",
"example": "01/01/1970"
},
"orgaoExpedidorDocumento": {
"type": "string",
"example": "IFP"
}
},
"description": "Informações dos documentos"
},
"EndossoEnderecoEntity": {
"required": [
"logradouro",
"numero",
"uf",
"bairro",
"cep",
"cidade",
"tipoLogradouro"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"example": "Rua das Aroeiras"
},
"complemento": {
"type": "string",
"example": "AP105"
},
"numero": {
"type": "string",
"example": "1000"
},
"uf": {
"type": "string",
"example": "RJ"
},
"bairro": {
"type": "string",
"example": "Tijuca"
},
"cep": {
"type": "string",
"example": "846660000"
},
"cidade": {
"type": "string",
"example": "Rio de Janeiro"
},
"tipoLogradouro": {
"type": "string",
"example": "Rua"
}
},
"description": "Informações de endereço do proponente do seguro"
},
"EndossoContatoEntity": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"example": "telefoneFixo, celular ou email"
},
"valor": {
"type": "string",
"example": "21-991235566, 21-991235566 ou teste@gmail.com"
}
},
"description": "Informações contato"
},
"EndossoObjetoSegurado": {
"type": "object",
"properties": {
"idCertificado": {
"type": "string",
"example": "3206676"
}
},
"description": "Informações cadastrais do objeto segurado"
},
"EndossoEnderecosRiscoEntity": {
"required": [
"EndossoEnderecoRiscoEntity"
],
"type": "object",
"properties": {
"risco": {
"$ref": "#/components/schemas/EndossoEnderecoRiscoEntity"
}
},
"description": "Informações de endereço do proponente do seguro"
},
"EndossoEnderecoRiscoEntity": {
"required": [
"logradouro",
"numero",
"uf",
"bairro",
"cep",
"cidade",
"tipoLogradouro",
"tipoResidencia"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"example": "Rua das Aroeiras"
},
"complemento": {
"type": "string",
"example": "AP105"
},
"numero": {
"type": "string",
"example": "1000"
},
"uf": {
"type": "string",
"example": "RJ"
},
"bairro": {
"type": "string",
"example": "Tijuca"
},
"cep": {
"type": "string",
"example": "846660000"
},
"cidade": {
"type": "string",
"example": "Rio de Janeiro"
},
"tipoLogradouro": {
"type": "string",
"example": "RUA"
},
"tipoResidencia": {
"type": "string",
"example": "C"
}
}
},
"Contato": {
"type": "object",
"properties": {
"dddTelefone": {
"type": "string",
"description": "ODD do telefone fixo do segurado",
"example": "21"
},
"numeroTelefone": {
"type": "string",
"description": "Número do telefone fixo do segurado",
"example": "999998888"
},
"dddCelular": {
"type": "string",
"description": "DDD do telefone móvel do segurado",
"example": "21"
},
"numeroMovel": {
"type": "string",
"description": "Número do telefone móvel do segurado",
"example": "999992222"
},
"email": {
"type": "string",
"description": "Email do segurado",
"example": "email@email.com.br"
}
},
"description": "Informações de contato do segurado"
},
"DadosBancarios": {
"type": "object",
"properties": {
"codigoBanco": {
"type": "string",
"description": "Código do banco",
"example": "237"
},
"codigoAgencia": {
"type": "string",
"description": "Código da agência do segurado",
"example": "3599"
},
"dvAgencia": {
"type": "string",
"description": "DV da agência do segurado",
"example": "8"
},
"tipoConta": {
"type": "string",
"description": "Tipo de conta bancária do segurado",
"example": "1"
},
"numeroContaBancaria": {
"type": "string",
"description": "Número da conta bancária do segurado",
"example": "14566"
},
"digitoConta": {
"type": "string",
"description": "DV da conta bancária do segurado",
"example": "9"
},
"tipoCobranca": {
"type": "string",
"description": "Tipo de cobrança(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "2"
},
"formaPagamento": {
"type": "string",
"description": "Forma de pagamento(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "5"
},
"bandeiraCartaoCredito": {
"type": "string",
"description": "Bandeira do cartão de crédito do segurado(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "3"
},
"numeroCartaoCredito": {
"type": "string",
"description": "Número do cartão de crédito do segurado",
"example": "1111222233334444"
},
"validadeCartaoCredito": {
"type": "string",
"description": "Validade do cartão de crédito do segurado",
"example": "1026"
},
"codigoSegurancaCartaoCredito": {
"type": "string",
"description": "Código de segurança do cartão de crédito do segurado",
"example": "000"
},
"dataPrimeiroDebitoConta ": {
"type": "string",
"description": "Data do primeiro débito",
"example": "30/12/2023"
}
},
"description": "Informações bancárias do segurado"
},
"DadosCadastrais": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"parceiro": {
"$ref": "#/components/schemas/Parceiro"
},
"segurado": {
"$ref": "#/components/schemas/Segurado"
}
},
"description": "Informações cadastrais"
},
"DadosPessoais": {
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Nome do segurado",
"example": "Marcos Prime"
},
"dataNascimento": {
"type": "string",
"description": "Data de nascimento do segurado",
"example": "25/02/2011"
},
"sexo": {
"type": "string",
"description": "Sexo do seguradoNa URL /v1/seguro/tabelas/dados-pessoais",
"example": "M"
},
"estadoCivil": {
"type": "string",
"description": "Estado Civil do seguradoNa URL /v1/seguro/tabelas/dados-pessoais",
"example": "3"
},
"tipoPessoa": {
"type": "string",
"description": "Tipo de pessoa do seguradoNa URL /v1/seguro/tabelas/dados-pessoais",
"example": "7"
}
},
"description": "Informações pessoais do segurado"
},
"Documento": {
"type": "object",
"properties": {
"cpfCnpj": {
"type": "string",
"description": "CPF OU CNPJ do segurado",
"example": "12345678900"
},
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento do segurado",
"example": "ID"
},
"numeroDocumento": {
"type": "string",
"description": "Número do documento do segurado",
"example": "118552505"
},
"dataExpedicaoDocumento": {
"type": "string",
"description": "Data de expedição do documento do segurado",
"example": "30/02/1989"
},
"orgaoExpedidorDocumento": {
"type": "string",
"description": "Orgão expedidor do documento do segurado",
"example": "DETRAN"
}
},
"description": "Informações dos documentos do segurado"
},
"Endereco": {
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"description": "Logradouro do segurado",
"example": "Rua das Pedras"
},
"numero": {
"type": "string",
"description": "Número residêncial do segurado",
"example": "00"
},
"complemento": {
"type": "string",
"description": "Complemento residêncial do segurado",
"example": "Casa"
},
"bairro": {
"type": "string",
"description": "Bairro do segurado",
"example": "Centro"
},
"cidade": {
"type": "string",
"description": "Cidade do segurado",
"example": "São Paulo"
},
"uf": {
"type": "string",
"description": "UF do segurado",
"example": "SP"
},
"cep": {
"type": "string",
"description": "CEP do segurado",
"example": "2412300"
},
"tipoResidenciaRisco": {
"type": "string",
"description": "Tipo de residência do objeto segurado(C - Casa, A - Apartamento, R - Residência) ",
"example": "C"
},
"objeto": {
"type": "string",
"description": "Objeto",
"example": "C"
},
"plano": {
"type": "string",
"description": "Plano",
"example": "C"
},
"inicioVigencia": {
"type": "string",
"description": "Data do início da vigência",
"example": "12/05/1991"
},
"finalVigencia": {
"type": "string",
"description": "Data do final da vigência",
"example": "12/05/2025"
}
},
"description": "Informações de endereço principal ou de risco do segurado"
},
"Parceiro": {
"required": [
"idParceiro",
"nomeParceiro",
"versaoDocumento"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro",
"example": "85684242"
},
"nomeParceiro": {
"type": "string",
"description": "Nome do parceiro",
"example": "Varejo comercial"
},
"idCertificado": {
"type": "string",
"description": "Identificador do certificado",
"example": "24360"
},
"versaoDocumento": {
"type": "string",
"description": "Versão do documento",
"example": "1"
}
},
"description": "Informações cadastrais do parceiro"
},
"Profissao": {
"type": "object",
"properties": {
"CodigoProfissao": {
"type": "string",
"description": "Código de profissão do segurado",
"example": "0160"
},
"descricaoProfissao": {
"type": "string",
"description": "Descrição da profissão do segurado",
"example": "Corretor"
},
"CodigoRenda": {
"type": "string",
"description": "Valor da renda do segurado",
"example": "10000.01"
}
},
"description": "Informações da profissão do segurado"
},
"Segurado": {
"type": "object",
"properties": {
"dadosPessoais": {
"$ref": "#/components/schemas/DadosPessoais"
},
"contato": {
"$ref": "#/components/schemas/Contato"
},
"documento": {
"$ref": "#/components/schemas/Documento"
},
"profissao": {
"$ref": "#/components/schemas/Profissao"
},
"endereco": {
"$ref": "#/components/schemas/Endereco"
},
"enderecoRisco": {
"$ref": "#/components/schemas/Endereco"
},
"dadosBancarios": {
"$ref": "#/components/schemas/DadosBancarios"
}
},
"description": "Informações cadastrais do segurado"
},
"BilheteCertificado": {
"required": [
"dataInclusao",
"descricaoProduto",
"descricaoRisco",
"finalVigencia",
"idCertificado",
"idProduto",
"idUnidadeProdutora",
"inicioVigencia",
"nomeSegurado",
"numeroDocumento",
"situacaoDocumento",
"versaoDocumento"
],
"type": "object",
"properties": {
"idProduto": {
"type": "integer",
"description": "Id do produto",
"format": "int64",
"example": 17
},
"idUnidadeProdutora": {
"type": "integer",
"description": "Id da unidade produtora",
"format": "int64",
"example": 1
},
"dataInclusao": {
"type": "string",
"description": "Data da inclusão",
"example": "01/01/09/06/2023"
},
"descricaoProduto": {
"type": "string",
"description": "Descrição do produto",
"example": "BRADESCO BILHETE RESIDENCIAL MENSAL"
},
"descricaoRisco": {
"type": "string",
"description": "Descrição do risco",
"example": "AV RETIRO DA IMPRENSA 1479 CASA"
},
"finalVigencia": {
"type": "string",
"description": "Final da vigência",
"example": "09/06/2028"
},
"idCertificado": {
"type": "integer",
"description": "Id do certificado",
"format": "int64",
"example": 3206676
},
"inicioVigencia": {
"type": "string",
"description": "Inicio vigência",
"example": "09/06/2023"
},
"nomeSegurado": {
"type": "string",
"description": "Nome do segurado",
"example": "JOÃO DA SILVA JUNIOR"
},
"numeroDocumento": {
"type": "integer",
"description": "Número do documento",
"format": "int64",
"example": 1
},
"situacaoDocumento": {
"type": "string",
"description": "Situação do Documento",
"example": "PROPOSTA AGUARDANDO AGENDAMENTO CARTAO CREDITO"
},
"versaoDocumento": {
"type": "integer",
"description": "Versão do documento",
"format": "int64",
"example": 1
}
},
"description": "Lista de documentos"
},
"BilheteEntity": {
"required": [
"documentos",
"requestStatus"
],
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"documentos": {
"type": "array",
"description": "Lista de documentos",
"items": {
"$ref": "#/components/schemas/BilheteCertificado"
}
}
},
"description": "Informações dos documentos consultados por parceiro"
},
"BilheteCertificadoParcelaEntity": {
"type": "object",
"properties": {
"parcela": {
"$ref": "#/components/schemas/BilheteCertificadoParcelas"
}
},
"description": "Lista de parcelas"
},
"BilheteCertificadoParcelas": {
"required": [
"adicionalFracionamento",
"custoEmissao",
"dataEnvioCobranca",
"dataPgtoCancelamentoParcela",
"dataRetornoCobranca",
"dataVencimentoFatura",
"dataVencimentoParcela",
"dvTituloCobranca",
"formaPgtoParcela",
"iof",
"numeroFatura",
"numeroParcela",
"numeroTituloCobranca",
"premioTarifa",
"premioTotal",
"situacaoParcela"
],
"type": "object",
"properties": {
"adicionalFracionamento": {
"type": "string",
"description": "Adicional do fracionamento",
"example": "0.0"
},
"custoEmissao": {
"type": "string",
"description": "Custo de emissão",
"example": "0.0"
},
"dataEnvioCobranca": {
"type": "string",
"description": "Data do envio da cobraça",
"example": "13/12/2022"
},
"dataPgtoCancelamentoParcela": {
"type": "string",
"description": "Data de pagamento do cancelamento da parcela",
"example": "13/12/20222"
},
"dataRetornoCobranca": {
"type": "string",
"description": "Data de retorno da cobrança",
"example": "13/12/2022"
},
"dataVencimentoFatura": {
"type": "string",
"description": "Data Vencimento Fatura",
"example": "13/12/2022"
},
"dataVencimentoParcela": {
"type": "string",
"description": "Data Vencimento Parcela",
"example": "13/12/2022"
},
"dvTituloCobranca": {
"type": "string",
"description": "Dígito verificador Titulo Cobranca",
"example": "0"
},
"formaPgtoParcela": {
"type": "string",
"description": "FormaPgto Parcela",
"example": "2"
},
"iof": {
"type": "string",
"description": "IOF",
"example": "6.87"
},
"numeroParcela": {
"type": "string",
"description": "Número da parcela",
"example": "1"
},
"numeroFatura": {
"type": "string",
"description": "Número da fatura",
"example": "22967"
},
"numeroTituloCobranca": {
"type": "string",
"description": "Número do título de cobranca",
"example": "0"
},
"premioTarifa": {
"type": "string",
"description": "Prêmio da tarifa",
"example": "93.13"
},
"premioTotal": {
"type": "string",
"description": "Prêmio total",
"example": "100.0"
},
"situacaoParcela": {
"type": "string",
"description": "Situação da parcela",
"example": "PAGA"
}
},
"description": "Parcela"
},
"BilheteCertificadoParcelasResponseEntity": {
"required": [
"parcelas",
"requestStatus"
],
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"parcelas": {
"type": "array",
"description": "Lista de parcelas",
"items": {
"$ref": "#/components/schemas/BilheteCertificadoParcelaEntity"
}
}
},
"description": "Informações de parcelas consultadas por parceiro"
},
"PagamentoRequest": {
"type": "object",
"properties": {
"pagamento": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "15684242"
},
"cartao": {
"type": "object",
"properties": {
"administradora": {
"type": "string",
"example": "40002"
},
"numero": {
"type": "string",
"example": "5162920982746291"
},
"validade": {
"type": "string",
"example": "06/2032"
}
},
"required": [
"administradora",
"numero",
"validade"
]
}
},
"required": [
"idParceiro",
"cartao"
]
}
},
"required": [
"pagamento"
]
},
"RequestStatusSucesso": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "200"
},
"message": {
"type": "string",
"example": "O cartão final 456 foi validado com sucesso."
},
"description": {
"type": "string",
"example": "N/A"
},
"requestStatusId": {
"type": "string",
"example": "854fbcf6-139e-468a-ad71-3fe059475b03"
}
},
"required": [
"code",
"message",
"requestStatusId"
]
},
"RequestStatusFalhaParametro": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "400"
},
"message": {
"type": "string",
"example": "Necessário informar o número."
},
"description": {
"type": "string",
"example": "N/A"
},
"requestStatusId": {
"type": "string",
"example": "854fbcf6-139e-468a-ad71-3fe059475b03"
}
},
"required": [
"code",
"message",
"requestStatusId"
]
},
"RequestStatusFalhaServico": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "500"
},
"message": {
"type": "string",
"example": "O cartão final 456 foi considerado inválido durante a validação."
},
"description": {
"type": "string",
"example": "Código:5 - Descrição: Erro Inesperado."
},
"requestStatusId": {
"type": "string",
"example": "854fbcf6-139e-468a-ad71-3fe059475b03"
}
},
"required": [
"code",
"message",
"requestStatusId"
]
},
"ExemploSucesso": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatusSucesso"
}
},
"required": [
"requestStatus"
]
},
"ExemploFalhaParametro": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatusFalhaParametro"
}
},
"required": [
"requestStatus"
]
},
"ExemploFalhaServico": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatusFalhaServico"
}
},
"required": [
"requestStatus"
]
},
"CertificadoRequest": {
"type": "object",
"properties": {
"certificado": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/CertificadoWrapper"
}
}
},
"required": [
"certificado"
]
},
"CertificadoWrapper": {
"type": "object",
"properties": {
"participantes": {
"$ref": "#/components/schemas/CertificadoParticipantes"
}
},
"required": [
"participantes"
]
},
"CertificadoParticipantes": {
"type": "object",
"properties": {
"parceiro": {
"$ref": "#/components/schemas/CertificadoParceiro"
}
},
"required": [
"parceiro"
]
},
"CertificadoParceiro": {
"type": "object",
"properties": {
"parceria": {
"$ref": "#/components/schemas/CertificadoParceria"
}
},
"required": [
"parceria"
]
},
"CertificadoParceria": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "12345678"
},
"idBloco": {
"type": "string",
"example": "1"
},
"idCanal": {
"type": "string",
"example": "39"
}
},
"required": [
"idParceiro",
"idBloco",
"idCanal"
]
},
"CertificadoResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
},
"parceiro": {
"$ref": "#/components/schemas/CertificadoResponseParceiro"
}
},
"required": [
"requestStatus",
"parceiro"
]
},
"CertificadoResponseParceiro": {
"type": "object",
"properties": {
"parceria": {
"$ref": "#/components/schemas/CertificadoResponseParceria"
}
},
"required": [
"parceria"
]
},
"CertificadoResponseParceria": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "12345678"
},
"idBloco": {
"type": "string",
"example": "1"
},
"idCanal": {
"type": "string",
"example": "39"
},
"idControle": {
"type": "string",
"example": "33495"
}
},
"required": [
"idParceiro",
"idBloco",
"idCanal",
"idCertificado"
]
},
"CertificadoErrorResponse": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatus"
}
},
"required": [
"requestStatus"
]
},
"PixPagamentoRequest": {
"type": "object",
"properties": {
"pagamento": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pagamento"
}
},
"requestStatusId": {
"type": "string",
"description": "ID do status da requisição"
}
}
},
"Pagamento": {
"type": "object",
"properties": {
"participantes": {
"$ref": "#/components/schemas/Participantes"
},
"propostas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Propostas"
}
}
}
},
"Participantes": {
"type": "object",
"properties": {
"parceiro": {
"$ref": "#/components/schemas/ParceiroPix"
}
}
},
"ParceiroPix": {
"type": "object",
"properties": {
"parceria": {
"$ref": "#/components/schemas/Parceria"
}
}
},
"Parceria": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "12345678"
}
}
},
"Propostas": {
"type": "object",
"properties": {
"proposta": {
"$ref": "#/components/schemas/Proposta"
}
}
},
"Proposta": {
"type": "object",
"properties": {
"dgReferencia": {
"type": "string"
},
"idEmpresa": {
"type": "string"
},
"idSucursal": {
"type": "string"
},
"idProposta": {
"type": "string"
},
"idEndosso": {
"type": "string"
},
"idRamoPrincipal": {
"type": "string"
},
"identificadorUnico": {
"type": "string"
},
"idParcela": {
"type": "string"
},
"idSinistro": {
"type": "string"
}
}
},
"PixPagamentoResponse": {
"type": "object",
"properties": {
"requestStatus": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "200"
},
"message": {
"type": "string",
"example": "Solicitação realizada com sucesso."
},
"description": {
"type": "string",
"example": "N/A"
},
"requestStatusId": {
"type": "string",
"example": "c17ea59c-d86b-46b9-b898-56834abaa178"
}
}
},
"parceiro": {
"type": "object",
"properties": {
"parceria": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"example": "12345678"
}
}
}
}
},
"propostas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"proposta": {
"type": "object",
"properties": {
"dgReferencia": {
"type": "string"
},
"idEmpresa": {
"type": "string"
},
"idSucursal": {
"type": "string"
},
"idRamoPrincipal": {
"type": "string"
},
"idProposta": {
"type": "string"
},
"idEndosso": {
"type": "string"
},
"identificadorUnico": {
"type": "string"
},
"idParcela": {
"type": "string"
},
"idSinistro": {
"type": "string"
},
"qrCode": {
"type": "string",
"example": "base64-qrcode"
},
"evPIXCC": {
"type": "string",
"example": "000201010212...5204000053039865802..."
}
}
}
}
}
}
}
},
"CancelarCobrancaRequest": {
"type": "object",
"properties": {
"sucursal": {
"type": "string",
"example": "5432"
},
"ramoPrincipal": {
"type": "string",
"example": "928"
},
"numeroProposta": {
"type": "string",
"example": "12336"
},
"idCertificado": {
"type": "string",
"example": "3805659"
},
"numeroParcela": {
"type": "string",
"example": "1"
}
},
"required": [
"sucursal",
"ramoPrincipal",
"numeroProposta",
"idCertificado",
"numeroParcela"
]
},
"CancelarCobrancaRequestStatusSucesso": {
"type": "object",
"properties": {
"mandt": {
"type": "string"
},
"dgnrseq": {
"type": "string"
},
"dgorigem": {
"type": "string"
},
"zcont": {
"type": "string"
},
"zmsgnr": {
"type": "string"
},
"zlogorigem": {
"type": "string"
},
"dgempresa": {
"type": "string"
},
"dgtpmovimento": {
"type": "string"
},
"znatxt": {
"type": "string"
},
"costatus": {
"type": "string"
},
"ztmstmp": {
"type": "string"
},
"idnmarquivo": {
"type": "string"
},
"requestStatus": {
"type": "string"
}
},
"required": [
"code",
"message",
"requestStatusId"
]
},
"CancelarCobrancaRequestStatusFalhaServico": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "500"
},
"message": {
"type": "string",
"example": "Ocorreu um erro inesperado"
},
"description": {
"type": "string",
"example": "Código:5 - Descrição: Erro Inesperado."
},
"requestStatusId": {
"type": "string",
"example": "854fbcf6-139e-468a-ad71-3fe059475b03"
}
},
"required": [
"code",
"message",
"requestStatusId"
]
},
"CancelarCobrancaExemploSucesso": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/CancelarCobrancaRequestStatusSucesso"
}
},
"required": [
"requestStatus"
]
},
"CartaoCreditoPCI": {
"required": [
"bandeiraCartaoCredito",
"numeroCartaoCredito",
"validadeCartaoCredito"
],
"type": "object",
"properties": {
"bandeiraCartaoCredito": {
"type": "string",
"description": "Bandeira do cartão de crédito(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "40003"
},
"numeroCartaoCredito": {
"type": "string",
"description": "Número do cartão de crédito",
"example": "4002111234555883"
},
"validadeCartaoCredito": {
"type": "string",
"description": "Validade do cartão de crédito",
"example": "062025"
},
"codigoSegurancaCartaoCredito": {
"type": "string",
"description": "Código de segurança do cartão de crédito",
"example": "000"
}
},
"description": "Informações de cartão de crédito"
},
"CedentePCI": {
"type": "object",
"properties": {
"conta": {
"type": "string",
"description": "Número do CCB - Opcional",
"example": "0"
},
"digito": {
"type": "string",
"description": "Dígito do CCB - Opcional",
"example": "0"
}
},
"description": "Informações do cedente"
},
"ContaBancariaPCI": {
"required": [
"agenciaDigito",
"agenciaNumero",
"codigoBanco",
"contaDigito1",
"contaNumero",
"tipoConta"
],
"type": "object",
"properties": {
"codigoBanco": {
"type": "string",
"description": "Código do banco",
"example": "237"
},
"agenciaNumero": {
"type": "string",
"description": "Código da agência",
"example": "3599"
},
"agenciaDigito": {
"type": "string",
"description": "Dígito da agência",
"example": "8"
},
"tipoConta": {
"type": "string",
"description": "Tipo de conta bancária(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "1"
},
"contaNumero": {
"type": "string",
"description": "Número da conta bancária",
"example": "299030"
},
"contaDigito1": {
"type": "string",
"description": "Dígito da conta",
"example": "5"
},
"contaDigito2": {
"type": "string",
"description": "Dígito 2 da conta",
"example": "6"
}
},
"description": "Informações de conta bancária"
},
"DadosPagamentosPCIRequest": {
"required": [
"pagamentos"
],
"type": "object",
"properties": {
"pagamentos": {
"type": "array",
"description": "Informações de pagamentos",
"items": {
"$ref": "#/components/schemas/PagamentoPCI"
}
}
},
"description": "Informações de pagamento na contratacao do seguro"
},
"PagamentoPCI": {
"required": [
"formaPagamento"
],
"type": "object",
"properties": {
"formaPagamento": {
"type": "string",
"description": "Forma de cobranca(Na URL /v1/seguro/tabelas/dados-cobranca)",
"example": "2"
},
"contaBancaria": {
"$ref": "#/components/schemas/ContaBancariaPCI"
},
"cartaoCredito": {
"$ref": "#/components/schemas/CartaoCreditoPCI"
},
"parcelas": {
"type": "array",
"description": "Parcelas",
"items": {
"$ref": "#/components/schemas/ParcelaObjectPCI"
}
},
"cedente": {
"type": "array",
"description": "Cedente",
"items": {
"$ref": "#/components/schemas/CedentePCI"
}
}
},
"description": "Informações de pagamento na contratacao do seguro"
},
"ParcelaObjectPCI": {
"type": "object",
"properties": {
"parcela": {
"$ref": "#/components/schemas/ParcelaPCI"
}
},
"description": "Informações da parcela"
},
"ParcelaPCI": {
"required": [
"dataVencimento"
],
"type": "object",
"properties": {
"dataVencimento": {
"type": "string",
"description": "Data do dataVencimento",
"example": "01/01/2001"
},
"valor": {
"type": "string",
"description": "Valor da parcela",
"example": "0.0"
}
},
"description": "Informações da parcela"
},
"DadosPagamentosPCIResponse": {
"type": "object",
"properties": {
"idEfetivacaoDadosPagamentos": {
"type": "string",
"description": "Identificador do registro de dados de pagamentos",
"example": "b26ab6cc-30df-44f7-876c-3002bd86c53d"
}
},
"description": "Informação de gravação dos dados de pagamentos"
},
"AtribuicaoPCI": {
"required": [
"funcao"
],
"type": "object",
"properties": {
"funcao": {
"type": "string",
"description": "Informações da atribuicoes do socio",
"example": "Sócio Administrador"
}
},
"description": "Informações das atribuicoes do socio na proposta do seguro"
},
"DadosDocumentosPCIRequest": {
"required": [
"documentos"
],
"type": "object",
"properties": {
"documentos": {
"type": "array",
"description": "Informações de documentos",
"items": {
"$ref": "#/components/schemas/DocumentoObjectPCI"
}
},
"quadroSocietario": {
"$ref": "#/components/schemas/QuadroSocietarioPCI"
}
},
"description": "Informações de documentos do proponente do seguro"
},
"DocumentoObjectPCI": {
"required": [
"documento"
],
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/DocumentoPCI"
}
},
"description": "Informações do documento do proponente do seguro"
},
"DocumentoPCI": {
"required": [
"numeroDocumento",
"tipoDocumento"
],
"type": "object",
"properties": {
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento",
"example": "RG"
},
"numeroDocumento": {
"type": "string",
"description": "Número do documento",
"example": "123456789"
},
"dataEmissao": {
"type": "string",
"description": "Data de emissão do documento (Opcional - Caso valor em branco será preenchido com 01/01/0001 (Default)",
"example": "01/01/0001"
},
"orgaoExpedidor": {
"type": "string",
"description": "Orgão expedidor do documento",
"example": "IFP"
}
},
"description": "Informações do documento do proponente do seguro"
},
"PessoaJuridicaPCI": {
"required": [
"razaoSocial",
"descricaoAtividadeEconomica",
"classe",
"cnpj",
"cnae"
],
"type": "object",
"properties": {
"razaoSocial": {
"type": "string",
"description": "Razão social da empresa",
"example": "Sensedia SA"
},
"nomeFantasia": {
"type": "string",
"description": "Nome fantasia da empresa",
"example": "Sensedia"
},
"descricaoAtividadeEconomica": {
"type": "string",
"description": "Informações da atividade economica",
"example": "Tecnologia da Informação"
},
"cnae": {
"type": "string",
"description": "Informações do rcnae",
"example": "12345"
},
"classe": {
"type": "string",
"description": "Informações da classe",
"example": "A"
},
"tabelaGrupo": {
"type": "string",
"description": "Informações da tabelaGrupo",
"example": "G001"
},
"grupoAtividade": {
"type": "string",
"description": "Informações do grupo de atividade",
"example": "Desenvolvimento de Software"
}
},
"description": "Informações de pessoa juridica do proponente do seguro"
},
"QuadroSocietarioPCI": {
"required": [
"nome",
"atribuicoes",
"funcao",
"documentos"
],
"type": "object",
"properties": {
"nome": {
"type": "string",
"description": "Informações da nome do socio",
"example": "Jose de Souza"
},
"atribuicoes": {
"$ref": "#/components/schemas/AtribuicaoPCI"
},
"documentos": {
"type": "array",
"description": "Informações de documentos dos socios",
"items": {
"$ref": "#/components/schemas/DocumentoObjectPCI"
}
}
},
"description": "Informações do quadro societario do proponente do seguro"
},
"DadosDocumentosPCIResponse": {
"type": "object",
"properties": {
"idEfetivacaoDadosDocumentos": {
"type": "string",
"description": "Identificador do registro de dados documentais",
"example": "b26ab6cc-30df-44f7-876c-3002bd86c53d"
}
},
"description": "Informação de gravação dos dados documentais"
},
"ContatoObjectPCI": {
"required": [
"contato"
],
"type": "object",
"properties": {
"contato": {
"$ref": "#/components/schemas/ContatoPCI"
}
},
"description": "Informações de contato do proponente do seguro"
},
"ContatoPCI": {
"required": [
"tipo",
"valor"
],
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Informações do tipo do contato do segurado",
"example": "telefoneFixo, celular ou email"
},
"valor": {
"type": "string",
"description": "Informações de valor do contato do segurado",
"example": "71999887766"
}
},
"description": "Informações de contato do proponente do seguro"
},
"DadosCadastraisPCI": {
"type": "object",
"properties": {
"pessoaFisica": {
"$ref": "#/components/schemas/PessoaFisicaPCI"
},
"pessoaJuridica": {
"$ref": "#/components/schemas/PessoaJuridicaPCI"
}
},
"description": "Informações cadastrais do proponente do seguro"
},
"DadosCadastraisPCIRequest": {
"required": [
"dadosCadastrais",
"contatos",
"enderecos"
],
"type": "object",
"properties": {
"dadosCadastrais": {
"$ref": "#/components/schemas/DadosCadastraisPCI"
},
"contatos": {
"type": "array",
"description": "Informações de contato",
"items": {
"$ref": "#/components/schemas/ContatoObjectPCI"
}
},
"enderecos": {
"type": "array",
"description": "Informações do endereço",
"items": {
"$ref": "#/components/schemas/EnderecoObjectPCI"
}
}
},
"description": "Informações cadastrais do proponente do seguro"
},
"EnderecoObjectPCI": {
"required": [
"endereco"
],
"type": "object",
"properties": {
"endereco": {
"$ref": "#/components/schemas/EnderecoPCI"
}
},
"description": "Informações de endereço do proponente do seguro"
},
"EnderecoPCI": {
"required": [
"bairro",
"cep",
"cidade",
"logradouro",
"numero",
"tipoLogradouro",
"uf"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"description": "Logradouro",
"example": "Rua das Aroeiras"
},
"complemento": {
"type": "string",
"description": "Complemento residêncial",
"example": "AP105"
},
"numero": {
"type": "string",
"description": "Número residêncial",
"example": "1000"
},
"uf": {
"type": "string",
"description": "UF",
"example": "RJ"
},
"bairro": {
"type": "string",
"description": "Bairro",
"example": "Tijuca"
},
"cep": {
"type": "string",
"description": "CEP",
"example": "246660000"
},
"cidade": {
"type": "string",
"description": "Cidade",
"example": "Rio de Janeiro"
},
"tipoLogradouro": {
"type": "string",
"description": "Tipo do Logradouro",
"example": "RUA"
},
"pais": {
"type": "string",
"description": "País",
"example": "BR"
},
"objetoEndereco": {
"type": "string",
"description": "Tipo de objeto da residência",
"example": "1"
},
"tipoEndereco": {
"type": "string",
"description": "Tipo da Residência(C - Casa, A - Apartamento, R - Residência)",
"example": "A"
}
},
"description": "Informações de endereço do proponente do seguro"
},
"PessoaFisicaPCI": {
"required": [
"dataNascimento",
"estadoCivil",
"nome",
"profissao",
"sexo",
"tipoPessoa"
],
"type": "object",
"properties": {
"dataNascimento": {
"type": "string",
"description": "Data de nascimento",
"example": "01/01/1950"
},
"estadoCivil": {
"type": "string",
"description": "Estado Civil(Na URL /v1/seguro/tabelas/dados-pessoais)",
"example": "7"
},
"nome": {
"type": "string",
"description": "Nome",
"example": "João da Silva"
},
"sexo": {
"type": "string",
"description": "Sexo(Na URL /v1/seguro/tabelas/dados-pessoais)",
"example": "M"
},
"tipoPessoa": {
"type": "string",
"description": "Tipo de pessoa(1 – Física, 2 - Jurídica)",
"example": "1"
},
"profissao": {
"$ref": "#/components/schemas/ProfissaoPCI"
}
},
"description": "Informações de pessoa fisica do proponente do seguro"
},
"ProfissaoPCI": {
"required": [
"codigoProfissao",
"descricaoProfissao"
],
"type": "object",
"properties": {
"atividadePrincipal": {
"type": "string",
"description": "Atividade principal - Opcional",
"example": "Supervisor de estagiários"
},
"codigoProfissao": {
"type": "string",
"description": "Código de profissão em pessoaFisica",
"example": "01"
},
"CodigoRenda": {
"type": "string",
"description": "Código do valor da renda - Opcional (Na url /v1/seguro/tabelas/profissao)",
"example": "3000.0"
},
"descricaoProfissao": {
"type": "string",
"description": "Descricão da profissão",
"example": "Outros"
}
},
"description": "Informações de profissao do proponente do seguro"
},
"DadosCadastraisPCIResponse": {
"type": "object",
"properties": {
"idEfetivacaoDadosCadastrais": {
"type": "string",
"description": "Identificador do registro de dados cadastrais",
"example": "b26ab6cc-30df-44f7-876c-3002bd86c53d"
}
},
"description": "Informação de gravação dos dados cadastrais"
},
"AnaliseComercialPCI": {
"required": [
"etapa",
"codigoOperacao"
],
"type": "object",
"properties": {
"etapa": {
"type": "string",
"description": "Informações da etapa",
"example": "1-PF, 2-PJ, 3-PF_PJ ou 4-PJ_PJ"
},
"codigoOperacao": {
"type": "array",
"description": "Informações do codigoOperacao",
"items": {
"$ref": "#/components/schemas/CodigoOperacaoPCI"
}
}
},
"description": "Informações da analise comercial na contratacao de um seguro"
},
"CoberturasPCI": {
"type": "object",
"properties": {
"fracionamentoCoberturaContratada": {
"type": "string",
"description": "Adicional de Fracionamento por cobertura contratada",
"example": "00"
},
"descricaoCoberturaContratada": {
"type": "string",
"description": "Código da descrição da cobertura contratada",
"example": "98"
},
"custoEmissaoCobertura": {
"type": "string",
"description": "Custo de emissão da cobertura",
"example": "00"
},
"descontoComercialVendaCorretorCobertura": {
"type": "string",
"description": "Desconto comercial na operação de venda com o corretor por cobertura",
"example": "00"
},
"valorAgravoPremioCobertura": {
"type": "string",
"description": "Valor de agravo do prêmio por cobertura",
"example": "00"
},
"valorPremioBrutoCobertura": {
"type": "string",
"description": "Valor do prêmio bruto por cobertura",
"example": "61179"
},
"valorPremioFinalCobertura": {
"type": "string",
"description": "Valor do prêmio final por cobertura",
"example": "6574"
},
"premioLiquidoCobertura": {
"type": "string",
"description": "Valor do prêmio líquido por cobertura sem emolumentos",
"example": "6122"
},
"franquiaSUSEPCobertura": {
"type": "string",
"description": "Código de franquia para envio à Susep por cobertura",
"example": "5"
},
"valorFranquiaCobertura": {
"type": "string",
"description": "Valor da Franquia por cobertura",
"example": "5000"
},
"valorIOFCobertura": {
"type": "string",
"description": "Valor IOF por cobertura",
"example": "452"
},
"valorMaxFranquiaCobertura": {
"type": "string",
"description": "Valor Máximo de Franquia por cobertura",
"example": "5000"
},
"valorMinFranquiaCobertura": {
"type": "string",
"description": "Valor Mínimo de Franquia por cobertura",
"example": "0"
},
"limiteMaxIndenizacaoCobertura": {
"type": "string",
"description": "Percentual da franquia por cobertura",
"example": "3"
},
"percentualFranquiaCobertura": {
"type": "string",
"description": "Valor Limite Máximo de indenização por cobertura",
"example": "100"
}
},
"description": "Informações das coberturas do produto"
},
"CodigoOperacaoPCI": {
"required": [
"codigoOperacao",
"tipo"
],
"type": "object",
"properties": {
"codigoOperacao": {
"type": "string",
"description": "Informações da codigoOperacao",
"example": "0001PJ"
},
"tipo": {
"type": "string",
"description": "Tipo do codigoOperacao",
"example": "proponente"
}
},
"description": "Informações do codigo de operação na analise comercial na contratacao de um seguro"
},
"DadosEfetivacaoPCI": {
"required": [
"idEfetivacaoDadosCadastrais",
"idEfetivacaoDadosDocumentos",
"idEfetivacaoDadosPagamentos"
],
"type": "object",
"properties": {
"idEfetivacaoDadosCadastrais": {
"type": "string",
"description": "Informações de dados cadastrais",
"example": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274"
},
"idEfetivacaoDadosDocumentos": {
"type": "string",
"description": "Informações dos dados de documentos",
"example": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274"
},
"idEfetivacaoDadosPagamentos": {
"type": "string",
"description": "Informações dos dados de pagamento",
"example": "b62b1a4f-e74a-41ac-9bc9-c70d84eb4274"
}
},
"description": "Informações do parceiro na contratacao de um seguro"
},
"DadosSegurosPCIRequest": {
"required": [
"seguros"
],
"type": "object",
"properties": {
"seguros": {
"type": "array",
"description": "Informações de um seguro",
"items": {
"$ref": "#/components/schemas/SeguroPCI"
}
}
},
"description": "Informações para a contratacao de um seguro"
},
"EnderecoRiscoPCI": {
"required": [
"bairro",
"cep",
"cidade",
"logradouro",
"numero",
"tipoLogradouro",
"uf",
"tipoEndereco (Risco)",
"objetoEndereco (Risco)"
],
"type": "object",
"properties": {
"logradouro": {
"type": "string",
"description": "Logradouro",
"example": "Rua das Aroeiras"
},
"complemento": {
"type": "string",
"description": "Complemento residêncial",
"example": "AP105"
},
"numero": {
"type": "string",
"description": "Número residêncial",
"example": "1000"
},
"uf": {
"type": "string",
"description": "UF",
"example": "RJ"
},
"bairro": {
"type": "string",
"description": "Bairro",
"example": "Tijuca"
},
"cep": {
"type": "string",
"description": "CEP",
"example": "246660000"
},
"cidade": {
"type": "string",
"description": "Cidade",
"example": "Rio de Janeiro"
},
"tipoLogradouro": {
"type": "string",
"description": "Tipo do Logradouro",
"example": "RUA"
},
"pais": {
"type": "string",
"description": "País",
"example": "BR"
},
"objetoEndereco": {
"type": "string",
"description": "(Risco) Tipo de objeto da residência",
"example": "1"
},
"tipoEndereco": {
"type": "string",
"description": "(Risco) Tipo da Residência(C - Casa, A - Apartamento, R - Residência)",
"example": "A"
}
},
"description": "Informações do objetoRisco na contratacao de um seguro"
},
"AdicionalInfoPCI": {
"type": "object",
"description": "Informações adicionais vinculadas ao risco",
"properties": {
"id": {
"type": "string",
"description": "Identificador do grupo de informações (ex: pet1, pet2)",
"example": "pet1"
},
"chave": {
"type": "string",
"description": "Chave da informação (ex: tipo, nome)",
"example": "tipo"
},
"valor": {
"type": "string",
"description": "Valor da informação",
"example": "1"
}
},
"required": [
"id",
"chave",
"valor"
]
},
"GerentePCI": {
"type": "object",
"properties": {
"dadosCadastrais": {
"$ref": "#/components/schemas/DadosCadastraisPCI"
},
"enderecos": {
"type": "array",
"description": "Informações do endereço",
"items": {
"$ref": "#/components/schemas/EnderecoObjectPCI"
}
},
"documentos": {
"type": "array",
"description": "Informações de documentos",
"items": {
"$ref": "#/components/schemas/DocumentoObjectPCI"
}
}
},
"description": "Informações do parceiro na contratacao de um seguro"
},
"ModalidadePCI": {
"required": [
"tipoModalidade"
],
"type": "object",
"properties": {
"tipoModalidade": {
"type": "string",
"description": "Tipo da modalidade",
"example": "pre-formatado ou parcelado"
},
"camposDisponiveis": {
"type": "string",
"description": "Campos Disponiveis",
"example": "valor em string"
},
"opcao": {
"type": "string",
"description": "Opção do parcelamento",
"example": "1"
},
"valorTotal": {
"type": "string",
"description": "Valor do premio total",
"example": 19990
},
"valorPrimeiraParcela": {
"type": "string",
"description": "Valor da primeira parcela da proposta",
"example": 9990
},
"quantidadeParcelas": {
"type": "string",
"description": "Quantidade de parcelas da proposta",
"example": "10"
},
"valorDemaisParcelas": {
"type": "string",
"description": "Valor das demais parcelas da proposta",
"example": 1000
},
"percentualJurosTotal": {
"type": "string",
"description": "Percentual de juros total",
"example": 1000
},
"percentualComissaoCorretor": {
"type": "string",
"description": "Percentual de comissão do Corretor",
"example": "130"
},
"codigoUsoObjetoRisco": {
"type": "string",
"description": "Código de uso do objeto de risco",
"example": "H"
},
"fracionamentoProdutoTotal": {
"type": "string",
"description": "Adicional de Fracionamento do produto Total",
"example": "00"
},
"custoEmissaoDocumentoTotal": {
"type": "string",
"description": "Custo de emissão do documento Total",
"example": "00"
},
"descontoComercialVendaCorretorTotal": {
"type": "string",
"description": "Desconto comercial na operação de venda com o corretor Total",
"example": "00"
},
"tipoConstrucaoObjetoRisco": {
"type": "string",
"description": "Código de tipo de construção do objeto de risco",
"example": "S"
},
"tipoUsoComercialObjetoRisco": {
"type": "string",
"description": "Código do tipo do uso comercial do objeto de risco",
"example": "S"
},
"valorAgravoPremioCoberturaTotal": {
"type": "string",
"description": "Valor de agravo do prêmio por cobertura Total",
"example": "00"
},
"valorPremioBrutoCoberturaTotal": {
"type": "string",
"description": "Valor do prêmio bruto por cobertura Total",
"example": "61179"
},
"valorPremioCoberturaTotal": {
"type": "string",
"description": "Valor do prêmio final por cobertura Total",
"example": "65694"
},
"premioLiquidoCoberturaTotal": {
"type": "string",
"description": "Valor do prêmio líquido por cobertura sem emolumentos Total",
"example": "61179"
},
"limiteMaxIndenizacaoCoberturaTotal": {
"type": "string",
"description": "Valor Limite Máximo de indenização por cobertura Total",
"example": "3"
},
"valorCoberturaIOFTotal": {
"type": "string",
"description": "Valor IOF por cobertura Total",
"example": "4515"
}
},
"description": "Informações da modalidade do produtos"
},
"ObjetoRiscoPCI": {
"required": [
"risco"
],
"type": "object",
"properties": {
"risco": {
"$ref": "#/components/schemas/RiscoPCI"
}
},
"description": "Informações do objetoRisco na contratacao de um seguro"
},
"ObjetoSeguradoPCI": {
"required": [
"produto",
"objetosRisco"
],
"type": "object",
"properties": {
"produto": {
"$ref": "#/components/schemas/ProdutoPCI"
},
"objetosRisco": {
"type": "array",
"description": "Informações de objetosRisco",
"items": {
"$ref": "#/components/schemas/ObjetoRiscoPCI"
}
}
},
"description": "Informações do objetoSegurado na contratacao de um seguro"
},
"ParceiroObjectPCI": {
"required": [
"parceria"
],
"type": "object",
"properties": {
"parceria": {
"$ref": "#/components/schemas/ParceiroPCI"
}
},
"description": "Informações do parceiro na contratacao de um seguro"
},
"ParceiroPCI": {
"required": [
"cia",
"idCorretor",
"idParceiro",
"sucursal"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Informações do parceiro",
"example": "12345678"
},
"usuario": {
"type": "string",
"description": "Informações do usuario",
"example": "API_RE"
},
"sucursal": {
"type": "string",
"description": "Informações da sucursal",
"example": "123"
},
"cia": {
"type": "string",
"description": "Informações da cia",
"example": "123"
},
"idCorretor": {
"type": "string",
"description": "Informações do corretor",
"example": "123456"
}
},
"description": "Informações do parceiro na contratacao de um seguro"
},
"ParticipantesPCI": {
"required": [
"parceiro",
"proponente"
],
"type": "object",
"properties": {
"parceiro": {
"$ref": "#/components/schemas/ParceiroObjectPCI"
},
"proponente": {
"$ref": "#/components/schemas/ProponentePCI"
},
"gerente": {
"$ref": "#/components/schemas/GerentePCI"
},
"vendedor": {
"$ref": "#/components/schemas/VendedorPCI"
},
"representante": {
"$ref": "#/components/schemas/RepresentantePCI"
}
},
"description": "Informações de participantes na contratacao de um seguro"
},
"ProdutoPCI": {
"required": [
"id",
"canal",
"fase",
"idBloco",
"idParceiro",
"idPlano"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identificador do parceiro",
"example": "1003849862"
},
"canal": {
"type": "string",
"description": "Identificador do canal",
"example": "17"
},
"fase": {
"type": "string",
"description": "Identificador da fase(1, 2 e 3 - Shopping Seguros, 9 - Internet Banking)",
"example": "1"
},
"idBloco": {
"type": "string",
"description": "Identificador do bloco",
"example": "1"
},
"idControle": {
"type": "string",
"description": "Identificador do certificado",
"example": "3206676"
},
"idPlano": {
"type": "string",
"description": "Identificador do plano",
"example": "1"
},
"numeroTituloCap": {
"type": "string",
"description": "Identificador do título de capitalização - Opcional",
"example": "12345678901234567890"
},
"inicioVigencia": {
"type": "string",
"description": "Data de início da vigencia - Opcional",
"example": "01/01/2024"
},
"fimVigencia": {
"type": "string",
"description": "Data de fim da vigencia - Opcional",
"example": "01/01/2024"
},
"modalidade": {
"$ref": "#/components/schemas/ModalidadePCI"
},
"coberturas": {
"type": "array",
"description": "Coberturas",
"items": {
"$ref": "#/components/schemas/CoberturasPCI"
}
}
},
"description": "Informações do produto"
},
"ProdutoraPCI": {
"required": [
"agencia",
"digitoAgencia",
"unidade"
],
"type": "object",
"properties": {
"agencia": {
"type": "string",
"description": "Agencia Produtora",
"example": "3599"
},
"digitoAgencia": {
"type": "string",
"description": "Digito da Agencia Produtora",
"example": "8"
},
"unidade": {
"type": "string",
"description": "Unidade Produtora",
"example": "1"
}
},
"description": "Informações da produtora na contratacao de um seguro"
},
"ProponentePCI": {
"required": [
"analisesComerciais",
"dadosEfetivacao"
],
"type": "object",
"properties": {
"analisesComerciais": {
"$ref": "#/components/schemas/AnaliseComercialPCI"
},
"dadosEfetivacao": {
"$ref": "#/components/schemas/DadosEfetivacaoPCI"
}
},
"description": "Informações do proponente na contratacao de um seguro"
},
"RecursoAdicionalPCI": {
"required": [
"id",
"valor"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id ou nome do recurso",
"example": "recurso"
},
"valor": {
"type": "string",
"description": "Valor do recurso",
"example": "valor em string"
}
},
"description": "Informações adicionais na contratacao de um seguro"
},
"RemuneracaoVendaPCI": {
"required": [
"idRemuneracao",
"percentual"
],
"type": "object",
"properties": {
"idRemuneracao": {
"type": "string",
"description": "Informações do id da remuneração",
"example": "100001"
},
"percentual": {
"type": "string",
"description": "Informações do percentual da remuneração",
"example": "17.5"
}
},
"description": "Informações da remuneração do vendedor na contratacao de um seguro"
},
"RepresentantePCI": {
"type": "object",
"properties": {
"dadosCadastrais": {
"$ref": "#/components/schemas/DadosCadastraisPCI"
},
"documentos": {
"type": "array",
"description": "Informações de documentos",
"items": {
"$ref": "#/components/schemas/DocumentoObjectPCI"
}
}
},
"description": "Informações do representante na contratacao de um seguro"
},
"RiscoPCI": {
"required": [
"tipo"
],
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Informações de tipo",
"example": "empresarial ou residencial"
},
"enderecos": {
"$ref": "#/components/schemas/EnderecoRiscoPCI"
},
"adicionalInfo": {
"type": "array",
"description": "Informações adicionais (exemplo: informações de Pet)",
"items": {
"$ref": "#/components/schemas/AdicionalInfoPCI"
}
}
},
"description": "Informações do objetoRisco na contratacao de um seguro"
},
"SeguroPCI": {
"required": [
"participantes",
"objetosSegurados",
"produtora"
],
"type": "object",
"properties": {
"participantes": {
"$ref": "#/components/schemas/ParticipantesPCI"
},
"objetosSegurados": {
"type": "array",
"description": "Informações de objetosSegurados",
"items": {
"$ref": "#/components/schemas/ObjetoSeguradoPCI"
}
},
"produtora": {
"$ref": "#/components/schemas/ProdutoraPCI"
},
"recursosAdicionais": {
"type": "array",
"description": "Informações de recursosAdicionais",
"items": {
"$ref": "#/components/schemas/RecursoAdicionalPCI"
}
}
},
"description": "Informações da contratacao de um seguro"
},
"VendedorPCI": {
"type": "object",
"properties": {
"dadosCadastrais": {
"$ref": "#/components/schemas/DadosCadastraisPCI"
},
"enderecos": {
"type": "array",
"description": "Informações do endereço",
"items": {
"$ref": "#/components/schemas/EnderecoObjectPCI"
}
},
"documentos": {
"type": "array",
"description": "Informações de documentos",
"items": {
"$ref": "#/components/schemas/DocumentoObjectPCI"
}
},
"remuneracaoVenda": {
"$ref": "#/components/schemas/RemuneracaoVendaPCI"
}
},
"description": "Informações do vendedor na contratacao de um seguro"
},
"AnaliseComercialRE": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/RequestStatusAnaliseComercial"
},
"analiseComercialRE": {
"$ref": "#/components/schemas/AnaliseComercialREResponse"
}
},
"description": "Retorno dos dados do cliente empresarial analisado, proponente e representante podem retornar pessoa fisica ou pessoa juridica"
},
"AnaliseComercialREEntity": {
"required": [
"analiseComercialREEntity"
],
"type": "object",
"properties": {
"analiseComercialREEntity": {
"$ref": "#/components/schemas/AnaliseComercialRequest"
}
}
},
"AnaliseComercialRequest": {
"required": [
"idParceiro",
"risco",
"proponente"
],
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro",
"example": "15878790"
},
"risco": {
"$ref": "#/components/schemas/RiscoEntity"
},
"proponente": {
"$ref": "#/components/schemas/RequerenteEntity"
},
"representante": {
"$ref": "#/components/schemas/RequerenteEntity"
}
},
"description": "Entrada de dados do cliente a ser analisado"
},
"RiscoEntity": {
"required": [
"cep",
"idTipoRisco"
],
"type": "object",
"properties": {
"cep": {
"type": "string",
"description": "Numero do CEP a ser analisado",
"example": "12345678"
},
"idTipoRisco": {
"type": "string",
"enum": [
"100",
"200"
],
"description": "Id do tipo de risco a ser analisado",
"example": "200"
}
}
},
"RequerenteEntity": {
"required": [
"tipoDocumento",
"numeroDocumento"
],
"type": "object",
"properties": {
"tipoDocumento": {
"type": "string",
"enum": [
"CPF",
"CNPJ"
],
"description": "Tipo do documento a ser analisado",
"example": "CNPJ"
},
"numeroDocumento": {
"type": "string",
"description": "Numero do documento a ser analisado",
"example": "11111111111"
},
"dataNascimento": {
"type": "string",
"description": "Data de nascimento a ser informada caso o tipo documendo for CPF",
"example": "01/01/1990"
}
}
},
"AnaliseComercialREResponse": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro",
"example": "15878790"
},
"endereco": {
"$ref": "#/components/schemas/EnderecoResponse"
},
"proponente": {
"$ref": "#/components/schemas/RequerentePJResponse"
},
"representante": {
"$ref": "#/components/schemas/RequerentePFResponse"
}
}
},
"EnderecoResponse": {
"type": "object",
"properties": {
"dadosRisco": {
"$ref": "#/components/schemas/DadosRisco"
},
"cep": {
"type": "string",
"description": "CEP retornado da base de dados",
"example": "11111111"
},
"logradouro": {
"type": "string",
"description": "Logradouro retornado da base de dados",
"example": "Av. Castelo Branco"
},
"numero": {
"type": "string",
"description": "Numero do logradouro retornado da base de dados",
"example": "1200"
},
"complemento": {
"type": "string",
"description": "Complemento do logradouro retornado da base de dados",
"example": "Apto 1644"
},
"bairro": {
"type": "string",
"description": "Bairro retornado da base de dados",
"example": "Centro"
},
"cidade": {
"type": "string",
"description": "Cidade retornado da base de dados",
"example": "Rio de Janeiro"
},
"uf": {
"type": "string",
"description": "UF retornado da base de dados",
"example": "RJ"
}
}
},
"RequerentePFResponse": {
"type": "object",
"properties": {
"codigoOperacao": {
"type": "string",
"description": "Código gerado pela base de dados",
"example": "00056nz"
},
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento retornado da base de dados",
"example": "CPF"
},
"documento": {
"type": "string",
"description": "Numero do documento retornado da base de dados",
"example": "11111111111"
},
"nome": {
"type": "string",
"description": "Nome retornado da base de dados",
"example": "Bill Gates"
},
"sexo": {
"type": "string",
"description": "Sexo retornado da base de dados",
"example": "MASCULINO"
},
"dataNascimento": {
"type": "string",
"description": "Data de nascimento retornada da base de dados",
"example": "01/01/1990"
},
"dataNascimentoInformada": {
"type": "string",
"description": "Data de nascimento informada na requisição",
"example": "01/01/1990"
},
"email": {
"type": "string",
"description": "Email retornado da base de dados",
"example": "email@email.com.br"
},
"telefones": {
"type": "string",
"description": "Lista de telefones retornado da base de dados",
"example": "{(21) 32920196, (21)22531177}"
},
"aprovacao": {
"type": "string",
"description": "Status da analise gerada",
"example": "true"
},
"situacao": {
"type": "string",
"description": "Situaçãop da analise gerada",
"example": "Aprovado - #0001004#"
}
}
},
"RequerentePJResponse": {
"type": "object",
"properties": {
"codigoOperacao": {
"type": "string",
"description": "Código de operação gerada pela base de dados",
"example": "00056nz"
},
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento retornado da base de dados",
"example": "CNPJ"
},
"documento": {
"type": "string",
"description": "Numero do documento retornado pela base de dados",
"example": "47960950000121"
},
"cnae": {
"type": "string",
"description": "CNAE retornado da base de dados",
"example": "4713004"
},
"razaoSocial": {
"type": "string",
"description": "Razão social retornado da base de dados",
"example": "EMPRESA S/A"
},
"codigoAtividadeEconomica": {
"type": "string",
"description": "Código da atividade economica retornado da base de dados",
"example": "4713004"
},
"descicaoAtividadeEconomica": {
"type": "string",
"description": "Descição da atividade econômica retornado da base de dados",
"example": "LOJA DE DEPARTAMENTOS"
},
"dataAberturaEmpresa": {
"type": "string",
"description": "Data da abertura da empresa retornada da base de dados",
"example": "01/01/1990"
},
"codigoNaturezaJuridica": {
"type": "string",
"description": "Código da natureza juridíca retornado da base de dados",
"example": "2046"
},
"socios": {
"type": "string",
"description": "Lista de socios retonado da base de dados",
"example": "{qualificacao: GERENTE, nome: JOSE ALBERTO, cpf: 11111111111}"
},
"telefones": {
"type": "string",
"description": "Lista de telefones retornado da base de dados",
"example": "{(21) 32920196}"
},
"email": {
"type": "string",
"description": "Email retornado da base de dados",
"example": "email@email.com.br"
},
"celular": {
"type": "string",
"description": "Numero de celular retornado da base de dados",
"example": "(21) 932920196"
},
"aprovacao": {
"type": "string",
"description": "Status da analise gerada",
"example": "true"
},
"situacao": {
"type": "string",
"description": "Situação da analise gerada",
"example": "Aprovado - #0001004#"
}
}
},
"DadosRisco": {
"type": "object",
"properties": {
"idTipoRisco": {
"type": "string",
"description": "Tipo de risco informado na requisição",
"example": "200"
},
"cepRisco": {
"type": "string",
"description": "CEP de risco informado na requisição",
"example": "12345678"
}
}
},
"RequestStatusAnaliseComercial": {
"type": "object",
"properties": {
"codigoErro": {
"type": "string",
"description": "Código do erro",
"example": "200"
},
"message": {
"type": "string",
"description": "Mensagem do erro",
"example": "Análise comercial realizada com sucesso."
},
"description": {
"type": "string",
"description": "Descrição do erro",
"example": "N/A"
}
},
"description": "Informações de controle do resultado da requisição"
},
"CreditTalkREEntity": {
"required": [
"proponente"
],
"type": "object",
"properties": {
"proponente": {
"$ref": "#/components/schemas/CreditTalkDadosConsulta"
},
"representante": {
"$ref": "#/components/schemas/CreditTalkDadosConsulta"
}
},
"description": "Dados de entrada para a consulta do histórico para o empresarial."
},
"CreditTalkDadosConsulta": {
"type": "object",
"required": [
"tipoDocumento",
"documento",
"cep",
"codigoOperacao",
"origem",
"idParceiro"
],
"properties": {
"tipoDocumento": {
"type": "string",
"enum": [
"CPF",
"CNPJ"
],
"description": "Tipo de documento a ser consultado",
"example": "CPF"
},
"documento": {
"type": "string",
"description": "Numero do documento a ser consultado",
"example": "12345678910"
},
"cep": {
"type": "string",
"description": "CEP a ser consultado",
"example": "123456788"
},
"codigoOperacao": {
"type": "string",
"description": "Código da operação a ser consultada",
"example": "00056nz"
},
"origem": {
"type": "string",
"description": "Origem da chamada",
"example": "1"
},
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro",
"example": "12345"
}
}
},
"CreditTalkREResponse": {
"type": "object",
"properties": {
"proponente": {
"$ref": "#/components/schemas/CreditTalkREDadosRetornados"
},
"representante": {
"$ref": "#/components/schemas/CreditTalkREDadosRetornados"
}
}
},
"CreditTalkREDadosRetornados": {
"type": "object",
"properties": {
"idParceiro": {
"type": "string",
"description": "Identificador do parceiro informado na requisição",
"example": "1234"
},
"codigoOperacao": {
"type": "string",
"description": "Código da operação consultada",
"example": "00056nz"
},
"tipoDocumento": {
"type": "string",
"description": "Tipo de documento informado na requisição",
"example": "CPF"
},
"documento": {
"type": "string",
"description": "Numero do documento consultado",
"example": "11111111111"
},
"cep": {
"type": "string",
"description": "CEP consultado",
"example": "12345678"
},
"situacao": {
"type": "string",
"description": "Situação da analíse comercial",
"example": "#0001004#"
},
"dataAnaliseComercial": {
"type": "string",
"description": "Data da analíse comercial",
"example": "01/01/1990"
},
"validacao": {
"type": "string",
"description": "Status da validação",
"example": "true"
},
"mensagemValidacao": {
"type": "string",
"description": "Mensagem da validação",
"example": "Aprovado"
}
}
},
"AnalisarProposta": {
"type": "object",
"properties": {
"codRetorno": {
"type": "integer",
"description": "Código retornado da analise",
"example": 0
},
"mensagemErro": {
"type": "string",
"description": "Mensagem de validação será retornada neste campo",
"example": "ANALISE EFETUADA COM SUCESSO"
},
"nomePrograma": {
"type": "string",
"description": "Nome do programa que efetuou a critica",
"example": "AFPF0562"
},
"sinalSqlCode": {
"type": "string",
"description": "Sinal relacionado ao sql code",
"example": "+"
},
"numSeqErro": {
"type": "string",
"description": "Numero do erro sequencial",
"example": "13"
},
"sqlCode": {
"type": "string",
"description": "Código de erro do sql",
"example": "0100"
}
}
},
"ErroGenerico": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "500"
},
"message": {
"type": "string",
"example": "Erro inesperado."
},
"description": {
"type": "string",
"example": "N/A."
},
"requestStatusId": {
"type": "string",
"format": "uuid",
"example": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
}
},
"ErroAnaliseDados": {
"type": "object",
"properties": {
"requestStatus": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "500"
},
"message": {
"type": "string",
"example": "Ocorreu uma falha durante a análise dos dados"
},
"description": {
"type": "string",
"example": "MENSAGEM CONTENDO A CRÍTICA NomePrograma: AFPF0562 SinalSQLCode: + NumSQLCode: 13 SQLCode: 0100"
},
"requestStatusId": {
"type": "string",
"format": "uuid",
"example": "1f47a4bc-47c0-4327-b3a3-ebfe55523f2a"
}
}
}
}
},
"HealthCheckSeguro": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InfoSeguro",
"description": "Informações sobre o Health Check da API"
}
}
},
"HealthCheckProduto": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InfoProduto"
}
},
"description": "Informações sobre o Health Check da API"
},
"HealthCheckProposta": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InfoProposta"
}
},
"description": "Informações sobre o Health Check da API"
},
"HealthCheckPagamento": {
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InfoPagamento"
}
},
"description": "Informações sobre o Health Check da API"
},
"HealthCheckAnaliseComercial": {
"required": [
"info"
],
"type": "object",
"properties": {
"info": {
"$ref": "#/components/schemas/InfoAnaliseComercial"
}
},
"description": "Informações sobre o Health Check da API"
},
"InfoAnaliseComercial": {
"required": [
"re_parcerias",
"version"
],
"type": "object",
"properties": {
"re_parcerias": {
"type": "string",
"description": "Serviço",
"example": "Analise Comercial"
},
"version": {
"type": "string",
"description": "Versão",
"example": "2211231400"
},
"status": {
"type": "string",
"description": "Status",
"example": "UP"
}
},
"description": "Informações sobre a API"
},
"InfoSeguro": {
"type": "object",
"properties": {
"re_parcerias": {
"type": "string",
"example": "Seguro"
},
"version": {
"type": "string",
"example": "2211231400"
},
"status": {
"type": "string",
"example": "UP"
}
},
"description": "Informações sobre a API"
},
"InfoProduto": {
"type": "object",
"properties": {
"re_parcerias": {
"type": "string",
"example": "Produtos"
},
"version": {
"type": "string",
"example": "2211231400"
},
"status": {
"type": "string",
"example": "UP"
}
},
"description": "Informações sobre a API"
},
"InfoProposta": {
"type": "object",
"properties": {
"re_parcerias": {
"type": "string",
"example": "Proposta"
},
"version": {
"type": "string",
"example": "2211231400"
},
"status": {
"type": "string",
"example": "UP"
}
},
"description": "Informações sobre a API"
},
"InfoPagamento": {
"type": "object",
"properties": {
"re_parcerias": {
"type": "string",
"example": "Pagamento"
},
"version": {
"type": "string",
"example": "2211231400"
},
"status": {
"type": "string",
"example": "UP"
},
"operations": {
"$ref": "#/components/schemas/Operations"
}
},
"description": "Informações sobre a API"
},
"Operations": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"example": "AFND-Pagamento"
},
"status": {
"type": "string",
"example": "UP/DOWN"
}
}
}
}
}
}