{ "openapi": "3.0.1", "info": { "title": "API RE - Efetivação", "description": "Esta API oferece uma coleção de recursos para a integração com os parceiros Bradesco Seguros RE", "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.6" }, "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/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-pagamento-cobranca (formaPagamento)\n\n**bandeira** em v1/seguro/tabelas/dados-pagamento-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-pagamento-cobranca (formaPagamento)\n\n**tipoConta** em v1/seguro/tabelas/dados-pagamento-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": "" } } ] } ] } }, "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-pagamento-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 (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 (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": "" } }, "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": "" }, "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** 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": "17,50" } } }, "objetosSegurados": [ { "produto": { "id": "233", "canal": "43", "fase": "9", "idBloco": "1", "idCertificado": "", "idplano": "1", "numeroTituloCap": "", "inicioVigencia": "13/10/2024", "fimVigencia": "13/10/2025", "modalidade": { "tipoModalidade": "PRE-FORMATADO", "campoDisponivel": "", "valorPremioTotal": "", "valorPrimeiraParcelaPaga": "", "quantidadeParcelasProposta": "", "valorDemaisParcelasNegociavel": "", "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": "17,50" } } }, "objetosSegurados": [ { "produto": { "id": "237", "canal": "44", "fase": "9", "idBloco": "1", "idCertificado": "", "idplano": "1", "numeroTituloCap": "", "inicioVigencia": "03/12/2024", "fimVigencia": "07/11/2029", "modalidade": { "tipoModalidade": "PRE-FORMATADO", "campoDisponivel": "", "valorPremioTotal": "", "valorPrimeiraParcelaPaga": "", "quantidadeParcelasProposta": "", "valorDemaisParcelasNegociavel": "", "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": "17,50" } } }, "objetosSegurados": [ { "produto": { "id": "237", "canal": "44", "fase": "9", "idBloco": "1", "idCertificado": "", "idplano": "1", "numeroTituloCap": "", "inicioVigencia": "03/12/2024", "fimVigencia": "07/11/2029", "modalidade": { "tipoModalidade": "PRE-FORMATADO", "campoDisponivel": "", "valorPremioTotal": "", "valorPrimeiraParcelaPaga": "", "quantidadeParcelasProposta": "", "valorDemaisParcelasNegociavel": "", "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": "17,50" } }, "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", "idCertificado": "", "idplano": "1", "numeroTituloCap": "", "inicioVigencia": "03/12/2024", "fimVigencia": "07/11/2029", "modalidade": { "tipoModalidade": "PRE-FORMATADO", "campoDisponivel": "", "valorPremioTotal": "", "valorPrimeiraParcelaPaga": "", "quantidadeParcelasProposta": "", "valorDemaisParcelasNegociavel": "", "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": "17,50" } }, "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", "idCertificado": "", "idplano": "1", "numeroTituloCap": "", "inicioVigencia": "03/12/2024", "fimVigencia": "07/11/2029", "modalidade": { "tipoModalidade": "PRE-FORMATADO", "campoDisponivel": "", "valorPremioTotal": "", "valorPrimeiraParcelaPaga": "", "quantidadeParcelasProposta": "", "valorDemaisParcelasNegociavel": "", "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/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/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/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 - Cancelamento" ], "summary": "Cancelamento de proposta", "description": "Efetua o cancelamento de uma propostas de parceiros com produtos residenciais pre-formatados do Bradesco Seguros", "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" } } } }, "/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 request para impressao de papelaria.\n", "value": { "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/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" } } } }, "/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/HealthCheck" } } } }, "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" } } } } }, "components": { "schemas": { "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", "codigoInterno", "codigoRamo", "dataControle", "dataEmissao", "dataVencimento", "finalVigencia", "idCertificado", "inicioVigencia", "numeroProposta" ], "type": "object", "properties": { "RequestStatus": { "$ref": "#/components/schemas/RequestStatus" }, "codigoInterno": { "type": "string", "description": "Código interno", "example": "3686647" }, "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" }, "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": "15684242" }, "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" }, "HealthCheck": { "type": "object", "properties": { "info": { "$ref": "#/components/schemas/Info" } }, "description": "Informações sobre o Health Check da API" }, "Info": { "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" }, "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" }, "objetoResidencia": { "type": "string", "description": "Tipo de objeto da residência", "example": "1" }, "tipoResidencia": { "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", "objetoResidencia", "tipoResidencia" ], "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" }, "objetoResidencia": { "type": "string", "description": "Tipo de objeto da residência", "example": "1" }, "tipoResidencia": { "type": "string", "description": "Tipo da Residência(C - Casa, A - Apartamento, R - Residência)", "example": "A" } }, "description": "Informações do objetoRisco na contratacao de um seguro" }, "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 negociavel" }, "camposDisponiveis": { "type": "string", "description": "Campos Disponiveis", "example": "valor em string" }, "valorPremioTotal": { "type": "string", "description": "Valor do premio total", "example": "1" }, "valorPrimeiraParcelaPaga": { "type": "string", "description": "Valor da primeira parcela paga", "example": "1" }, "quantidadeParcelasProposta": { "type": "string", "description": "Quantidade de parcelas da proposta", "example": "1" }, "valorDemaisParcelasNegociavel": { "type": "string", "description": "Valor Demais parcelas quando produto calculados (negociáveis) Total", "example": "1" }, "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" }, "idCertificado": { "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" } }, "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" }, "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" }, "HealthCheckProposta": { "type": "object", "properties": { "info": { "$ref": "#/components/schemas/InfoProposta" } }, "description": "Informações sobre o Health Check da API" } } } }