Logo da Sancor Seguros
API docs by Redocly

Gestão de API's Sancor Brasil (v2.10.3)

Download OpenAPI specification:

Conjunto de APIs que permitem a integração com serviços Sancor Brasil

APIs Compartilhadas

Este agrupamento descreve as APIs que os diferentes módulos do Sistema de Gestão compartilham no processo de geração de uma cotação, proposta e apólice. Com as APIs Compartilhadas, é possível realizar consultas, cadastrar pessoas, inserir follow-ups, imprimir documentos e boletos.

Consultar Apólice

Realiza a consulta de apólices. A requisição permite consultar apólices informando seu número diretamente, por corretor, data de emissão, segurado, ramo ou produto.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a lista de apólices, ou mensagem de erro para ajuste na requisição.

Para consultar apólices, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_pessoa_corretora
required
number
Example: id_pessoa_corretora=1122

Código de identificação do corretor desejado no sistema.

dt_emissao_inicio
required
string
Example: dt_emissao_inicio=2025-01-01 00:00:00

Filtro de data inicial por data de emissão da apólice.

dt_emissao_fim
required
string
Example: dt_emissao_fim=2025-07-31 23:59:00

Filtro de data final por data de emissão da apólice.

cd_grupo_ramo
number
Example: cd_grupo_ramo=1

Código de identificação do grupo do ramo no sistema.

nr_ramo
number
Example: nr_ramo=14

Número do ramo desejado.

cd_apolice
number
Example: cd_apolice=1011401000569

Número da apólice desejada.

cd_proposta
number
Example: cd_proposta=1217

Número da proposta da apólice.

nr_produto
number
Example: nr_produto=1141

Número do produto desejado.

nr_cpf_cnpj_segurado
number
Example: nr_cpf_cnpj_segurado=91133518001

CPF ou CNPJ do segurado.

cd_tipo_pessoa_segurado
number
Example: cd_tipo_pessoa_segurado=1

Código de identificação do tipo de pessoa do segurado.
Informe o valor “1” para Pessoa Física.
Informe o valor “2” para Pessoa Jurídica.
Informe o valor “3” para Órgão Público.

cd_usuario_venda
string
Example: cd_usuario_venda=4340

Código do usuário de venda do corretor.

fl_apolice_cancelada
boolean

Informe true ou false para que a requisição busque apenas apólices com status cancelada.
Informe o valor true para buscar por apólices canceladas.
Remova o campo da requisição ou informe o valor false para buscar apólice com qualquer status.

offset
number
Example: offset=0

Elimina as primeiras apólices listadas na resposta da requisição.
Exemplo: Caso informe o valor “2”, as 2 primeiras apólices que seriam listadas na resposta são ocultadas.

limit
number
Example: limit=20

Determina um número máximo de apólices a serem listadas na resposta.
Exemplo: Caso informe o valor “10”, a resposta da requisição irá listar no máximo 10 apólices.

orderby
string
Example: orderby=cd_apolice desc

Ordena as apólices listadas pelo campo desejado.
A ordenação pode ser realizada através dos seguintes campos: dt_emissao, id_pessoa, cd_grp_ramo, nr_ramo, cd_apolice, cd_proposta, nr_produto, cd_tp_pessoa, cd_usuario, cd_status.
A ordenação pode ser feita de forma decrescente adicionando “desc” a frente do campo desejado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Apolice": [
    ]
}

Consultar Fatura Unificada Gerada

Realiza a consulta de faturas unificadas que já foram geradas para pagamento.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a lista de faturas unificadas do responsável financeiro.

Para consultar a fatura unificada gerada, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
id_pessoa
required
number
Example: id_pessoa=98765

Código de identificação da pessoa com papel de responsável financeiro.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "fatura": [
    ]
}

Consultar Fatura Unificada Pendente

Realiza a consulta de faturas unificadas que estão pendentes de serem geradas para pagamento.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a lista de faturas unificadas pendentes de serem geradas do responsável financeiro.

Para consultar a fatura unificada pendente, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
id_pessoa
required
number
Example: id_pessoa=98765

Código de identificação da pessoa com papel de responsável financeiro.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "fatura_pendente": [
    ]
}

Consultar Opções de Parcelamento da Proposta

Realiza a consulta das opções de parcelamento de pagamento da proposta disponíveis para o produto.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as opções de parcelamento disponíveis para o produto.

Para consultar as opções de parcelamento, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

query Parameters
cd_proposta
required
number
Example: cd_proposta=123456

Número da proposta desejada.

cd_produto
required
number
Example: cd_produto=1141

Código de identificação do produto no sistema.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Parcelamentos": [
    ]
}

Consultar Produto

Exibe os dados do produto desejado. É necessário informar obrigatoriamente apenas 1 dos parâmetros disponíveis para a consulta.

O parâmetro “nm_produto” funciona como uma pesquisa de produtos, a ser utilizado quando o usuário não souber identificar o nome completo do produto ou o número do produto. Ao informar parte do nome do produto no parâmetro “nm_produto”, a resposta da consulta produto irá listar todos os produtos encontrados no Sistema de Gestão que possuem o texto pesquisado no nome, exemplo: Ao informar a palavra “Riscos” a resposta da consulta produto listará todos os produtos que possuem a palavra Riscos no nome.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do produto. Caso houver erro na chamada, será retornado o status 200 e apresentará na resposta uma mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, podem ser utilizados os seguintes parâmetros listados abaixo.

query Parameters
nr_produto
string
Example: nr_produto=10114

Número de identificação do produto.

nm_produto
string
Example: nm_produto=Garantia Setor Público

Nome do produto. Aceita o nome completo ou parte do nome para realizar a consulta.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaProdutoDetalhe": [
    ]
}

Consultar Franquia da Cobertura

Realiza a consulta das franquias configuradas na cobertura de um produto. A requisição não obriga o preenchimento de nenhum campo da requisição para obter a resposta, neste caso, será exibido todas as franquias de coberturas existentes para os produtos.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as franquias configuradas na cobertura.

Para consultar a franquia da cobertura, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
cd_produto
required
string
Example: cd_produto=1141

Código de identificação do produto no sistema.

nr_cobertura
required
string
Example: nr_cobertura=2001

Número da cobertura do produto desejada.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Franquias": [
    ]
}

Consultar Proposta

Realiza a consulta de propostas. A requisição permite consultar propostas informando seu número diretamente, por corretor, data de inclusão, segurado ou produto.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a lista de propostas.

Para consultar propostas, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
cd_proposta
number
Example: cd_proposta=123456789

Número da proposta desejada.

cd_produto
number
Example: cd_produto=1141

Código de identificação do produto desejado.

nr_produto
number
Example: nr_produto=14

Número do produto desejado.

nr_cnpj_cpf_segurado
string
Example: nr_cnpj_cpf_segurado=12345678901

CPF ou CNPJ do segurado.

nr_cnpj_cpf_corretor
string
Example: nr_cnpj_cpf_corretor=98765432000112

CPF ou CNPJ do corretor.

dt_inicial
string
Example: dt_inicial=2025-01-01T00:00:00

Filtro de data inicial por data de inclusão da proposta.

dt_final
string
Example: dt_final=2025-12-31T23:59:59

Filtro de data final por data de inclusão da proposta.

cd_usuario_venda
string
Example: cd_usuario_venda=USR12345

Código do usuário de venda do corretor.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "nr_cnpj_cpf_segurado": "12345678901",
  • "Proposta": [
    ]
}

Inserir Follow-Up

Realiza a inserção de follow-ups a nível de proposta/apólice e a nível de endosso. Caso o campo “id_endosso” não for informado, o follow-up será inserido a nível de proposta/apólice. Se informado o campo “id_endosso”, o follow-up será inserido no endosso.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do follow-up inserido. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro.

Para inserir o follow-up, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_usuario_inclusao
required
string

Código de identificação do usuário a incluir follow-up.

cd_usuario_destinatario
required
string

Código de identificação do usuário a receber e-mail do follow-up adicionado.

id_apolice
required
number

Código de identificação da apólice.

id_endosso
required
number

Código de identificação do endosso. Caso informado, insere follow-up no endosso. Se não informado, follow-up é inserido a nível de proposta/apólice.

id_tp_followup
required
string

Código de identificação do tipo de follow-up.

ds_followup
required
string

Descrição de livre digitação do follow-up.

Responses

Request samples

Content type
application/json
{
  • "cd_usuario_inclusao": "USR123",
  • "cd_usuario_destinatario": "USR456",
  • "id_apolice": 1001,
  • "id_endosso": 2002,
  • "id_tp_followup": 1,
  • "ds_followup": "Inserção de follow-up."
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "wsp_response_status": 200,
  • "wsp_id": 50,
  • "cd_usuario_inclusao": "4340",
  • "cd_usuario_destinatario": "4341",
  • "nm_email_destinatario": "62E5T0BF-0B0B-45F6-ABDA-EAGTGAS1234C7E3",
  • "id_apolice": 1560,
  • "id_endosso": 1482,
  • "id_followup": 50,
  • "dt_followup": "2025-09-03T16:22:42.917"
}

Consultar Follow-Up

Realiza a busca do follow-up por nível de proposta/apólice ou endosso. Apenas o parâmetro “id_apolice” é obrigatório.

Caso for informado somente o parâmetro “id_apolice”, a requisição irá listar follow-ups a nível de proposta/apólice. Se os parâmetros “id_apolice” e “id_endosso” forem informados, então a requisição listará os follow-ups a nível de endosso.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do follow-up. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta o código e a mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, podem ser utilizados os seguintes parâmetros listados abaixo.

query Parameters
cd_usuario_inclusao
string <= 60 characters
Example: cd_usuario_inclusao=USR12345

Código de identificação do usuário a incluir follow-up. O parâmetro é opcional.

cd_usuario_destinatario
string <= 60 characters
Example: cd_usuario_destinatario=DEST56789

Código de identificação do usuário a receber e-mail do follow-up adicionado. O parâmetro é opcional.

id_apolice
required
number
Example: id_apolice=123456

Código de identificação da proposta/apólice. O parâmetro é obrigatório. Caso for informado somente este parâmetro, sem informar o parâmetro “id_endosso”, a requisição irá listar follow-ups a nível de proposta/apólice.

id_endosso
number
Example: id_endosso=7890

Código de identificação do endosso. O parâmetro é opcional. Se informado, a requisição listará os follow-ups a nível de endosso.

id_followup
number
Example: id_followup=1011

Código de identificação do follow-up desejado para consulta. O parâmetro é opcional.

id_tp_followup
number
Example: id_tp_followup=2

Código de identificação do tipo de follow-up. O parâmetro é opcional.

ds_followup
string
Example: ds_followup=Contato realizado com o cliente sobre pendências.

Descrição do follow-up desejado para consulta. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "wsp_response_status": 200,
  • "ConsultarFollowUp": [
    ]
}

Imprimir Boleto da Fatura Unificada Gerada

Realiza a impressão do boleto da fatura unificada já gerada para pagamento.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o código Base64 da impressão do boleto.

Para imprimir o boleto da fatura unificada gerada, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
id_parcela
required
number
Example: id_parcela=11074

Código de identificação da parcela da fatura unificada gerada.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_parcela_movimentacao": 12345,
  • "id_parcela": 11074,
  • "ImprimirBoletoUnificado": {
    }
}

Impressão de Formulários

Realiza a busca dos formulários de impressão de Proposta, Apólice e Boleto Bancário.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o formulário solicitado no formato Base64. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro.

Para buscar o formulário de impressão desejado, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

query Parameters
id_endosso
required
number
Example: id_endosso=123456

Código de identificação do endosso

id_tp_dominio_impressao
required
string (PortalV6_Impressao_TpDominioEnum)
Enum: 1 3 5
Example: id_tp_dominio_impressao=1

Código de identificação do tipo de domínio de impressão.
1 = Apólice
3 = Proposta
5 = Cobrança

id_item
number
Example: id_item=78901

Código de identificação do item segurado

id_formulario
string (PortalV6_Impressao_FormularioEnum)
Enum: 20 1000311 1000312 1000318 1000319 1000362 1000363 1000365 1000348 1000347 1000373 1000357 1000356
Example: id_formulario=1000319

Código de identificação do formulário.
20 = Ficha de Compensação - Carnê
1000311 = Formulário de Apólice - Rural
1000312 = Formulário de Proposta - Rural
1000318 = Formulário de Proposta - SVI
1000319 = Formulário de Apólice - SVI
1000362 = Formulário de Apólice - Compreensivo
1000363 = Formulário de Proposta - Compreensivo
1000365 = Formulário de Cotação - Risco de Engenharia
1000348 = Formulário de Proposta - Risco de Engenharia
1000347 = Formulário de Apólice - Risco de Engenharia
1000373 = Formulário de Cotação - Equipamentos
1000357 = Formulário de Proposta - Equipamentos
1000356 = Formulário de Apólice - Equipamentos

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 12345,
  • "id_relatorio": 67890,
  • "id_apolice": 54321,
  • "id_endosso_item_vida": 11111,
  • "id_item": 22222,
  • "Relatorio": {
    }
}

Buscar CEP

Esta requisição realiza a busca dos dados do endereço através do CEP informado. A busca deve ser realizada utilizando o parâmetro “nr_cep”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados endereço. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro.

Para a busca do CEP é informado no cabeçalho da requisição o valor da variável “Authorization”, e informar o seguinte parâmetro listado abaixo.

query Parameters
nr_cep
required
Array of numbers
Example: nr_cep=12345678

CEP do endereço para consulta. O parâmetro é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Enderecos": [
    ]
}

Consulta de Domínios

Esta requisição realiza a consulta dos domínios do módulo Cadastros do Sistema de Gestão. Os domínios retornados são: Papel, gênero, profissão, tipo de pessoa, faixa salarial, estado civil, país, regime de bens, tipo de documento, órgão emissor, local de expedição do documento, esportes radicais, tipo de estabelecimento, ramo de atividade, tipo de endereço, tipo de meio de comunicação e cidade.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os domínios. Caso houver erro na chamada, será retornado o status 200 e apresentará a mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, pode ser informado o parâmetro conforme domínio abaixo.

query Parameters
nm_dominio
string
Example: nm_dominio=EsporteRadical

Nome do domínio a ser buscado. O parâmetro é opcional, se não informado, será listado todos os domínios.
Pode ser informado os seguintes valores:
Papel
Sexo
Profissao
TipoPessoa
FaixaSalarial
EstadoCivil
Pais
RegimeBens
TipoDocumento
OrgaoEmissor
LocalExpedicaoDocumento
EsporteRadical
TipoEstabelecimento
RamoAtividade
TipoEndereco
TipoMeioComunicacao
Cidade

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Dominios": [
    ]
}

Consultar Configuração do Grupo de Corretor por Produto

Exibe os dados de configuração do grupo de corretor por produto desejado. Para realizar a consulta é necessário informar obrigatoriamente apenas 1 dos parâmetros disponíveis para a consulta.

A requisição exibe as seguintes configurações de corretores por produto: Comissão de Agenciamento, Comissão de Corretagem, Comissão de Pró-Labore, Agravo, Lucro, Desconto e Despesas Administrativas.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de configuração do grupo corretor por produto. Caso houver erro na chamada ou não for encontrada uma configuração, será retornado o status 400 e apresentará na resposta uma mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, podem ser utilizados os seguintes parâmetros listados abaixo.

query Parameters
id_tp_carregamento
string (WSModuloCad_ConsultaCarregamentoTpCarregamentoEnum)
Enum: 1 2 3 4 5 6 7
Example: id_tp_carregamento=1

Código de identificação do tipo de configuração.
Possível informar os seguintes códigos:
1 = Comissão de Agenciamento
2 = Agravo
3 = Comissão de Corretagem
4 = Despesas Administrativas
5 = Comissão de Pró-Labore
6 = Lucro
7 = Desconto

nm_tipo_carregamento
string (WSModuloCad_ConsultaCarregamentoNmTipoEnum)
Enum: "Agenciamento" "Agravo" "Comissão" "D.A" "Pró-Labore" "Lucro" "Desconto"
Example: nm_tipo_carregamento=Agenciamento

Nome do tipo de configuração, listados abaixo:
Agenciamento
Agravo
Comissão
D.A
Pró-Labore
Lucro
Desconto

id_pessoa_corretor
number
Example: id_pessoa_corretor=123456

Código de identificação do corretor no sistema.

nr_cnpj_cpf
string
Example: nr_cnpj_cpf=12345678901.00

CPF ou CNPJ do corretor.

cd_produto
number
Example: cd_produto=98765

Código de identificação do produto no sistema.

Responses

Response samples

Content type
application/json
{
  • "id_grp_corretores": 10,
  • "nm_grp_corretores": "Grupo XPTO",
  • "Corretores": [
    ],
  • "Produtos": [
    ]
}

Consultar Usuário do Corretor

Exibe os usuários do corretor desejado. A requisição possui apenas o parâmetro “cd_usuario”, sendo de preenchimento obrigatório.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do usuário, do corretor e do grupo corretor. Caso houver erro na chamada, será retornado o status 400 e apresentará na resposta uma mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, deve ser informado o parâmetro listado abaixo.

query Parameters
cd_usuario
string
Example: cd_usuario=USR12345

Login do usuário do corretor. O parâmetro é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "DadosUsuario": {
    },
  • "DadosCorretor": [
    ],
  • "GruposCorretores": [
    ]
}

Listar Estados

Esta API realiza a busca das informações das unidades federativas no sistema. A requisição pode ser enviada vazia, neste caso será listado todos os estados cadastrados.

Para listar os estados além de possuir o token de acesso, o usuário pode informar os seguintes campos listados na tabela abaixo.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do estado desejado. Exemplo de chamada da requisição de estado abaixo.

query Parameters
cd_uf
number
Example: cd_uf=35

Código de identificação do estado no sistema. Campo é opcional.

nm_uf
string
Example: nm_uf=SP

Sigla do estado. Campo é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EstadoLocal": [
    ]
}

Consultar Corretor

Busca as informações do corretor desejado no sistema. A requisição pode ser enviada informando apenas 1 dos campos.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do corretor desejado, ou, será exibido mensagem de validação por valores incorretos na requisição.

Para buscar o corretor, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
idPessoa
number
Example: idPessoa=123456

Código de identificação do corretor no sistema.

nmPessoa
string <= 150 characters
Example: nmPessoa=GXHUB SOLUCOES DIGITAIS LTDA

Nome do corretor.

nrCnpjCpf
number
Example: nrCnpjCpf=12345678000195

CNPJ ou CPF do corretor.

Responses

Response samples

Content type
application/json
{
  • "cdRetorno": 0,
  • "nmRetorno": "Consulta realizada com sucesso",
  • "idPessoa": 24289,
  • "nmPessoa": "GXHUB SOLUCOES DIGITAIS LTDA",
  • "cdTipoPessoa": 2,
  • "nrCnpjCpf": 12345678000195,
  • "cdCorretor": "CORR123",
  • "idTpCorretor": 1,
  • "nrFilial": "00001",
  • "cdFilial": 10,
  • "cdSusep": "12345678901234",
  • "cdSusepRe": "98765432101234567890",
  • "flAtivo": true,
  • "endereco": {
    },
  • "telefoneTable1": [
    ],
  • "emailTable1": [
    ],
  • "configuracaoProduto": [
    ]
}

Incluir ou Alterar Pessoa

Esta requisição permite inserir ou alterar um cadastro de pessoa física ou jurídica. Caso o CPF/CNPJ informado já exista, a requisição irá alterar o cadastro da pessoa com as novas informações. Se o CPF/CNPJ informado não existir, a requisição irá incluir uma nova pessoa.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a pessoa inserida ou alterada. Caso houver erro na chamada, será retornado o status 200 e apresentará na resposta a mensagem de erro.

Para inserir ou alterar a pessoa desejada, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
Array
nm_pessoa
string <= 150 characters

Nome da pessoa física ou Razão Social da pessoa jurídica.

nm_pessoa_social
string <= 150 characters

Nome social da pessoa física.

cd_tipo_pessoa
number
Enum: 1 2 3

Código de identificação da pessoa.
1 = Física 2 = Jurídica 3 = Órgão Público

nr_cnpj_cpf
required
number

CPF ou CNPJ da pessoa. Este campo é a chave para identificar se a pessoa será inserida ou alterada no sistema.

dv_ativo
boolean

Ativa o cadastro da pessoa. Deve ser true ou false. Caso informado true, o cadastro ficará ativo.

dt_nascimento
string <date-time>

Data de nascimento da pessoa física.

id_sexo
number

Código de identificação do gênero da pessoa física.
Verificar código na API de Consulta de Domínios.

id_estado_civil
number

Código de identificação do estado civil da pessoa física.
Verificar código na API de Consulta de Domínios.

nr_rg
string <= 15 characters

Número do RG da pessoa física.

dt_emissao_rg
string <date-time>

Data de emissão do RG.

nm_orgao_emissor_rg
string <= 30 characters

Órgão emissor do RG.

nm_local_exp_rg
string <= 15 characters

Local de expedição do RG.

cd_esporte
number

Código de identificação do esporte praticado pela pessoa física.
Verificar código na API de Consulta de Domínios.

nr_cnh
string <= 20 characters

Número da CNH da pessoa física.

dt_validade_cnh
string <date-time>

Data de validade da CNH.

nm_categoria_cnh
string <= 2 characters

Categoria da CNH.

nr_reg_condutor
string <= 20 characters

Número de registro do condutor.

id_regime_bens
number

Código de identificação de regime de bens da pessoa física.
Verificar código na API de Consulta de Domínios.

cd_pais_residencia
number

Código de identificação do país que reside a pessoa física.
Verificar código na API de Consulta de Domínios.

cd_pais_nacionalidade
number

Código de identificação da nacionalidade da pessoa física.
Verificar código na API de Consulta de Domínios.

cd_faixa_salarial
number

Código de identificação da Faixa Salarial da pessoa física.
Verificar código na API de Consulta de Domínios.

nr_passaporte
string <= 20 characters

Número do Passaporte da pessoa física.

nm_naturalidade
string <= 50 characters

Nome da naturalidade da pessoa física.

dt_primeira_cnh
string <date-time>

Data de emissão da primeira CNH.

cd_tp_escolaridade
number

Código de identificação da escolaridade da pessoa física. A ser disponibilizado pela Sancor.

nm_pai
string <= 100 characters

Nome do pai da pessoa física.

nm_mae
string <= 100 characters

Nome da mãe da pessoa física.

nm_inscr_estadual
string <= 20 characters

Número da Inscrição Estadual da pessoa jurídica.

nm_fantasia
string <= 90 characters

Nome fantasia da pessoa jurídica.

id_ramo_atividade
number

Código de identificação do ramo de atividade da pessoa jurídica. A ser disponibilizado pela Sancor.

cd_tp_empresa
number

Código de identificação do tipo de empresa. A ser disponibilizado pela Sancor.

nm_inscr_municipal
string <= 20 characters

Número da Inscrição Municipal da pessoa jurídica.

dv_pessoa_politicamente_exposta
boolean

Pessoa Politicamente exposta. Deve ser true ou false. Se informado true pessoa física será considerada politicamente exposta.

Array of objects (CadastroPessoaUnificado_PessoaInserirAlterarV8EnderecoDto)
Array of objects (CadastroPessoaUnificado_PessoaInserirAlterarV8PapelDto)
Array of objects (CadastroPessoaUnificado_PessoaInserirAlterarV8ContaCorrenteDto)
Array of objects (CadastroPessoaUnificado_PessoaInserirAlterarV8MeioComunicacaoDto)
Array of objects (CadastroPessoaUnificado_PessoaInserirAlterarV8SocioProprietarioDto)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Pesquisar Pessoa

A requisição realiza a pesquisa da pessoa física ou jurídica cadastrada no sistema. É necessário informar obrigatoriamente apenas 1 dos campos para realizar a busca: “id_pessoa”, “nm_pessoa”, “nm_pessoa_social” ou “nr_cnpj_cpf”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da pessoa pesquisada. Caso houver erro na chamada, será retornado o status 200 e apresentará na resposta a mensagem de erro.

Para realizar a pesquisa de pessoa, além do Token de acesso, a requisição possui os seguintes campos descritos abaixo.

query Parameters
id_pessoa
number
Example: id_pessoa=123

Código de identificação da pessoa no sistema.

nm_pessoa
string <= 150 characters
Example: nm_pessoa=JOAO DA SILVA

Nome da pessoa física ou jurídica.

nm_pessoa_social
string <= 150 characters
Example: nm_pessoa_social=JOAO SILVA

Nome social da pessoa física.

cd_tipo_pessoa
number
Enum: 1 2 3
Example: cd_tipo_pessoa=1

Código de identificação da pessoa.
1 = Física
2 = Jurídica
3 = Órgão Público

cd_papel
number
Example: cd_papel=10

Código de identificação do papel.
Verificar código na API de Consultar Domínios.

nr_cnpj_cpf
string <= 20 characters
Example: nr_cnpj_cpf=12345678901

CPF ou CNPJ da pessoa.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_pessoa": 0,
  • "pessoa": [
    ]
}

Consultar Papéis Vinculados à Pessoa

A requisição realiza a pesquisa dos dados de uma pessoa por papel cadastrado no sistema de gestão. Para realizar a consulta é necessário informar obrigatoriamente apenas 1 dos campos: “nr_cnpj_cpf” ou “id_pessoa_erp”.

Também é possível consultar a pessoa informando o campo opcional “cd_papel”. Neste caso, a requisição retornará apenas os dados correspondentes ao papel informado ou, caso a pessoa não possua o papel, a resposta da consulta indicará que o papel não está associado ao cadastro da pessoa.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da pessoa por papel. Caso houver erro na chamada, será retornado o status 200 e apresentará na resposta a mensagem de validação.

Para realizar a pesquisa de papéis da pessoa, além do Token de acesso, a requisição possui os seguintes campos descritos abaixo.

query Parameters
nr_cnpj_cpf
string
Example: nr_cnpj_cpf=12345678901

CPF ou CNPJ da pessoa. Campo é obrigatório caso “id_pessoa_erp” não seja informado.

cd_papel
number
Example: cd_papel=1

Código de identificação do papel. Campo é opcional, caso informado, listará apenas o papel desejado. Verificar código na API Consulta de Domínios.

id_pessoa_erp
number
Example: id_pessoa_erp=12345

Código de identificação da pessoa no sistema. Campo é obrigatório caso “nr_cnpj_cpf” não seja informado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_papel": 1,
  • "id_pessoa": 98765,
  • "ConsultaPessoas": [
    ]
}

Consultar Formas de Pagamento do Produto

Exibe os dados do produto desejado. Para realizar a consulta de produto é necessário informar obrigatoriamente apenas 1 dos parâmetros disponíveis para a consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do produto. Caso houver erro na chamada, será retornado o status 200 e apresentará na resposta uma mensagem de erro.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”. Na url da requisição, podem ser utilizados os seguintes parâmetros listados abaixo.

query Parameters
nr_produto
string
Example: nr_produto=11

Número de identificação do produto.

cd_produto
number
Example: cd_produto=137

Código de identificação do produto no sistema.

nm_produto
string
Example: nm_produto=MULTIRRISCO PLUS VERÃO SANCOR UNICOOB

Nome do produto.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaProdutoDetalhe": [
    ]
}

Cadastro Corretor Unificado

Consulta status

Consulta o status do registro do cadastro do corretor associado ao protocolo fornecido

Authorizations:
requestAuthorizer
path Parameters
protocol
required
string

UUID da solicitação de cadastro do corretor

Responses

Response samples

Content type
application/json
{
  • "protocol": "string",
  • "status": "ACEITO",
  • "timestamp": "string"
}

Cadastro Corretor Unificado

Authorizations:
requestAuthorizer
Request Body schema: application/json
required
object (Cadastro de Corretora)

Dados para cadastro de uma corretora de seguros

required
Array of objects (Array de Sócios)

Array contendo os dados dos sócios da corretora

Responses

Request samples

Content type
application/json
{
  • "corretora": {
    },
  • "socios": [
    ]
}

Response samples

Content type
application/json
{
  • "protocol": "string"
}

Patrimonial

Neste documento é descrito o funcionamento das APIs do módulo Patrimonial que são utilizadas para incluir uma cotação, proposta e apólice no Sistema de Gestão, abrangendo todas as etapas do processo.

No fluxo abaixo é demonstrado as etapas para a emissão de uma apólice dos ramos Residencial, Empresarial e Condomínio vinculadas ao Sistema de Gestão.

Para visualizar o fluxo em outra aba, clique com o botão direito sobre a imagem e selecione “Abrir imagem em uma nova guia”.

Inserir Cotação

Realiza a inclusão de uma cotação dos ramos Residencial, Empresarial e Condomínio.

Para incluir a cotação, além de possuir o token de acesso, o usuário deve informar o código do produto, o código das coberturas, os dados do segurado e o corretor a ser utilizado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da cotação criada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

A requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_produto
required
number

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

cd_filial
required
number

Código de identificação da filial Sancor.
Buscar por “cd_filial” em Consultar Domínios Patrimonial.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
Buscar por “cd_tp_origem” em Consultar Domínios Patrimonial.

id_ramo
required
number

Código de identificação do ramo no sistema.
7 = Residencial
2 = Empresarial
22 = Condomínio

id_tp_seguro
required
number

Código de identificação do tipo de seguro.
Buscar por “id_tp_seguro” em Consultar Domínios Patrimonial.

id_des_experiencia
required
number

Código de identificação do tipo de desconto de experiencia a ser aplicado.
Buscar por “id_des_experiencia” em Consultar Domínios Patrimonial.

cd_apolice_anterior
required
string

Número da Apólice anterior do segurado. Informar somente quando o tipo de seguro for diferente de “Seguro Novo”.

required
object (WsEmpV13_EmpIncluirCotacao_Req_DadosSeguro)

Dados do seguro.

required
object (WsEmpV13_EmpIncluirCotacao_Req_DadosSegurado)

Dados do segurado.

required
object (WsEmpV13_EmpIncluirCotacao_Req_LocalRisco)

Dados do local de risco.

required
Array of objects (WsEmpV13_EmpIncluirCotacao_Req_Cobertura)

Coberturas da proposta.

required
Array of objects (WsEmpV13_EmpIncluirCotacao_Req_Questionario)

Questionário da proposta.

required
Array of objects (WsEmpV13_EmpIncluirCotacao_Req_DadosComissao)

Dados de comissão da proposta.

Responses

Request samples

Content type
application/json
{
  • "cd_produto": 0,
  • "cd_filial": 0,
  • "cd_tp_origem": 0,
  • "id_ramo": 0,
  • "id_tp_seguro": 0,
  • "id_des_experiencia": 0,
  • "cd_apolice_anterior": "string",
  • "DadosSeguro": {
    },
  • "DadosSegurado": {
    },
  • "LocalRisco": {
    },
  • "Coberturas": [
    ],
  • "Questionario": [
    ],
  • "DadosComissao": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_produto": 0,
  • "cd_proposta": 0,
  • "cd_tp_origem": 0,
  • "id_proposta_cotacao": 0,
  • "Retorno": [
    ]
}

Alterar Cotação

Realiza a alteração de uma cotação dos ramos Residencial, Empresarial e Condomínio.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação alterada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar uma cotação, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_proposta_cotacao
required
number

Código de identificação da cotação a ser alterada.

cd_produto
required
number

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

cd_filial
required
number

Código de identificação da filial Sancor.
Buscar por “cd_filial” em Consultar Domínios Patrimonial.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
Buscar por “cd_tp_origem” em Consultar Domínios Patrimonial.

id_ramo
required
number

Código de identificação do ramo no sistema.
7 = Residencial
2 = Empresarial
22 = Condomínio.

id_tp_seguro
required
number

Código de identificação do tipo de seguro.
Buscar por “id_tp_seguro” em Consultar Domínios Patrimonial.

id_des_experiencia
required
number

Código de identificação do tipo de desconto de experiência a ser aplicado.
Buscar por “id_des_experiencia” em Consultar Domínios Patrimonial.

cd_apolice_anterior
required
string

Número da Apólice anterior do segurado. Informar somente quando o tipo de seguro for diferente de “Seguro Novo”.

required
object (WsEmpV13_AlterarCotacao_Req_DadosSeguro)

Dados gerais do seguro.

required
object (WsEmpV13_AlterarCotacao_Req_DadosSegurado)

Dados do segurado e endereço base.

required
object (WsEmpV13_AlterarCotacao_Req_LocalRisco)

Dados do local de risco.

required
Array of objects (WsEmpV13_AlterarCotacao_Req_Cobertura)

Coberturas da proposta.

required
Array of objects (WsEmpV13_AlterarCotacao_Req_Questionario)

Questionário da proposta.

required
Array of objects (WsEmpV13_AlterarCotacao_Req_DadosComissao)

Informações de comissão/corretagem.

Responses

Request samples

Content type
application/json
{
  • "id_proposta_cotacao": 123456,
  • "cd_produto": 149,
  • "cd_filial": 2950,
  • "cd_tp_origem": 0,
  • "id_ramo": 2,
  • "id_tp_seguro": 1,
  • "id_des_experiencia": 0,
  • "cd_apolice_anterior": "101910000001234",
  • "DadosSeguro": {
    },
  • "DadosSegurado": {
    },
  • "LocalRisco": {
    },
  • "Coberturas": [
    ],
  • "Questionario": [
    ],
  • "DadosComissao": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_proposta": 0,
  • "EmpCotacao": [
    ]
}

Consultar Cotação

Realiza consulta de uma cotação, sendo obrigatório informar os campos “nr_cotacao” e “cd_produto”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação. Caso apresente erro, será retornado status 200 com a mensagem de erro para ajuste na requisição.

Para consultar uma cotação, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

query Parameters
nr_cotacao
required
number
Example: nr_cotacao=123456

Número da cotação a ser consultada. Campo é obrigatório.

cd_produto
required
number
Example: cd_produto=149

Código de identificação do produto no sistema. Campo é obrigatório.
Obter em Consultar Lista de Produtos.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "string",
  • "EmpConsultaCotacaoDetalhe": [
    ]
}

Consultar Lista de Cotações Resumida

Realiza consulta de uma lista de cotações apresentadas de forma resumida. Para obter os dados de uma cotação de forma detalhada utilizar a requisição Consultar Cotação.

A API exige que seja informado obrigatoriamente apenas um dos campos a seguir: “dt_final”, “dt_inicial”, “nr_cpf_cnpj_segurado” ou “nr_cotacao”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das cotações.

Para consultar uma cotação, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
dt_final
string
Example: dt_final=2025-10-29

Data final de inclusão da cotação.

dt_inicial
string
Example: dt_inicial=2025-10-01

Data inicial de inclusão da cotação.

cd_produto
string
Example: cd_produto=149

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

nr_cpf_cnpj_segurado
string
Example: nr_cpf_cnpj_segurado=12345678900

CPF/CNPJ do segurado.

nr_cotacao
string
Example: nr_cotacao=10011058

Número da cotação desejada.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaCotacaoSimplificada": [
    ]
}

Efetivar Cotação

Realiza a efetivação de uma cotação para uma proposta em digitação, sendo obrigatório informar o campo “id_proposta_cotacao”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso.

Para efetivar uma cotação, além de possuir o token de acesso, deve ser informado o seguinte campo listado abaixo.

Request Body schema: application/json
required
id_proposta_cotacao
required
number

Número da cotação a ser efetivada.
Campo é obrigatório.

Responses

Request samples

Content type
application/json
{
  • "id_proposta_cotacao": 123456
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta_cotacao": 0
}

Recusar Cotação ou Proposta Em Digitação

Realiza a recusa de uma cotação ou de uma proposta em digitação, sendo obrigatório informar o campo “id_proposta_cotacao”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Em caso de erro será retornado status 400 (erro) com a mensagem de validação.

Para recusar uma cotação ou proposta em digitação, além de possuir o token de acesso, deve ser informado o seguinte campo listado abaixo.

Request Body schema: application/json
required
id_proposta_cotacao
required
number

Número da cotação ou da proposta em digitação a ser recusada.
Campo é obrigatório.

cd_motivo
number

Código de identificação do motivo de recusa da cotação ou proposta em digitação.
6 = Motivos técnicos C01
7 = Motivos técnicos C02

Responses

Request samples

Content type
application/json
{
  • "id_proposta_cotacao": 123456,
  • "cd_motivo": 6
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpRecusarCotacaoPropostaWizard": [
    ]
}

Alterar Proposta Em Digitação

Realiza a alteração de uma proposta em digitação. A proposta em digitação é obtida após realizar a efetivação da cotação ou ao incluir uma proposta diretamente.

A alteração da proposta em digitação permite adicionar a forma de parcelamento e forma de pagamento a proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta em digitação alterada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar uma proposta em digitação, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_proposta_cotacao
required
number

Código de identificação da cotação a ser alterada.

cd_filial
required
number

Código de identificação da filial Sancor.
Buscar por “cd_filial” em Consultar Domínios Patrimonial.

id_ramo
required
number

Código de identificação do ramo no sistema.
7 = Residencial
2 = Empresarial
22 = Condomínio

id_tp_seguro
required
number

Código de identificação do tipo de seguro.
Buscar por “id_tp_seguro” em Consultar Domínios Patrimonial.

cd_apolice_anterior
required
string

Número da Apólice anterior do segurado. Informar somente quando o tipo de seguro for diferente de “Seguro Novo”.

required
object (WsEmpV13_AlterarPropostaWizard_Req_DadosSeguro)
required
object (WsEmpV13_AlterarPropostaWizard_Req_DadosSegurado)
required
object (WsEmpV13_AlterarPropostaWizard_Req_LocalRisco)
required
Array of objects (WsEmpV13_AlterarPropostaWizard_Req_Cobertura)
required
Array of objects (WsEmpV13_AlterarPropostaWizard_Req_Questionario)
required
Array of objects (WsEmpV13_AlterarPropostaWizard_Req_DadosComissao)
required
object (WsEmpV13_AlterarPropostaWizard_Req_DadosPagamento)

Responses

Request samples

Content type
application/json
{
  • "id_proposta_cotacao": 123456,
  • "cd_filial": 2950,
  • "id_ramo": 2,
  • "id_tp_seguro": 1,
  • "cd_apolice_anterior": "101910000001234",
  • "DadosSeguro": {
    },
  • "DadosSegurado": {
    },
  • "LocalRisco": {
    },
  • "Coberturas": [
    ],
  • "Questionario": [
    ],
  • "DadosComissao": [
    ],
  • "DadosPagamento": {
    }
}

Response samples

Content type
application/json
{
  • "cd_produto": 0,
  • "cd_proposta": 0,
  • "cd_tp_origem": 0,
  • "id_proposta_cotacao": 0,
  • "EmpAlterarPropostaWizard": [
    ]
}

Efetivar Proposta Em Digitação

Realiza a efetivação de uma proposta em digitação, sendo obrigatório informar o campo “id_proposta_cotacao”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da proposta efetivada.

Para efetivar uma proposta em digitação, além de possuir o token de acesso, deve ser informado o seguinte campo listado abaixo.

Request Body schema: application/json
required
id_proposta_cotacao
required
number

Número da proposta em digitação a ser efetivada.
Campo é obrigatório.

Responses

Request samples

Content type
application/json
{
  • "id_proposta_cotacao": 123456
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_proposta": "string",
  • "id_apolice": 0,
  • "id_endosso": 0,
  • "id_item": 0
}

Alterar Proposta Efetivada

Realiza a alteração de uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta efetivada alterada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar uma proposta efetivada, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_proposta
required
string

Número da proposta efetivada.

cd_produto
required
number

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

cd_filial
required
number

Código de identificação da filial Sancor.
Buscar por “cd_filial” em Consultar Domínios Patrimonial.

id_tp_seguro
number

Código de identificação do tipo de seguro.
Buscar por “id_tp_seguro” em Consultar Domínios Patrimonial.

id_des_experiencia
number

Código de identificação do tipo de desconto de experiencia a ser aplicado. Buscar por “id_des_experiencia” em Consultar Domínios Patrimonial.

cd_apolice_anterior
string

Número da Apólice anterior do segurado. Informar somente quando o tipo de seguro for diferente de “Seguro Novo”.

object (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaDadosSeguro)
object (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaDadosSegurado)
Array of objects (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaDadosRisco)
Array of objects (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaQuestionario)
Array of objects (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaDadosComissao)
object (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaDadosPagamento)
object (WsEmpV13_EmpAlterarProposta_Req_EmpAlterarPropostaInformacoesAdicionais)

Responses

Request samples

Content type
application/json
{
  • "cd_proposta": "101910000003398",
  • "cd_produto": 149,
  • "cd_filial": 2950,
  • "id_tp_seguro": 1,
  • "id_des_experiencia": 0,
  • "cd_apolice_anterior": "101910000001234",
  • "EmpAlterarPropostaDadosSeguro": {
    },
  • "EmpAlterarPropostaDadosSegurado": {
    },
  • "EmpAlterarPropostaDadosRisco": [
    ],
  • "EmpAlterarPropostaQuestionario": [
    ],
  • "EmpAlterarPropostaDadosComissao": [
    ],
  • "EmpAlterarPropostaDadosPagamento": {
    },
  • "EmpAlterarPropostaInformacoesAdicionais": {
    }
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 0
}

Incluir Local de Risco Em Uma Proposta Efetivada

Realiza a inclusão de um novo local de risco a uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do local de risco incluído. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para incluir um local de risco a uma proposta efetivada, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta efetivada.
Obter em Consultar Proposta Efetivada.

Array of objects (WsEmpV13_EmpIncluirItemProposta_Req_Item)

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 2,
  • "Item": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Item": [
    ]
}

Alterar Local de Risco Em Uma Proposta Efetivada

Realiza a alteração de um local de risco em uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do local de risco alterado. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar um local de risco de uma proposta efetivada, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta efetivada.
Obter em Consultar Proposta Efetivada.

required
Array of objects (WsEmpV13_EmpAlterarItemProposta_Req_Item)

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 2,
  • "Item": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Item": [
    ]
}

Excluir Local de Risco Em Uma Proposta Efetivada

Realiza a exclusão de um local de risco em uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para excluir um local de risco de uma proposta efetivada, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta efetivada.
Obter em Consultar Proposta Efetivada.

id_item
number

Código de identificação do item de local de risco a ser excluído.
Obter em Consultar Proposta Efetivada.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 2,
  • "id_item": 101
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Consultar Proposta Efetivada

Realiza a consulta de uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta efetivada. Caso apresente erro, será retornado status 200 com a mensagem de erro para ajuste na requisição.

Para consultar uma proposta efetivada, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_apolice
number
Example: id_apolice=1001801001459

Código de identificação da apólice da proposta efetivada.
A apólice ainda não foi emitida, porém o sistema já cria o código de identificação da apólice ao efetivar a proposta em digitação.
Campo é obrigatório quando “cd_produto” e “cd_proposta” não forem informados.

cd_produto
required
number
Example: cd_produto=149

Código de identificação do produto no sistema.
Campo é obrigatório quando “id_apolice” não for informado.
Obter em Consultar Lista de Produtos.

cd_proposta
required
string
Example: cd_proposta=1001800010082

Número da proposta efetivada.
Campo é obrigatório quando “id_apolice” não for informado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaPropostaDetalhe": [
    ]
}

Consultar Lista de Propostas Efetivadas Resumida

Realiza consulta de uma lista de propostas efetivadas apresentadas de forma resumida. Todos os campos são opcionais. Para obter os dados de uma proposta efetivada de forma detalhada utilizar a requisição Consultar Proposta Efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das propostas efetivadas.

Para consultar uma proposta efetivada, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
cd_produto
number
Example: cd_produto=149

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

cd_tp_origem
number
Example: cd_tp_origem=3

Código de identificação do tipo de origem da proposta efetivada.
Buscar por “cd_tp_origem” em Consultar Domínios Patrimonial.

cd_tp_apolice
number
Example: cd_tp_apolice=1

Código de identificação do tipo de apólice.
Buscar por “cd_tp_apolice” em Consultar Domínios Patrimonial.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaPropostaLista": [
    ]
}

Atualizar Status da Proposta Efetivada

Realiza a alteração do status de uma proposta efetivada, sendo possível também recusar a proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso alguma informação esteja incorreta, será retornada status 200 com a mensagem de validação do campo com a informação a ser ajustado.

Para atualizar o status uma proposta efetivada, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_proposta
required
number

Número da proposta efetivada desejada. Campo é obrigatório.

cd_produto
required
number

Código de identificação do produto no sistema. Campo é obrigatório.
Obter em Consultar Lista de Produtos.

cd_status
required
number
Enum: 208 603 604 607 608

Código de identificação do novo status da proposta efetivada. Campo é obrigatório.
208 = Pré Análise
603 = Cancelada
604 = Recusada
607 = Enviada para Subscrição
608 = Liberada para Emissão

id_motivo_recusa_proposta
number
Enum: 6 7

Código de identificação do motivo de recusa da proposta efetivada.
Informar o motivo de recusa apenas quando o campo “cd_status” possuir o valor “604 (Recusada)”.
6 = Motivos técnicos C01
7 = Motivos técnicos C02

Responses

Request samples

Content type
application/json
{
  • "cd_proposta": 1001800010082,
  • "cd_produto": 149,
  • "cd_status": 208,
  • "id_motivo_recusa_proposta": 6
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Calcular Prêmio da Proposta Efetivada

Realiza o cálculo do prêmio de uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o prêmio calculado.

Para calcular o prêmio de uma proposta efetivada, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta efetivada. O campo é obrigatório.
Obter em Consultar Proposta Efetivada.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 2
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpCalcularPremio": [
    ]
}

Emitir Apólice

Realiza a emissão da apólice patrimonial através de uma proposta efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da apólice emitida. Caso alguma informação esteja incorreta, será retornada status 200 com a mensagem de validação.

Para emitir uma apólice, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
id_apolice
required
number

Código de identificação da apólice da proposta efetivada. O campo é obrigatório.
Obter em Consultar Proposta Efetivada.

id_responsavel_venda
required
number

Código de identificação do usuário responsável pela venda. O campo é obrigatório.
Obter em APIs Compartilhadas | Consultar Usuário do Corretor.

Responses

Request samples

Content type
application/json
{
  • "id_apolice": 1001801001459,
  • "id_responsavel_venda": 100555541
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_apolice": "string",
  • "EmpGerarApolice": [
    ]
}

Consultar Apólice

Realiza a consulta de uma apólice. A requisição possui dois parâmetros, porém para realizar a consulta, é necessário informar apena um dos parâmetros: “id_apolice” ou “cd_apolice”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da apólice. Caso apresente erro, será retornado status 200 com a mensagem de erro para ajuste na requisição.

Para consultar uma apólice, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_apolice
number
Example: id_apolice=1001801001459

Código de identificação da apólice.
Campo é obrigatório quando “cd_apolice” não for informado.

cd_apolice
number
Example: cd_apolice=1001801001459

Número da apólice.
Campo é obrigatório quando “id_apolice” não for informado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaApoliceDetalhe": [
    ]
}

Consultar Lista de Apólices Resumida

Realiza consulta de uma lista de apólices do produto apresentadas de forma resumida. Para obter os dados de uma apólice de forma detalhada utilizar a requisição Consultar Apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das apólices.

Para consultar uma lista de apólices, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
cd_produto
required
number
Example: cd_produto=149

Código de identificação do produto no sistema. O campo é obrigatório.
Obter em Consultar Lista de Produtos.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaApoliceListaTable1": [
    ]
}

Consultar Lista de Produtos

Realiza consulta de uma lista de produtos, exibindo o código de identificação e o nome do produto no sistema de gestão.

A requisição não possui parâmetros, sendo necessário informar somente o token para acesso.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Produto": [
    ]
}

Consultar Produto

Realiza consulta do produto, exibindo todas as configurações contidas no produto.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o os dados do produto.

Para consultar um produto, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
cd_produto
required
number
Example: cd_produto=149

Código de identificação do produto no sistema.
Campo é obrigatório.
Obter em Consultar Lista de Produtos.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaProduto": [
    ]
}

Consultar Domínios Patrimonial

Esta requisição realiza a consulta dos domínios do módulo Patrimonial do Sistema de Gestão. Os domínios possíveis de serem consultados são: cd_filial, cd_tp_origem, cd_tp_apolice, cd_potencial_fechamento, cd_indicador, id_aceita_risco, id_periodo, cd_tipo_pessoa, cd_papel, id_sexo, cd_tp_imovel, cd_tp_atividade, cd_tp_construcao, cd_tp_ambito, id_tp_classificacao_imovel, id_tp_seguro, cd_motivo, id_des_experiencia e cd_tp_condominio.

A consulta exige que seja informado um dos domínios para retornar uma resposta. É permitido consultar somente um domínio por vez.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os cadastros do domínio consultado.

Para consultar domínios do ramo patrimonial, além de possuir o token de acesso, é necessário informar o seguinte campo listado abaixo.

query Parameters
cd_dominio
required
string
Enum: "cd_filial" "cd_tp_origem" "cd_tp_apolice" "cd_potencial_fechamento" "cd_indicador" "id_aceita_risco" "id_periodo" "cd_tipo_pessoa" "cd_papel" "id_sexo" "cd_tp_imovel" "cd_tp_atividade" "cd_tp_construcao" "cd_tp_ambito" "id_tp_classificacao_imovel" "id_tp_seguro" "cd_motivo" "id_des_experiencia" "cd_tp_condominio"
Example: cd_dominio=cd_tp_apolice

Nome do domínio a ser buscado.
Podem ser informados os seguintes domínios para consulta:
cd_filial, cd_tp_origem, cd_tp_apolice, cd_potencial_fechamento, cd_indicador, id_aceita_risco, id_periodo,
cd_tipo_pessoa, cd_papel, id_sexo, cd_tp_imovel, cd_tp_atividade, cd_tp_construcao, cd_tp_ambito,
id_tp_classificacao_imovel, id_tp_seguro, cd_motivo, id_des_experiencia, cd_tp_condominio.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaDominios": [
    ]
}

Consultar Ramo de Atividade

Esta requisição realiza a consulta dos ramos de atividade cadastrados no Sistema de Gestão. A consulta não possui parâmetros obrigatórios, caso nenhum campo seja informado, o sistema irá listar todos os ramos de atividade cadastrados.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o ramo de atividade desejado.

Para consultar um ramo de atividade, além de possuir o token de acesso, pode ser informado os seguintes campos listados abaixo.

query Parameters
id_ramo_atividade
number
Example: id_ramo_atividade=101

Código do ramo de atividade no sistema.

nm_ramo_atividade
string
Example: nm_ramo_atividade=Comércio Varejista de Alimentos

Nome do ramo de atividade.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "EmpConsultaRamoAtividade": [
    ]
}

Consultar Grupo do Corretor no Produto

Esta requisição realiza a consulta dos grupos de corretores vinculados ao produto do ramo patrimonial.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os grupos de corretores vinculados ao produto desejado.

Para consultar os grupos de corretores vinculados ao produto, além de possuir o token de acesso, deve ser informado o seguinte parâmetro listado abaixo.

query Parameters
cd_produto
required
string
Example: cd_produto=149

Código de identificação do produto no sistema.
Campo é obrigatório.
Obter em Consultar Lista de Produtos.

Responses

Response samples

Content type
application/json
{
  • "ConsultaGrupoCorretorProdutoPatrimonialTable1": [
    ],
  • "ConsultaGrupoCorretorProdutoPatrimonialTable2": [
    ]
}

Imprimir Formulários de Cotação e Proposta

Disponibiliza a impressão dos formulários de cotação e proposta em código base64 no formato PDF.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o código Base64 do formulário desejado.

Para imprimir a cotação ou proposta, além de possuir o token de acesso, o usuário deve informar os seguintes parâmetros listados abaixo.

query Parameters
cd_proposta
required
number
Example: cd_proposta=123456

Número da proposta desejada.

id_proposta_cotacao
required
number
Example: id_proposta_cotacao=987654

Número da cotação desejada.

cd_produto
required
number
Example: cd_produto=149

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

id_fomulario
required
number
Example: id_fomulario=1000370

Código de identificação do formulário desejado.
1000370 = Formulário de Cotação;
1000363 = Formulário de Proposta;

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 101,
  • "cd_proposta": 123456,
  • "id_proposta_cotacao": 987654,
  • "id_relatorio": 2025,
  • "id_item": 1,
  • "Relatorio": {
    }
}

Gerar Proposta Em Digitação Direta

Insere uma proposta em digitação, excluindo a necessidade de criar uma cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta em digitação criada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para incluir uma proposta diretamente, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_produto
required
number

Código de identificação do produto no sistema.
Obter em Consultar Lista de Produtos.

cd_filial
required
number

Código de identificação da filial Sancor.
Buscar por “cd_filial” em Consultar Domínios Patrimonial.

id_tp_seguro
number

Código de identificação do tipo de seguro.
Buscar por “id_tp_seguro” em Consultar Domínios Patrimonial.

id_des_experiencia
number

Código de identificação do tipo de desconto de experiencia a ser aplicado.
Buscar por “id_des_experiencia” em Consultar Domínios Patrimonial.

cd_apolice_anterior
string

Número da Apólice anterior do segurado. Informar somente quando o tipo de seguro for diferente de “Seguro Novo”.

id_tp_origem_emissao
number

Código de identificação do tipo de origem.
1 = Externo
Buscar por “cd_tp_origem” em Consultar Domínios Patrimonial.

Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosSeguro)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosSegurado)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosRisco)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosCoberturas)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaQuestionario)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosComissao)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaDadosPagamento)
Array of objects (WsEmpV13_EmpIncluirProposta_Req_EmpIncluirPropostaInformacoesAdicionais)

Responses

Request samples

Content type
application/json
{
  • "cd_produto": 149,
  • "cd_filial": 2950,
  • "id_tp_seguro": 1,
  • "id_des_experiencia": 0,
  • "cd_apolice_anterior": "101910000001234",
  • "id_tp_origem_emissao": 1,
  • "EmpIncluirPropostaDadosSeguro": [
    ],
  • "EmpIncluirPropostaDadosSegurado": [
    ],
  • "EmpIncluirPropostaDadosRisco": [
    ],
  • "EmpIncluirPropostaDadosCoberturas": [
    ],
  • "EmpIncluirPropostaQuestionario": [
    ],
  • "EmpIncluirPropostaDadosComissao": [
    ],
  • "EmpIncluirPropostaDadosPagamento": [
    ],
  • "EmpIncluirPropostaInformacoesAdicionais": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta_cotacao": 0
}

Residencial Flexível

Para o uso da maioria das APIs listada abaixo, é necessário que o usuário das APIs tenha de antemão duas informações: userId e offerId.

O userId normalmente é código susep do corretor ou, para corretores Unicoob, é o número da cooperativa. Após feito o cadastro do corretor no sistema, o mesmo é informado sobre esse código.

Cada offerId corresponde a um produto específico de seguro. Na API residencial, os IDs dos produtos disponíveis são 127, 149, 275.

Para determinar qual offerId está associado a qual assistência, é necessário consultar a API Coberturas/Assistências. Nela será possível obter o mapeamento completo das coberturas e assistências disponíveis em relação aos offerIds correspondentes.

Criar Cotações

Para a criação de cotações, precisamos de uma Pessoa Física ou uma Pessoa Jurídica, que será o beneficiário do seguro.

  1. No caso de uma pessoa física, todo o atributo person deve ser preenchido seguindo as instruções de obrigatoriedade da documentação técnica.

  2. No caso de uma pessoa jurídica, é necessário preencher o atributo company de acordo com as instruções de obrigatoriedade da documentação técnica.

Também será necessário o endereço da residência segurada. Este é descrito pelo atributo riskAddress e deve ser preenchido de acordo com a documentação técnica. A API Consulta CEP pode retornar algumas informações sobre o endereço dado um CEP.

Em seguida, é necessário descrever as coberturas que envolverão o seguro e seus valores respectivos no atributo coverages. As coberturas existentes podem ser listadas pela API Coberturas/Assistências.

O segurado deve responder uma série de questões pré-definidas disponíveis na API Questionários. As respostas, juntamente com o ID da pergunta respondida, devem ser incluídas no corpo da requisição pelo atributo question.

As datas de início e fim de vigência devem ser adicionadas nos atributos obrigatórios startDate e endDate, respectivamente.

Os atributos opcionais brokerageRate e discountRate referem-se, respectivamente, à comissão e o desconto permitido para o corretor.

Os atributos opcionais buildingTypeId, residenceTypeId, occupationTypeId e locationTypeId servem para dar mais informações sobre a residência segurada. Essas informações são pré-cadastradas no sistema e podem ser encontradas na API Domínios Patrimoniais.

Os atributos opcionais brokerageRate e discountRate identificam as taxas e comissões da cotação, informações que podem ser consultadas pela API Taxas e Comissão.

Após a criação da cotação, as informações retornadas serão usadas nos próximos passos da efetivação do seguro. Também é retornado o valor do prêmio da apólice no atributo premium, além dos planos de pagamento no atributo paymentPlans.

Neste ponto, também é possível imprimir a cotação firmada na API Impressão de Cotação.

Authorizations:
requestAuthorizer
path Parameters
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
number
Enum: "127" "149" "275"

ID da oferta

Request Body schema: application/json
object
object
object
required
Array of objects
required
object
buildingTypeId
number
residenceTypeId
number
occupationTypeId
number
locationTypeId
number
brokerageRate
number
discountRate
number
startDate
required
string

yyyy-mm-dd

endDate
required
string

yyyy-mm-dd

Responses

Request samples

Content type
application/json
{
  • "person": {
    },
  • "company": {
    },
  • "riskAddress": {
    },
  • "coverages": [
    ],
  • "questionnaire": {
    },
  • "buildingTypeId": 0,
  • "residenceTypeId": 0,
  • "occupationTypeId": 0,
  • "locationTypeId": 0,
  • "brokerageRate": 0,
  • "discountRate": 0,
  • "startDate": "yyyy-mm-dd",
  • "endDate": "yyyy-mm-dd"
}

Response samples

Content type
application/json
[
  • {
    }
]

Consulta CEP

API para retorno de informações do endereço de um dado CEP.

Utilizada pelas APIs:

  1. Criar Cotações
  2. Criar Proposta
Authorizations:
requestAuthorizer
path Parameters
cepId
required
string
Example: 66082105

Código do CEP contendo somente 8 digitos

Responses

Response samples

Content type
application/json
{
  • "logradouro": "string",
  • "bairro": "string",
  • "cidade": "string",
  • "uf": "string",
  • "ufNome": "string",
  • "pais": "string",
  • "paisNome": "string"
}

Coberturas/Assistências

Este endpoint da API retorna os dados relacionados às Coberturas e Assistências incluídas no seguro. Aqui estão as características dos dados retornados:

Coberturas Obrigatórias: Indicadas pelo atributo required com valor true. Assistências: Identificada pelo atributo isAssistance com valor true. Coberturas Básicas: Marcada pelo atributo isBasic com valor true. Coberturas Adicionais: Caracterizada quando isBasic é false e isAssistance é false.

Com base nessas informações, é possível determinar qual offerId contém a assistência desejada, além de identificar as coberturas obrigatórias, básicas e adicionais associadas ao seguro.

Utilizada pelas APIs:

  1. Criar Cotações
Authorizations:
requestAuthorizer
path Parameters
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
number
Enum: "127" "149" "275"

ID da oferta

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Questionários

API para retorno das questões e suas respectivas respostas pré-definidas cadastradas no sistema.

Utilizada pelas APIs:

  1. Criar Cotações
Authorizations:
requestAuthorizer
path Parameters
offerId
required
number
Enum: "127" "149" "275"

ID da oferta

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ]
}

Domínios Patrimoniais

API para retorno dos domínios referentes ao tipo de residência, tipo de ocupação, tipo de construção, tipo de localização e tipo de cobertura, utilizadas para dar informações adicionais sobre a residência segurada.

Utilizada pelas APIs:

  1. Criar Cotações
Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
{
  • "residenceType": [
    ],
  • "occupationType": [
    ],
  • "buildingType": [
    ],
  • "locationType": [
    ],
  • "coverageType": [
    ]
}

Taxas e comissão

API para listagem das taxas e comissões, que servem como um guia de valores das comissões permitidas para cada produto.

Utilizada pelas APIs:

  1. Criar Cotações
Authorizations:
requestAuthorizer
path Parameters
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
number
Enum: "127" "149" "275"

ID da oferta

Responses

Response samples

Content type
application/json
{
  • "product": {
    }
}

Criar proposta

Este endpoint serve para fechamento do seguro, começado na etapa de cotação. Com isso, no corpo da requisição está presente o atributo quoteId, número da cotação criada e retornado da API Criar cotações.

Enquanto na cotação o endereço do risco era opcional, aqui ele é obrigatório, portanto o atributo riskAddress deve ser preenchido com o endereço da residência segurada, mesmo que se já preenchido anteriormente. A API Consulta CEP pode retornar algumas informações sobre o endereço dado um CEP.

Além disso, mais informações do beneficiário principal são necessárias e devem ser providas nos atributos person, homeAddress e complement nos moldes da documentação técnica. Neste passo, os atributos person.nationalitye person.profession são pré-cadastrados no sistema e podem ser recuperados pelas APIs Nacionalidades e Profissões, respectivamente. Também é possível adicionar outros beneficiários no seguro pelo atributo beneficiaries. É necessário que cada beneficiado tenha o nome da pessoa, sua porcentagem de participação (número de 1-100) e seu cpf.

As datas de início e fim de vigência devem ser confirmadas nos atributos obrigatórios startDate e endDate, respectivamente.

Para a proposta ser fechada, é necessário informar como se dará o pagamento. O método de pagamento deve ser incluído no corpo da requisição pelo atributo paymentMethodId. As formas de pagamento possíveis podem ser recuperadas pela API Métodos de Pagamento.

O campo installmentId se refere à opção de parcelamento escolhida, como por exemplo à vista ou 1+2. Tal informação é pré-cadastrada no sistema e são retornadas após a criação da cotação na API Criar cotações, mais especificamente no atributo paymentPlans.

No campo paymentInfo são inseridas as informações sobre o pagamento do seguro. Aqui, o campo paymentInfo.nextInstallmentsPayment serve para escolher uma forma de pagamento diferente da forma de pagamento da primeira parcela (escolhida no campo installmentId) para as demais parcelas. Com isso, as opções são pré-cadastradas no sistema e podem ser recuperadas pela API Métodos de Pagamento. Caso a escolha para as demais parcelas seja uma forma de pagamento com cartão, os dados deste devem ser informados através da propriedade paymentInfo.creditCardInfo. Caso a escolha para as demais parcelas seja em débito automático, os dados devem ser informados através da propriedade paymentInfo.accountDebitInfo

Ainda no campo paymentInfo, é possível inserir os dados da conta corrente de devolução do pagamento em caso de recusa da proposta através do campo paymentInfo.restitutionAccountInfo, informando os dados do banco e conta. Os códigos de bancos cadastrados no sistema podem ser obtidos através da API Bancos.

Além disso, é necessário prover uma data de vencimento para o primeiro pagamento pelo atributo firstInstallmentDate e o dia de vencimento das próximas parcelas pelo atributo nextInstallmentsDay.

Após a criação da proposta, as informações retornadas pela API poderão ser utilizadas em outros endpoints para

  1. Impressão dos boletos de pagamento, pela API Impressão de Boleto, informando o endorsementId;
  2. Impressão da proposta, pela API Impressão de Proposta, informando o endorsementId;
  3. Impressão da apólice, pela API Impressão de Apólice, informando o endorsementId;
  4. Busca da proposta no sistema, que retorna todos os dados inseridos anteriormente, pela API Buscar Proposta, informando o proposalNumber.

Atenção: apesar da API de cotação retornar o atributo endorsementId, as impressões acima só funcionam após a finalização da proposta, já que se utilizam de dados firmados apenas após a criação da mesma.

Authorizations:
requestAuthorizer
Request Body schema: application/json
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
string
Enum: "127" "149" "275"

ID da oferta

paymentMethodId
required
string

Código do método de pagamento

quoteId
required
string

Número da cotação

object
object
required
object
required
object
required
object
required
Array of objects
installmentId
required
number
object
nextInstallmentsDay
required
number
firstInstallmentDate
required
string

yyyy-mm-dd

startDate
required
string

yyyy-mm-dd

endDate
required
string

yyyy-mm-dd

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "offerId": "127",
  • "paymentMethodId": "string",
  • "quoteId": "string",
  • "person": {
    },
  • "company": {
    },
  • "riskAddress": {
    },
  • "homeAddress": {
    },
  • "complement": {
    },
  • "beneficiaries": [
    ],
  • "installmentId": 0,
  • "paymentInfo": {
    },
  • "nextInstallmentsDay": 0,
  • "firstInstallmentDate": "yyyy-mm-dd",
  • "startDate": "yyyy-mm-dd",
  • "endDate": "yyyy-mm-dd"
}

Response samples

Content type
application/json
{
  • "quoteNumber": 0,
  • "proposalNumber": 0,
  • "proposalId": 0,
  • "productCode": 0,
  • "endorsementId": 0,
  • "policyId": 0,
  • "dgBankSlip": 0,
  • "coverage": [
    ],
  • "digitallySigned": true
}

Buscar proposta

API de busca de proposta no sistema. Retorna todos os dados inseridos durante a criação da Proposta pela API Criar Proposta

Authorizations:
requestAuthorizer
query Parameters
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
number
Enum: "127" "149" "275"

ID da oferta

proposalNumber
required
string

Número da proposta. Obtido do retorno da API Criar Proposta

Responses

Response samples

Content type
application/json
{
  • "proposal": {
    },
  • "status": [
    ],
  • "coverages": {
    },
  • "questions": [
    ],
  • "proponent": {
    },
  • "insured": {
    },
  • "complement": {
    },
  • "buildingInfo": { },
  • "homeAddress": {
    },
  • "riskAddress": {
    },
  • "payment": {
    },
  • "paymentPlans": [
    ],
  • "digitallySigned": true,
  • "broker": {
    }
}

Nacionalidades

API para retorno das nacionalidades cadastradas no sistema, usadas para fornecer informações do beneficiário principal do seguro.

Utilizada pelas APIs:

  1. Criar Proposta
Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
{
  • "nationalities": [
    ]
}

Profissões

API para retorno das profissões cadastradas no sistema, usadas para fornecer informações do beneficiário principal do seguro.

Utilizada pelas APIs:

  1. Criar Proposta
Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
{
  • "professions": [
    ]
}

Métodos de Pagamento

API para consulta das possíveis formas de pagamento cadastradas no sistema.

Utilizada pelas APIs:

  1. Criar Proposta
Authorizations:
requestAuthorizer
path Parameters
userId
required
string

Código de cadastro do corretor no sistema

offerId
required
number
Enum: "127" "149" "275"

ID da oferta

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bancos

API para listagem dos bancos cadastrados no sistema.

Utilizada pelas APIs:

  1. Criar Proposta
Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
{
  • "bank": [
    ]
}

Impressão de Boleto

API de impressão de boleto de pagamento da Proposta. Pode ser utilizada após a criação da Proposta.

Authorizations:
requestAuthorizer
query Parameters
endorsementId
required
string

Responses

Response samples

Content type
application/json
{
  • "stream": "string"
}

Impressão de Proposta

API de impressão da Proposta. Pode ser utilizada após a criação da Proposta.

Authorizations:
requestAuthorizer
query Parameters
endorsementId
required
string

Responses

Response samples

Content type
application/json
{
  • "stream": "string"
}

Impressão de Apólice

API de impressão da apólice da Proposta. Pode ser utilizada após a criação da Proposta.

Authorizations:
requestAuthorizer
query Parameters
endorsementId
required
string
proposalNumber
required
string
offerId
required
number
Enum: "127" "149" "275"

ID da oferta

userId
required
string

Responses

Response samples

Content type
application/json
{
  • "stream": "string"
}

Impressão de Cotação

API de impressão da Cotação.

Authorizations:
requestAuthorizer
query Parameters
proposalNumber
required
string
offerId
required
number
Enum: "127" "149" "275"

ID da oferta

userId
required
string

Código de cadastro do corretor no sistema

Responses

Response samples

Content type
application/json
{
  • "document": "string"
}

Riscos Diversos

Esta documentação descreve o funcionamento das APIs de Riscos Diversos, utilizadas para inclusão de cotações, propostas e apólices no Sistema de Gestão, abrangendo todas as etapas do processo.

As APIs de riscos diversos atendem aos ramos “Riscos de Engenharia” e “Equipamentos”. Cada ramo possui apenas duas APIs específicas:

  • Riscos de Engenharia:
    • Inserir Item de Risco de Engenharia;
    • Consultar Apólice de Risco de Engenharia;
  • Equipamentos:
    • Inserir Item de Equipamentos;
    • Consultar Apólice de Equipamentos;

Todas as demais APIs são compartilhadas entre ambos os ramos, permitindo a padronização das integrações e o reaproveitamento dos mesmos endpoints nos diferentes contextos de negócio.

No fluxo abaixo são demonstradas as etapas para a emissão de uma apólice dos ramos “Riscos de Engenharia” e “Equipamentos” vinculadas ao Sistema de Gestão.

Para visualizar o fluxo em outra aba, clique com o botão direito sobre a imagem e selecione “Abrir imagem em uma nova guia”.

Inserir Proposta

Realiza a inclusão de uma proposta dos ramos Risco Engenharia e Equipamentos.

Conforme demonstrado no fluxo acima, a API Inserir Proposta também permite incluir uma proposta com status de Cotação, caso seja necessário registrar uma cotação em vez de gerar uma proposta diretamente.

Para criar uma proposta em status de Cotação, deve-se informar o campo “cd_tp_origem” com o valor “2” (Cotação).

Posteriormente, para converter essa cotação em uma proposta, é necessário executar a API Alterar Proposta, informando o campo “cd_tp_origem” com o valor “1” (Liderança). Essa operação indica que a cotação foi aprovada, alterando seu status para Proposta no sistema.

Para criar uma proposta diretamente, pulando a etapa de cotação, ao utilizar a API Inserir Proposta, deve-se informar o campo “cd_tp_origem” com o valor “1” (Liderança).

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta inserida. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para incluir a proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_tp_origem
required
number

Código de identificação do tipo de origem.
Informar “2” para criar uma proposta em status de Cotação.
Informar “1” para criar uma proposta diretamente.

cd_produto
required
number

Código de identificação do produto no sistema.
Consultar “cd_produto” em APIs Compartilhadas | Consultar Produto, realizando a busca pelo nome do produto desejado.

cd_tp_apolice
required
number

Código de identificação do tipo de apólice.
2 = Individual
4 = Coletiva

id_tp_seguro
required
number

Código de identificação do tipo de seguro.
1 = Seguro Novo
2 = Renovação
3 = Renovação de Outra Seguradora

id_ramo
required
number

Código de identificação do ramo principal.
Obter em APIs Compartilhadas | Consultar Produto o “id_ramo” do produto, que é exibido na sessão “Ramos” na resposta da consulta de produto. O ramo principal é identificado quando o campo "dv_principal" possuir o valor true.

cd_apolice_anterior
number

Número da apólice anterior.
Informar somente se o campo “id_tp_seguro” possuir valor diferente de “1 = Seguro Novo”.

cd_filial
required
number

Código de identificação da filial Sancor.
Informar o valor “3”.

dt_inicio_vigencia
required
string

Data do início da vigência do seguro.

dt_fim_vigencia
required
string

Data do final da vigência do seguro.

cd_tp_resseguro_aberto
required
number

Código do tipo de resseguro no sistema.
Informar o valor “6”, desta forma, o resseguro será retido pela seguradora.

cd_usuario_venda
required
string

Informar o Login do usuário de venda vinculado ao corretor.

required
object (Proposta_DadosSeguradoDto)

Dados do beneficiário.

required
Array of objects (Proposta_DadosComissaoItemDto)

Informações de comissão/corretagem.

required
object (Proposta_DadosPagamentoDto)

Dados de pagamento.

required
object (Proposta_InformacoesAdicionaisDto)

Informações adicionais.

required
Array of objects (Proposta_QuestionarioItemDto)

Questionário.

required
Array of objects (Proposta_BeneficiarioItemDto)

Beneficiários.

Responses

Request samples

Content type
application/json
{
  • "cd_tp_origem": 1,
  • "cd_produto": 149,
  • "cd_tp_apolice": 2,
  • "id_tp_seguro": 1,
  • "id_ramo": 7,
  • "cd_apolice_anterior": 101910000001234,
  • "cd_filial": 3,
  • "dt_inicio_vigencia": "2025-11-10T00:00:00",
  • "dt_fim_vigencia": "2026-11-10T00:00:00",
  • "cd_tp_resseguro_aberto": 6,
  • "cd_usuario_venda": "usuario.vendas",
  • "DadosSegurado": {
    },
  • "DadosComissao": [
    ],
  • "DadosPagamento": {
    },
  • "InformacoesAdicionais": {
    },
  • "Questionario": [
    ],
  • "Beneficiarios": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_usuario": "USR123",
  • "cd_proposta": 123456,
  • "id_apolice": 1560,
  • "id_endosso": 1482,
  • "DadosComissao": [
    ],
  • "Beneficiarios": [
    ]
}

Inserir Item de Risco de Engenharia

Realiza a inclusão do item de risco a ser segurado pela proposta inserida pela API Inserir Proposta do ramo Risco Engenharia.

Este serviço permite inserir mais de um item de risco a ser segurado na proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do risco inserido. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para incluir o item de risco na proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do id_endosso ao Inserir Proposta.

required
Array of objects (EngenhariaItemDto)

Lista de itens de engenharia a serem inseridos.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 1482,
  • "Engenharia": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 1482,
  • "Item": [
    ]
}

Inserir Item de Risco de Equipamentos

Realiza a inclusão do item de risco a ser segurado pela proposta inserida pela API Inserir Proposta do ramo Equipamentos.

Este serviço permite inserir mais de um item de risco a ser segurado na proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do risco inserido. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para incluir o item de risco na proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do id_endosso ao Inserir Proposta.

required
Array of objects (EquipamentosItemDto)

Lista de itens de equipamentos a serem inseridos.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 1482,
  • "Equipamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 1482,
  • "Item": [
    ]
}

Excluir Item de Risco

Realiza a exclusão de um ou vários itens de risco inseridos através das APIs Inserir Item de Risco de Engenharia e Inserir Item de Risco de Equipamentos. A requisição permite excluir itens de risco de várias propostas por vez.

A API permite excluir todos os itens da proposta informando o campo “fl_excluir_todos” com o valor “true”. Portanto, se a proposta possuir um ou vários itens, todos os itens de risco serão excluídos, sem a necessidade de identificar qual item será excluído.

Para excluir um item de risco específico, é necessário informar o campo “id_item”, não há uma consulta que apresente o “id_item”, então caso seja necessário excluir um item específico, será necessário armazenar o valor do “id_item” a ser excluído obtido na resposta das APIs Inserir Item de Risco de Engenharia e Inserir Item de Risco de Equipamentos.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso de exclusão do item. Caso apresente erro, será retornado status 200 com a mensagem de validação para ajuste na requisição.

Para excluir o item de risco da proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
Array
id_endosso
required
number

Código de identificação do endosso da proposta.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do id_endosso ao Inserir Proposta.

fl_excluir_todos
required
boolean

Indica se a requisição irá excluir todos os itens de risco da proposta. Deve ser “True” ou “False”.
Se informado “True”, todos os itens de risco da proposta serão excluídos.
Se informado “False”, apenas o item de risco indicado no campo “id_item” será excluído.

required
Array of objects (ItensItemDto)

Lista de itens a serem excluídos.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Calcular Prêmio

Realiza o cálculo do prêmio da proposta. Para inserir o prêmio na proposta, além de possuir uma proposta criada, é necessário que o item de risco já tenha sido criado através das APIs Inserir Item de Risco de Engenharia e Inserir Item de Risco de Equipamentos.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem o valor do prêmio calculado. Caso apresente erro, será retornado status 400 com a mensagem de validação para ajuste na requisição.

Para calcular o prêmio da proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso da proposta.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do id_endosso ao Inserir Proposta.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 1482
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 1482,
  • "vl_tarifario": 5000,
  • "vl_iof": 350,
  • "vl_total": 5350
}

Alterar Status da Proposta

Realiza a alteração do status de uma proposta individual ou de várias propostas. Permite manter um controle de status da proposta, enquanto a apólice não é emitida. A requisição também permite recusar a proposta criada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso apresente erro, será retornado status 200 com a mensagem de validação para ajuste na requisição.

Para alterar o status da proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
Array
id_apolice
required
number

Código de identificação da apólice. A apólice não foi emitida, mas a proposta já possui previamente o código de identificação de apólice.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do “id_apolice” ao Inserir Proposta.

cd_status
required
number
Enum: 208 601 603 604 607 608

Código de identificação do status a ser atribuído à proposta.
208 = Pré Análise
601 = Em negociação
603 = Cancelada
604 = Recusada
607 = Enviada para Subscrição
608 = Liberada para Emissão

id_motivo_recusa_proposta
number
Enum: 2 4 14

Código de identificação do motivo de recusa da proposta.
Informar apenas quando o campo “cd_status” possuir o valor “604 - Recusada”.
2 = Inconsistência nas informações
4 = Recusa sem nova emissão
14 = Solicitação do Corretor

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Alterar Proposta

Realiza a alteração de uma proposta dos ramos Risco Engenharia e Equipamentos.

Conforme demonstrado no fluxo, a API Alterar Proposta também permite alterar uma proposta com status de Cotação para uma Proposta Efetiva.

Para mudar uma proposta em status de Cotação para uma Proposta Efetiva, deve-se informar o campo “cd_tp_origem” com o valor “1” (Liderança). Essa operação indica que a cotação foi aprovada, alterando seu status para Proposta no sistema.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta alterada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar uma proposta, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
id_apolice
required
number

Código de identificação da apólice. A apólice não foi emitida, mas a proposta já possui previamente o código de identificação de apólice.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do “id_apolice” ao Inserir Proposta.

cd_tp_origem
required
number
Enum: 1 2

Código de identificação do tipo de origem.
Informar “2” para criar uma proposta em status de Cotação.
Informar “1” para criar uma proposta diretamente.

cd_tp_apolice
required
number
Enum: 2 4

Código de identificação do tipo de apólice.
2 = Individual
4 = Coletiva

id_tp_seguro
required
number
Enum: 1 2 3

Código de identificação do tipo de seguro.
1 = Seguro Novo
2 = Renovação
3 = Renovação de Outra Seguradora

cd_apolice_anterior
number

Número da apólice anterior.
Informar somente se o campo “id_tp_seguro” possuir valor diferente de “1 = Seguro Novo”.

cd_filial
required
number

Código de identificação da filial Sancor.
Informar o valor “3”.

dt_inicio_vigencia
required
string

Data do início da vigência do seguro.

dt_fim_vigencia
required
string

Data do final da vigência do seguro.

cd_tp_resseguro_aberto
required
number

Código do tipo de resseguro no sistema.
Informar o valor “6”, desta forma, o resseguro será retido pela seguradora.

required
object (DadosSeguradoDto)

Dados do beneficiário.

required
Array of objects (DadosComissaoItemDto)

Informações de comissão/corretagem.

required
object (DadosPagamentoDto)

Dados de pagamento.

required
object (InformacoesAdicionaisDto)

Informações adicionais.

required
Array of objects (QuestionarioItemDto)

Questionário.

required
Array of objects (BeneficiariosItemDto)

Beneficiários.

Responses

Request samples

Content type
application/json
{
  • "id_apolice": 123456,
  • "cd_tp_origem": 1,
  • "cd_tp_apolice": 2,
  • "id_tp_seguro": 1,
  • "cd_apolice_anterior": 101910000001234,
  • "cd_filial": 3,
  • "dt_inicio_vigencia": "2025-11-10T00:00:00",
  • "dt_fim_vigencia": "2026-11-10T00:00:00",
  • "cd_tp_resseguro_aberto": 6,
  • "DadosSegurado": {
    },
  • "DadosComissao": [
    ],
  • "DadosPagamento": {
    },
  • "InformacoesAdicionais": {
    },
  • "Questionario": [
    ],
  • "Beneficiarios": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_usuario": "USR123",
  • "cd_proposta": 123456,
  • "id_apolice": 98765,
  • "id_endosso": 1482
}

Emitir Apólice

Realiza a emissão de uma apólice dos ramos “Riscos de Engenharia” e “Equipamentos” através de uma proposta efetiva.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da apólice emitida. Caso alguma informação esteja incorreta, será retornada status 400 com a mensagem de validação.

Para emitir uma apólice, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
cd_proposta
required
number

Número da proposta no sistema.
Obter em APIs Compartilhadas | Consultar Proposta ou armazenar o valor do “cd_proposta” ao Inserir Proposta.

cd_produto
required
number

Código de identificação do produto no sistema.
Consultar “cd_produto” em APIs Compartilhadas | Consultar Produto, realizando a busca pelo nome do produto desejado.

Responses

Request samples

Content type
application/json
{
  • "cd_proposta": 123456,
  • "cd_produto": 149
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_apolice": 98765,
  • "cd_apolice": 2025100001234
}

Consultar Apólice de Risco Engenharia

Realiza a consulta de uma apólice do ramo “Riscos de Engenharia”. É necessário informar apenas um dos parâmetros para realizar a consulta da apólice desejada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da apólice desejada. Caso alguma informação esteja incorreta, será retornada status 400 com a mensagem de validação.

Para consultar uma apólice de engenharia, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_apolice
number
Example: id_apolice=98765

Código de identificação da apólice.
Armazenar o valor do campo “id_apolice” existente na resposta da API Emitir Apólice.

cd_apolice
number
Example: cd_apolice=2025100001234

Número da apólice no sistema.
Armazenar o valor do campo “cd_apolice” existente na resposta da API Emitir Apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaApoliceDetalheEngenharia": [
    ]
}

Consultar Apólice de Equipamentos

Realiza a consulta de uma apólice do ramo “Equipamentos”. É necessário informar apenas um dos parâmetros para realizar a consulta da apólice desejada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da apólice desejada. Caso alguma informação esteja incorreta, será retornada status 400 com a mensagem de validação.

Para consultar uma apólice de equipamentos, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_apolice
number
Example: id_apolice=98765

Código de identificação da apólice.
Armazenar o valor do campo “id_apolice” existente na resposta da API Emitir Apólice.

cd_apolice
number
Example: cd_apolice=2025100001234

Número da apólice no sistema.
Armazenar o valor do campo “cd_apolice” existente na resposta da API Emitir Apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaApoliceDetalheEquipamentos": [
    ]
}

Listar Equipamentos

Realiza a consulta dos Equipamentos cadastrados no sistema de gestão. Os parâmetros da requisição são opcionais, se não informado nenhum parâmetro, serão listados todos os equipamentos cadastrados no sistema.

O parâmetro “nm_equimento” funciona como um campo de busca, ao digitar uma palavra ou frase, a resposta listará todos os equipamentos que contém a palavra ou frase no nome.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os equipamentos cadastrados. Caso alguma informação esteja incorreta, será retornada status 400 com a mensagem de validação.

Para consultar equipamentos, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
id_equipamento
number
Example: id_equipamento=500

Código de identificação do equipamento no sistema.
Pode ser consultado através da API Consultar Domínios de Riscos Diversos, o “id_equipamento” será apresentado no campo “id_dominio”.

nm_equipamento
string
Example: nm_equipamento=Escavadeira

Realiza pesquisa no nome do equipamento no sistema.

nr_equipamento
number
Example: nr_equipamento=12345

Número do equipamento no sistema.

dv_ativo
boolean
Example: dv_ativo=true

Indica se o equipamento está ativo. Deve ser true ou false.
Se informado true, será listado apenas equipamentos ativos.
Se informado false, será listado apenas equipamentos desativados.

id_classe_equipamento
number
Example: id_classe_equipamento=42

Código de identificação da classe do equipamento no sistema.
Pode ser consultado através da API Consultar Domínios de Riscos Diversos, o “id_classe_equipamento” será apresentado no campo “id_dominio”.

nr_ramo
number
Example: nr_ramo=7

Número do ramo que o equipamento está vinculado.

cd_produto
number
Example: cd_produto=149

Código de identificação do produto que o equipamento está vinculado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ListaEquipamentos": [
    ]
}

Consultar Domínios de Riscos Diversos

Realiza a consulta dos domínios de riscos diversos cadastrados no sistema de gestão. A requisição possui apenas um parâmetro, sendo de uso obrigatório.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do domínio consultado. Caso alguma informação esteja incorreta, será retornada status 400 com a mensagem de validação.

Para consultar os domínios de riscos diversos, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
cd_dominio
required
string
Example: cd_dominio=id_equipamento

Identificação do domínio a ser consultado.
O campo aceita os valores: “id_equipamento” e “id_classe_equipamento”.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Dominios": [
    ]
}

Rural

Neste documento é descrito o funcionamento das APIs utilizadas pelo módulo Rural do Sistema de Gestão, utilizadas nos processo de lançamento de uma cotação, proposta, até a realização da emissão da apólice.

No fluxo abaixo é demonstrado as etapas para a emissão de uma apólice rural vinculadas ao Sistema de Gestão.

Para visualizar o fluxo em outra aba, clique com o botão direito sobre a imagem e selecione “Abrir imagem em uma nova guia”.

Inserir Cotação

Esta chamada realiza a inclusão de uma nova cotação do ramo rural. É possível gerar cotação para os dois tipos de produto rural “Multirrisco” ou “Riscos Nomeados”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação criada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro ou validação.

Para inserir uma cotação, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
cd_produto
required
number

Código de identificação do produto no sistema.
Pode ser obtido através da API Consultar Produto.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
2 = Cotação

cd_filial
required
number

Código de identificação da filial da seguradora.
3 = Matriz

id_pessoa_cliente
required
number

Código de identificação da Pessoa Física ou Jurídica a ser segurada.
Obter em APIs Compartilhadas | Pesquisar Pessoa.

id_endereco
number

Código de identificação do endereço da Pessoa a ser segurada.
Obter em APIs Compartilhadas | Pesquisar Pessoa.

id_tp_endereco
number

Código de identificação do tipo de endereço do cliente.
Pode ser obtido informando “TipoEndereco” no parâmetro da API APIs Compartilhadas | Consulta de Domínios.
Preencher o campo “id_tp_endereco” somente quando o campo “id_endereco” não for informado.

nm_cep_livre
string

CEP do endereço do cliente.
Preencher o campo “nm_cep_livre” somente quando o campo “id_endereco” não for informado.

nm_endereco_livre
string

Nome da rua do endereço do cliente.
Preencher o campo “nm_endereco_livre” somente quando o campo “id_endereco” não for informado.

nm_bairro_bcep
string

Bairro do endereço do cliente.
Preencher o campo “nm_bairro_bcep” somente quando o campo “id_endereco” não for informado.

nm_complemento_bcep
string

Complemento do endereço do cliente.
Preencher o campo “nm_complemento_bcep” somente quando o campo “id_endereco” não for informado.

nr_rua_endereco_bcep
number

Número do endereço do cliente.
Preencher o campo “nr_rua_endereco_bcep” somente quando o campo “id_endereco” não for informado.

nm_cidade_bcep
string

Cidade do endereço do cliente.
Preencher o campo “nm_cidade_bcep” somente quando o campo “id_endereco” não for informado.

cd_uf_bcep
number

Código do estado a ser disponibilizado do endereço do cliente.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.
Preencher o campo “cd_uf_bcep” somente quando o campo “id_endereco” não for informado.

dt_inicio_vigencia
required
string

Data do início da vigência do seguro.

dt_fim_vigencia
required
string

Data do fim da vigência do seguro.

id_tp_subvencao
required
number

Código de identificação do tipo de subvenção.
Pode ser obtido através da API Consulta Subvenção.

nm_texto_livre
required
string

Campo de livre digitação.

cd_usuario_venda
required
string

Login do usuário de venda do corretor responsável pela cotação.

qt_dias_vigencia
required
number

Quantidade de dias de vigência do seguro.

required
object (ApiRur_PostCot_Req_Corretor)

Dados do corretor responsável pela cotação.

required
Array of objects (ApiRur_PostCot_Req_DadosRisco)

Dados dos itens de risco da cotação.

required
object (ApiRur_PostCot_Req_TipoCarregamento)

Informações de carregamento, quando aplicável ao produto.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "nr_cotacao": 123456,
  • "Premio": {
    },
  • "Itens": [
    ],
  • "Subvencao": {
    },
  • "Parcelamento": [
    ],
  • "TipoCarregamento": {
    }
}

Consultar Cotação

Esta requisição realiza a consulta de uma cotação. Para realizar a consulta é obrigatório informar o número da cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação desejada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta o código e a mensagem de erro.

Para consultar uma cotação, é necessário possuir o token de acesso e preencher o parâmetro contido na chamada da API, conforme detalhado a seguir.

query Parameters
id_cotacao
required
number
Example: id_cotacao=123456

Número da cotação desejada para consulta. O parâmetro é obrigatório.
Necessário armazenar o valor do campo “nr_cotacao” ao Inserir Cotação.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_produto": 17,
  • "cd_tp_origem": 2,
  • "cd_filial": 3,
  • "id_pessoa_cliente": 4337914,
  • "id_endereco": 1001,
  • "dv_busca_cep": false,
  • "id_tp_endereco": 1,
  • "nm_cep_livre": "87706000",
  • "nm_endereco_livre": "Rua das Palmeiras",
  • "nm_bairro_cep": "Centro",
  • "nm_complemento_cep": "Apartamento 101",
  • "nr_rua_endereco_cep": 123,
  • "nm_cidade_cep": "Paranavaí",
  • "cd_uf_cep": 41,
  • "dt_inicio_vigencia": "2025-11-01T00:00:00",
  • "dt_fim_vigencia": "2026-10-31T23:59:59",
  • "id_tp_subvencao": 1,
  • "nm_texto_livre": "Cotação com subvenção federal.",
  • "cd_usuario_venda": "usuario.venda",
  • "qt_dias_vigencia": 365,
  • "Corretor": [
    ],
  • "DadosRisco": [
    ],
  • "TipoCarregamento": {
    }
}

Alterar Cotação

Esta requisição realiza a alteração dos dados de uma cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro ou validação.

Para alterar uma cotação, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
id_proposta
required
number

Número da cotação desejada para alteração.
Necessário armazenar o valor do campo “nr_cotacao” ao Inserir Cotação.

cd_produto
required
number

Código de identificação do produto no sistema.
Pode ser obtido através da API Consultar Produto.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
2 = Cotação

cd_filial
required
number

Código de identificação da filial da seguradora.
3 = Matriz

id_pessoa_cliente
required
number

Código de identificação da Pessoa Física ou Jurídica a ser segurada.
Obter em APIs Compartilhadas | Pesquisar Pessoa.

id_endereco
required
number

Código de identificação do endereço da Pessoa a ser segurada.
Obter em APIs Compartilhadas | Pesquisar Pessoa.

id_tp_endereco
required
number

Código de identificação do tipo de endereço do cliente.
Pode ser obtido informando “TipoEndereco” no parâmetro da API APIs Compartilhadas | Consulta de Domínios.
Preencher o “id_tp_endereco” somente quando o campo “id_endereco” não for informado.

nm_cep_livre
required
string

CEP do endereço do cliente.
Preencher o “nm_cep_livre” somente quando o campo “id_endereco” não for informado.

nm_endereco_livre
required
string

Nome da rua do endereço do cliente.
Preencher o “nm_endereco_livre” somente quando o campo “id_endereco” não for informado.

nm_bairro_bcep
required
string

Bairro do endereço do cliente.
Preencher o “nm_bairro_bcep” somente quando o campo “id_endereco” não for informado.

nm_complemento_bcep
required
string

Complemento do endereço do cliente.
Preencher o “nm_complemento_bcep” somente quando o campo “id_endereco” não for informado.

nr_rua_endereco_bcep
required
number

Número do endereço do cliente.
Preencher o “nr_rua_endereco_bcep” somente quando o campo “id_endereco” não for informado.

nm_cidade_bcep
required
string

Cidade do endereço do cliente.
Preencher o “nm_cidade_bcep” somente quando o campo “id_endereco” não for informado.

cd_uf_bcep
required
number

Código do estado a ser disponibilizado do endereço do cliente.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.
Preencher o “cd_uf_bcep” somente quando o campo “id_endereco” não for informado.

dt_inicio_vigencia
required
string

Data do início da vigência do seguro.

dt_fim_vigencia
required
string

Data do fim da vigência do seguro.

id_tp_subvencao
required
number

Código de identificação do tipo de subvenção.
Pode ser obtido através da API Consulta Subvenção.

nm_texto_livre
required
string

Campo de livre digitação.

cd_usuario_venda
required
string

Login do usuário de venda do corretor responsável pela cotação.

qt_dias_vigencia
required
number

Quantidade de dias de vigência do seguro.

required
object (ApiRur_PutCot_Req_Corretor)

Informações do corretor no contexto da cotação.
Inclui dados de identificação e comissão.

required
Array of objects (ApiRur_PutCot_Req_DadosRisco)

Itens de risco cadastrados na cotação.

required
object (ApiRur_PutCot_Req_TipoCarregamento)

Configuração de carregamento aplicada ao prêmio da cotação, quando houver.
Abrange o tipo de carregamento e o percentual configurado.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Efetivar Cotação

Esta requisição realiza a efetivação da cotação desejada, habilitando a cotação para o preenchimento da proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta o código e a mensagem de erro.

Para efetivar uma cotação, é necessário possuir o token de acesso e preencher o campo contido no corpo da requisição, conforme detalhado a seguir.

Request Body schema: application/json
required
Array
id_cotacao
required
number

Número da cotação a ser efetivada. O parâmetro é obrigatório.
Necessário armazenar o valor do campo “nr_cotacao” ao Inserir Cotação.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_cotacao": 123456
}

Inserir Proposta

Realiza a inserção da proposta de uma cotação efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta criada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta o código e a mensagem de erro ou validação.

Para inserir uma proposta, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
nr_cotacao
number

Número da cotação efetivada.

cd_produto
required
number

Código de identificação do produto no sistema.
Pode ser obtido através da API Consultar Produto.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
1 = Liderança.

cd_filial
required
number

Código de identificação da filial da seguradora.
3 = Matriz

cd_tp_resseguro_aberto
required
number

Tipo de resseguro da proposta.
6 = Retenção Seguradora.
O seguro será retido apenas pela seguradora.

id_pessoa_cliente
required
number

Código de identificação da Pessoa Física ou Jurídica a ser segurada.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

id_endereco
required
number

Código de identificação do endereço da Pessoa a ser segurada.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

id_tp_endereco
number

Código de identificação do tipo de endereço do cliente.
Pode ser obtido informando “TipoEndereco” no parâmetro da API APIs Compartilhadas | Consulta de Domínios.
Preencher o “id_tp_endereco” somente quando o campo “id_endereco” não for informado.

nm_cep_livre
string

CEP do endereço do cliente.
Preencher o “nm_cep_livre” somente quando o campo “id_endereco” não for informado.

nm_endereco_livre
string

Nome da rua do endereço do cliente.
Preencher o “nm_endereco_livre” somente quando o campo “id_endereco” não for informado.

nm_bairro_bcep
string

Bairro do endereço do cliente.
Preencher o “nm_bairro_bcep” somente quando o campo “id_endereco” não for informado.

nm_complemento_bcep
string

Complemento do endereço do cliente.
Preencher o “nm_complemento_bcep” somente quando o campo “id_endereco” não for informado.

nr_rua_endereco_bcep
number

Número do endereço do cliente.
Preencher o “nr_rua_endereco_bcep” somente quando o campo “id_endereco” não for informado.

nm_cidade_bcep
string

Cidade do endereço do cliente.
Preencher o “nm_cidade_bcep” somente quando o campo “id_endereco” não for informado.

cd_uf_bcep
number

Código do estado a ser disponibilizado do endereço do cliente.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.
Preencher o “cd_uf_bcep” somente quando o campo “id_endereco” não for informado.

dt_inicio_vigencia
required
string

Data de início de vigência do seguro.

dt_fim_vigencia
required
string

Data de fim de vigência do seguro.

id_produto_parc_premio
required
number

Código de identificação do parcelamento.
Pode ser obtido através da API Consultar Produto.

dt_vencimento_pparcela
required
string

Data de vencimento da primeira parcela.

cd_forma_pagamento_pparcela
required
number

Código da forma de pagamento da primeira parcela.
Pode ser obtido através da API Consultar Produto.

cd_forma_pagamento
required
number

Código da forma de pagamento das demais parcelas.
Informar somente se o campo “id_produto_parc_premio” possuir parcelamento diferente de “à vista”.
Pode ser obtido através da API Consultar Produto.

id_conta_corrente
number

Código de identificação da conta corrente do pagador.
Informar somente quando a forma de pagamento for do tipo débito em conta.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

nr_dia_cobranca
number

Dia de cobrança das demais parcelas.
Informar somente se o campo “id_produto_parc_premio” possuir parcelamento diferente de “à vista”.

nm_texto_livre
string

Campo de livre digitação.

nm_texto_anexo
string

Campo de livre digitação.

cd_usuario_venda
required
string

Login do usuário de venda do corretor responsável pela proposta.

qt_dias_vigencia
number

Quantidade de dias de vigência do seguro.

required
Array of objects (ApiRur_PostProposta_Req_Corretor)

Informações dos corretores vinculados à proposta.

Array of objects (ApiRur_PostProposta_Req_DadosBeneficiario)

Beneficiários vinculados à proposta em nível de proposta.

required
Array of objects (ApiRur_PostProposta_Req_DadosRisco)

Itens de risco vinculados à proposta.

Array of objects (ApiRur_PostProposta_Req_QuestionarioItem)

Respostas do questionário em nível de proposta.

object (ApiRur_PostProposta_Req_TipoCarregamento)

Configuração de carregamento aplicada ao prêmio da proposta, quando houver.
Não se aplica para carregamentos do tipo comissão.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta": 125874,
  • "cd_proposta": 2025001234,
  • "id_endosso": 9876543,
  • "id_apolice": 10123456789
}

Consultar Proposta

Esta requisição realiza a consulta de uma proposta. Para realizar a consulta, é obrigatório informar o número da proposta desejada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta informada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro. Se o parâmetro “cd_proposta” não for informado, ocorrerá erro com status 500 (Erro do servidor interno).

Para consultar uma proposta, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_proposta
required
number

Número da proposta desejada para consulta. O parâmetro é obrigatório.
Necessário armazenar o valor do campo “cd_proposta” ao Inserir Proposta.

cd_usuario_venda
string

Login do usuário de venda do corretor responsável pela proposta. Este parâmetro é opcional.

cd_produto
number

Código de identificação do produto no sistema. Este parâmetro é opcional.
Pode ser obtido através da API Consultar Produto.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_apolice": 101234,
  • "cd_apolice": 1012345678901,
  • "cd_proposta": 2025001234,
  • "nr_cotacao": "123456",
  • "cd_tp_origem": 1,
  • "cd_tp_apolice": 2,
  • "cd_status": 3,
  • "nm_status": "Emitida",
  • "cd_filial": 3,
  • "cd_produto": 17,
  • "nm_produto": "Seguro Agrícola Soja",
  • "id_pessoa_cliente": 4337914,
  • "cd_tp_pessoa": 1,
  • "nm_tp_pessoa": "Pessoa Física",
  • "nr_cnpj_cpf": "12345678901",
  • "nm_pessoa_razao_social": "João da Silva",
  • "nm_email": "joao.silva@example.com",
  • "nr_ddd_celular": 44,
  • "nr_telefone_celular": "999999999",
  • "id_endereco": 1001,
  • "nm_cep": "87706000",
  • "nm_endereco": "Rua das Palmeiras",
  • "nr_endereco": 123,
  • "nm_bairro": "Centro",
  • "nm_complemento": "Apartamento 101",
  • "cd_uf": 41,
  • "nm_cidade": "Paranavaí",
  • "id_tp_endereco": 1,
  • "nm_tp_endereco": "Residencial",
  • "fl_principal": true,
  • "id_endosso": 9876543,
  • "dt_inicio_vigencia": "2025-11-01T00:00:00",
  • "dt_fim_vigencia": "2026-10-31T23:59:59",
  • "dt_proposta": "2025-10-25T10:30:00",
  • "dt_vencimento_proposta": "2025-11-10T00:00:00",
  • "id_tp_subvencao": 1,
  • "nm_tp_subvencao": "Subvenção Federal",
  • "cd_usuario_venda": "usuario.venda",
  • "qt_dias_vigencia": 365,
  • "Endosso": [
    ]
}

Alterar Proposta

Esta requisição realiza a alteração dos dados de uma proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro ou validação.

Para alterar uma proposta, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
id_proposta
required
number

Código de identificação da proposta desejada.
Necessário armazenar o valor do campo “id_proposta” ao Inserir Proposta.

cd_produto
required
number

Código de identificação do produto no sistema.
Pode ser obtido através da API Consultar Produto.

cd_tp_origem
required
number

Código de identificação do tipo de origem.
1 = Liderança.

cd_filial
required
number

Código de identificação da filial da seguradora.
3 = Matriz

cd_tp_resseguro_aberto
required
number

Tipo de resseguro da proposta.
6 = Retenção Seguradora.
O seguro será retido apenas pela seguradora.

id_pessoa_cliente
required
number

Código de identificação da Pessoa Física ou Jurídica a ser segurada.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

id_endereco
required
number

Código de identificação do endereço da Pessoa a ser segurada.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

id_tp_endereco
required
number

Código de identificação do tipo de endereço do cliente.
Pode ser obtido informando “TipoEndereco” no parâmetro da API APIs Compartilhadas | Consulta de Domínios.
Preencher o “id_tp_endereco” somente quando o campo “id_endereco” não for informado.

nm_cep_livre
required
string

CEP do endereço do cliente.
Preencher o “nm_cep_livre” somente quando o campo “id_endereco” não for informado.

nm_endereco_livre
required
string

Nome da rua do endereço do cliente.
Preencher o “nm_endereco_livre” somente quando o campo “id_endereco” não for informado.

nm_bairro_bcep
required
string

Bairro do endereço do cliente.
Preencher o “nm_bairro_bcep” somente quando o campo “id_endereco” não for informado.

nm_complemento_bcep
required
string

Complemento do endereço do cliente.
Preencher o “nm_complemento_bcep” somente quando o campo “id_endereco” não for informado.

nr_rua_endereco_bcep
required
number

Número do endereço do cliente.
Preencher o “nr_rua_endereco_bcep” somente quando o campo “id_endereco” não for informado.

nm_cidade_bcep
required
string

Cidade do endereço do cliente.
Preencher o “nm_cidade_bcep” somente quando o campo “id_endereco” não for informado.

cd_uf_bcep
required
number

Código do estado a ser disponibilizado do endereço do cliente.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.
Preencher o “cd_uf_bcep” somente quando o campo “id_endereco” não for informado.

dt_inicio_vigencia
required
string

Data de início de vigência do seguro.

dt_fim_vigencia
required
string

Data de fim de vigência do seguro.

id_produto_parc_premio
required
number

Código de identificação do parcelamento.
Pode ser obtido através da API Consultar Produto.

cd_forma_pagamento_pparcela
required
number

Código da forma de pagamento da primeira parcela.
Pode ser obtido através da API Consultar Produto.

dt_vencimento_pparcela
required
string

Data de vencimento da primeira parcela.

cd_forma_pagamento
required
number

Código da forma de pagamento das demais parcelas.
Informar somente se o campo “id_produto_parc_premio” possuir parcelamento diferente de à vista.
Pode ser obtido através da API Consultar Produto.

id_conta_corrente
required
number

Código de identificação da conta corrente do pagador.
Informar somente quando a forma de pagamento for do tipo débito em conta.
Pode ser obtido através da API APIs Compartilhadas | Pesquisar Pessoa.

nr_dia_cobranca
required
number

Dia de cobrança das demais parcelas.
Informar somente se o campo “id_produto_parc_premio” possuir parcelamento diferente de à vista.

nm_texto_livre
required
string

Campo de livre digitação.

nm_texto_anexo
required
string

Campo de livre digitação.

id_tp_subvencao
required
number

Código de identificação do tipo de subvenção.
Pode ser obtido através da API Consulta Subvenção.

cd_usuario_venda
required
string

Login do usuário de venda do corretor responsável pela proposta.

qt_dias_vigencia
required
number

Quantidade de dias de vigência do seguro.

required
Array of objects (ApiRur_PutProposta_Req_Corretor)

Corretores vinculados à proposta.

required
Array of objects (ApiRur_PutProposta_Req_Beneficiario)

Beneficiários vinculados à proposta em nível de proposta.

required
Array of objects (ApiRur_PutProposta_Req_DadosRisco)

Itens de risco vinculados à proposta.

required
Array of objects (ApiRur_PutProposta_Req_QuestionarioItem)

Respostas do questionário em nível de proposta.

required
object (ApiRur_PutProposta_Req_TipoCarregamento)

Configuração de carregamento aplicada à proposta, quando aplicável ao produto.
Não se aplica para carregamentos do tipo comissão.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta": 125874,
  • "cd_proposta": 2025001234,
  • "id_endosso": 9876543,
  • "id_apolice": 10123456789
}

Alterar Status da Proposta

Realiza a alteração do status de uma proposta. O fluxo para efetivar uma proposta não exige alterações de status, o uso dos status serve somente para realizar controles na proposta desejada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso para a alteração do status realizada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro.

Para alterar o status da proposta, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
id_proposta
required
number

Código de identificação da proposta.

cd_status
required
number

Código do status desejado.
208 = Pré-Análise
601 = Em negociação
606 = Em Cadastro
610 = Pendente de Vistoria
611 = Vistoria Realizada
1270007 = Pendente Análise
1270008 = Analisado com Pendências
1270009 = Pendente Documentos
1270010 = Aprovada

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_produto": 17
}

Calcular Prêmio

Realiza o cálculo do prêmio da proposta, caso necessário. Também é necessário recalcular o prêmio quando há alguma alteração de informação na proposta que gerada, se o recalculo de prêmio não for realizado, não será permitido emitir a apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do prêmio calculado. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para calcular o prêmio, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
id_endosso
required
number

Código de identificação do endosso da proposta.
Necessário armazenar o valor do campo “id_endosso” ao Inserir Proposta ou obter através da API Consultar Proposta.

dv_premio_calculo_manual
required
boolean

Opção de calcular o prêmio da proposta manualmente. Deve possuir os valores “true” ou “false”.
O valor “true” indica que o cálculo do prêmio será feito manualmente. Informar “true” somente quando a regra código “13200016” estiver ativa no produto. A regra pode ser verificada através da API Consultar Regras do Produto informando no parâmetro “cd_regra” o valor “13200016”.
O valor “false” indica que o prêmio será calculado automaticamente.

vl_premio_tecnico
required
number

Valor técnico do prêmio.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

vl_net
required
number

Valor net do prêmio.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

vl_premio_liquido
required
number

Valor líquido do prêmio.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

vl_tarifario
required
number

Valor tarifário do prêmio.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

vl_adicional
required
number

Valor adicional de prêmio.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

pe_juros
required
number

Porcentagem de juros.
Informar somente se o campo “dv_premio_calculo_manual” possuir o valor “true”.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_endosso": 987654,
  • "vl_tarifario": 4500.75,
  • "vl_iof": 275.32,
  • "vl_total": 4776.07
}

Efetivar Proposta

Realiza a efetivação de uma proposta, permitindo a emissão da apólice posteriormente. Após realizar a efetivação da proposta, o Sistema de Gestão não irá permitir a realização de alterações nos dados da proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de confirmação do processamento de efetivação da proposta. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para efetivar a proposta, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
Array
nr_proposta
required
number

Número da proposta.

cd_produto
required
number

Código de identificação do produto utilizado na proposta.
Pode ser obtido através da API Consultar Produto.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "nr_proposta": 2025001234,
  • "cd_produto": 17
}

Emitir Apólice

Realiza a emissão de uma apólice. Para que seja possível emitir a apólice, é necessário que a proposta seja efetivada através da API Efetivar Proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da apólice emitida. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para emitir uma apólice, é necessário possuir o token de acesso e preencher o campo contido no corpo da requisição, conforme detalhado a seguir.

Request Body schema: application/json
required
Array
id_endosso
required
number

Código de identificação do endosso da proposta.
Necessário armazenar o valor do campo “id_endosso” ao Inserir Proposta ou obter através da API Consultar Proposta.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_apolice": 1012345678901
}

Consultar Apólice

Realiza a consulta dos dados da apólice desejada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da apólice informada. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro. Se o parâmetro “cd_apolice” não for informado, a resposta apresentará o status 500 (Erro do servidor interno).

Para consultar uma apólice, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_apolice
required
number

Número da apólice desejada para consulta. O parâmetro é obrigatório.
O número da apólice deve ser armazenado ao obter a resposta da API Emitir Apólice.

cd_usuario_venda
string

Login do usuário do corretor responsável pela venda. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_apolice": 12345,
  • "cd_apolice": 10123456789,
  • "cd_proposta": 2025001122,
  • "nr_cotacao": 556677,
  • "cd_tp_origem": 1,
  • "cd_tp_apolice": 2,
  • "cd_status": 1270010,
  • "nm_status": "Aprovada",
  • "cd_filial": 3,
  • "cd_produto": 17,
  • "nm_produto": "Seguro Agrícola",
  • "id_pessoa_cliente": 998877,
  • "id_endereco": 1234,
  • "id_endosso": 5566,
  • "dt_inicio_vigencia": "2025-06-01",
  • "dt_fim_vigencia": "2026-05-31",
  • "dt_proposta": "2025-05-20",
  • "dt_vencimento_proposta": "2025-05-22",
  • "id_tp_subvencao": 1,
  • "nm_tp_subvencao": "Federal",
  • "qt_dias_vigencia": 365,
  • "Endosso": [
    ]
}

Consultar Lista de Apólices ou Proposta

Realiza a consulta de uma lista de apólices com dados resumidos, ou consulta uma proposta com dados resumidos. A busca pode ser realizada informando obrigatoriamente apenas um dos parâmetros: Número da apólice, número da proposta, corretor, status, início da vigência da apólice ou fim da vigência da apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados das apólices ou da proposta. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar uma lista apólices ou uma proposta, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_apolice
number

Número da apólice desejada para consulta.
O parâmetro “cd_proposta” não deve ser informado, pois ocorre conflito entre os parâmetros, devido a API realizar uma busca específica.
Para realizar uma consulta detalhada da apólice utilizar a API Consultar Apólice.

cd_proposta
number

Número da proposta desejada para consulta.
O parâmetro “cd_apolice” não deve ser informado, pois ocorre conflito entre os parâmetros, devido a API realizar uma busca específica.
Para realizar uma consulta detalhada da proposta utilizar a API Consultar Proposta.

id_pessoa_corretor
number

Código de identificação do corretor no sistema.
Pode ser obtido através da API APIs Compartilhadas | Consultar Corretor.
Caso informado apenas o parâmetro “id_pessoa_corretor”, a requisição irá buscar somente por apólices.

cd_status
number

Código de identificação do status da apólice.
7 = Emitida
8 = Cancel. Atenc. Vigência
9 = Cancelada
12 = Cancelado Por Inadimplência
13 = Em Proc. de Analise
14 = Suspensa
10 = Cancel. Inad. Sistema
11 = Cancelada por Sinistro
17 = Estudo fechado
18 = Em digitação
19 = Recusada
20 = Aguardando pagamento
21 = Proposta Cancelada
22 = Aguardando Faturamento Coletivo
23 = Proposta casada
24 = Suspensão Por Inadimplência

dt_inicio
string

Data do início da vigência da apólice.

dt_fim
string

Data do fim da vigência da apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Emissoes": [
    ]
}

Consultar Produto

Exibe os dados do produto desejado. Para realizar a consulta é necessário informar obrigatoriamente ao menos um dos parâmetros.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do produto. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de validação.

Para consultar um produto, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
number

Código de identificação do produto.
O parâmetro se torna obrigatório caso o parâmetro “nm_produto” não tenha sido informado.

nm_produto
string

Nome do produto.
O parâmetro se torna obrigatório caso o parâmetro cd_produto não tenha sido informado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaProdutoDetalhe": [
    ]
}

Consultar Cultivo

Realiza a busca dos cultivos cadastrados no sistema de gestão. Nenhum dos parâmetros é obrigatório, portanto, se nenhum parâmetro for informado, a consulta irá listar todos os cultivos cadastrados.

O parâmetro “nm_fruta_grao” funciona como uma pesquisa de cultivos. Ao informar parte do nome do cultivo no parâmetro, a resposta irá listar todos os cultivos encontrados no Sistema de Gestão que possuem o texto pesquisado, exemplo: Ao informar a palavra “Café” no parâmetro “nm_fruta_grao”, a resposta listará todos os cultivos que possuem a palavra café em seu nome.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de cultivos. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta a mensagem de erro.

Para consultar um cultivo, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
id_grp_cultivo
number

Código de identificação do grupo do cultivo. O parâmetro é opcional.

id_fruta_grao
number

Código de identificação do cultivo. O parâmetro é opcional.

nm_fruta_grao
string

Nome do cultivo. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Cultivos": [
    ]
}

Consultar Variedades do Cultivo

Realiza a consulta de variedades de um cultivo. Ao informar o código de identificação do cultivo, a requisição lista todas as variedades ativas do cultivo.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as variedades ativas no cultivo. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar as variedades, é necessário possuir o token de acesso e preencher o parâmetro contido na chamada da API, conforme detalhado a seguir.

query Parameters
id_fruta_grao
required
number

Código de identificação do cultivo. O parâmetro é obrigatório.
Pode ser obtido através da API Consultar Cultivo.

Responses

Response samples

Content type
application/json
{
  • "id_fruta_grao_variedade": 12,
  • "nm_fruta_grao_variedade": "Soja Precoce",
  • "id_grp_variedade": 3,
  • "nm_grp_variedade": "Grupo Precocidade",
  • "cd_fruta_grao_variedade": "SOJ-PRE-01"
}

Consultar Municípios Configurados no Cultivo

Realiza a busca dos municípios que possuem a configuração de nível de cobertura e produtividade no cultivo. Para realizar a consulta é necessário que ao menos um dos parâmetros a seguir seja informado obrigatoriamente: “id_grp_cultivo”, “id_fruta_grao” ou “nm_fruta_grao”.

Caso a sessão “Municípios” na resposta da consulta da API não exibir nenhum registro, indica que o município consultado não está configurado para o cultivo, portanto o seguro não poderá ser contratado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os municípios configurados no cultivo. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar os municípios configurados, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
id_grp_cultivo
number

Código de identificação do grupo de cultivo.
O parâmetro é obrigatório somente quando os parâmetros “id_fruta_grao” ou “nm_fruta_grao” não forem informados.

id_fruta_grao
number

Código de identificação do cultivo.
O parâmetro é obrigatório somente quando os parâmetros “id_grp_cultivo” ou “nm_fruta_grao” não forem informados.
Pode ser obtido através da API Consultar Cultivo.

nm_fruta_grao
string

Nome do cultivo.
O parâmetro é obrigatório somente quando os parâmetros “id_grp_cultivo” ou “id_fruta_grao” não forem informados.

cd_uf
number

Código de identificação do estado.
Pode ser obtido através da API Listar Estados.

nm_uf
string

Sigla do estado. O parâmetro é opcional.

nm_local
string

Nome do município. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "id_grp_cultivo": 10,
  • "id_fruta_grao": 3,
  • "nm_fruta_grao": "Soja",
  • "Municipios": [
    ]
}

Consultar Nível de Cobertura/Produtividade

Realiza a busca do nível de cobertura e produtividade para o cultivo no local desejado. Apenas o parâmetro “id_fruta_grao” é obrigatório, se informado este parâmetro, a API irá listar todas os níveis de cobertura e produtividade para os municípios configurados no cultivo.

Caso o município não possua nível de cobertura e produtividade configurado para o cultivo, será retornada a mensagem “Código 132000788: A pesquisa não retornou nenhum registro!”.

Os parâmetros “nr_cnpj_cpf” e “nr_cnpj_cpf_corretor” não devem ser utilizados por padrão, pois usualmente as configurações são realizadas por cultivo, sem especificar segurado e corretor. O uso destes parâmetros deve ocorrer somente em exceções em que a seguradora irá comunicar que a configuração do cultivo foi realizada especificamente por segurado e corretor.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados de nível de cobertura e produtividade. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar o nível de cobertura e produtividade, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
id_fruta_grao
required
number

Código de identificação do cultivo. O parâmetro é obrigatório.
Pode ser obtido através da API Consultar Cultivo.

id_local
number

Código de identificação do município. O parâmetro é opcional.
Pode ser obtido através da API Consultar Municípios Configurados no Cultivo.

cd_uf
number

Código de identificação do estado. O parâmetro é opcional.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nr_cnpj_cpf
string

CPF/CNPJ do segurado. O parâmetro é opcional.

nr_cnpj_cpf_corretor
string

CPF/CNPJ do corretor. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "id_fruta_grao": 3,
  • "id_local": 4106902,
  • "cd_uf": 41,
  • "nm_uf": "PR",
  • "nm_local": "Cornélio Procópio",
  • "nr_cep": "86300000",
  • "NivelCobertura": [
    ]
}

Consultar Tipo de Solo

Realiza a busca por todos os tipos de solo cadastrados no Sistema de Gestão. A requisição não requer parâmetros obrigatórios, portanto, a consulta pode ser realizada informando apenas a url do endpoint.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do tipo de solo. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar o nível de cobertura e produtividade, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
id_tp_solo
number

Código de identificação do tipo de solo. O parâmetro é opcional.

nm_solo
string

Nome do tipo de solo. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "TipoSolo": [
    ]
}

Consultar Subvenção Disponível Para o Cultivo

Realiza a busca da subvenções estadual ou federal disponíveis para o cultivo e o estado da propriedade que o item segurado está localizado. Todos os parâmetros são obrigatórios para realizar a consulta.

Caso a consulta retorne a mensagem "Código 132000788: A pesquisa não retornou nenhum registro!", é o indicativo de que não foram encontrados subvenção estadual ou federal disponíveis para o cultivo, portanto, o cultivo não está elegível para utilizar o benefício da subvenção na contratação do seguro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o tipo de subvenção disponível para o cultivo. Caso houver erro na chamada ou o cultivo não possuir subvenção, será retornado o status 400 (erro na requisição) e apresentará a mensagem de validação. Caso algum parâmetro não seja informado, será retornado o status 500 (Erro do servidor interno).

Para consultar as subvenções disponíveis para o cultivo, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
required
number

Código de identificação do produto.
Pode ser obtido através da API Consultar Produto.

id_fruta_grao
required
number

Código de identificação do cultivo.
Pode ser obtido através da API Consultar Cultivo.

cd_uf_propriedade
required
number

Código de identificação do estado onde a propriedade está localizada.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultaSubvencao": [
    ]
}

Consultar Regras do Produto

Exibe as regras ativas no produto. Para realizar a consulta é necessário informar obrigatoriamente ao menos um dos parâmetros “cd_produto” ou “nm_produto”.

Esta consulta é importante para verificar duas possíveis regras ativas no produto a ser utilizado na cotação/proposta, conforme detalhado abaixo:

  • Regra: 13200330 - Habilita alteração de I.S. no endosso:
    Se a API listar está regra como ativa para o produto consultado, o campo “vl_is” da cobertura deve ser informado ao inserir/alterar uma cotação/proposta. Se ao consultar a regra a mensagem “Código 132000788: A pesquisa não retornou nenhum registro!” for exibida, significa que o produto não possui a regra ativa, portanto o campo “vl_is” da cobertura não deve ser informado ao inserir/alterar uma cotação/proposta.

  • Regra: 13200016 - Calcula o valor do Prêmio Net e Tarifário somando valores das coberturas:
    Se a API listar está regra como ativa para o produto consultado, os campos “vl_premio_net”, “vl_premio_liquido” e “vl_premio_tarifario” da cobertura devem ser informados ao inserir/alterar uma cotação/proposta. Se ao consultar a regra a mensagem “Código 132000788: A pesquisa não retornou nenhum registro!” for exibida, significa que o produto não possui a regra ativa, portanto os campos “vl_premio_net”, “vl_premio_liquido” e “vl_premio_tarifario” da cobertura não devem ser informados ao inserir/alterar uma cotação/proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno as regras ativas do produto desejado. Caso a regra pesquisada não estiver ativa no produto ou ocorrer erros na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de validação.

Para consultar as regras do produto, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
number

Código de identificação do produto.
O parâmetro é obrigatório caso o parâmetro “nm_produto” não seja informado.
Pode ser obtido através da API Consultar Produto.

nm_produto
string

Nome do produto.
O parâmetro se torna obrigatório caso o parâmetro “cd_produto” não tenha sido informado.

nm_valor_regra
string

Valor da regra. O parâmetro é opcional.

cd_regra
number

Código de identificação da regra. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_regra": 13200016,
  • "nm_regra": "Cálculo de prêmio manual",
  • "dv_regra": true,
  • "nm_valor_regra": "HABILITADO",
  • "cd_usuario": "usuario.config",
  • "dt_sistema": "2025-11-28T14:35:00"
}

Consultar Perguntas do Questionário do Produto

Exibe os dados de perguntas do questionário do produto a nível de proposta e item de risco. É obrigatório informar o código de identificação do produto para realizar a consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de pergunta do questionário. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará na resposta o código e a mensagem de erro. Caso o parâmetro “cd_produto” não for informado será retornado o status 500 (Erro do servidor interno).

Para consultar as perguntas do questionário, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
required
number

Código de identificação do produto. O parâmetro é obrigatório.
Pode ser obtido através da API Consultar Produto.

id_tipo_questionario
number

Código de identificação do tipo de questionário. O parâmetro é opcional.
1 = Pergunta do questionário de proposta
2 = Pergunta do questionário do item de risco

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "QuestionarioProdutoListar": [
    ]
}

Consultar Respostas da Pergunta

Exibe os dados de respostas da pergunta do questionário do produto a nível de proposta e item de risco. Para exibir somente as respostas vinculadas a pergunta desejada, é necessário informar o parâmetro “id_produto_questionario” que pode ser obtido ao realizar consulta na API Consultar Perguntas do Questionário do Produto.

Não há necessidade de utilizar esta API quando a pergunta for do tipo “Resposta Aberta”, pois não há respostas a serem listadas, devido a pergunta possuir uma resposta de livre digitação. Uma pergunta do tipo “Resposta Aberta” pode ser identificada na API Consultar Perguntas do Questionário do Produto quando o campo “id_tp_pergunta” possuir o valor “1”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de resposta da pergunta do questionário. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem do erro.

Para consultar as respostas da pergunta do questionário, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
required
number

Código de identificação do produto. O parâmetro é obrigatório.
Pode ser obtido através da API Consultar Produto.

id_produto_questionario
number

Código de identificação da pergunta do questionário.
Pode ser obtido através da API Consultar Perguntas do Questionário do Produto.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso.",
  • "QuestionarioProdutoRespostaListar": [
    ]
}

Consultar Culturas SUSEP

A requisição busca por todas as culturas da base da SUSEP cadastradas no Sistema de Gestão. A requisição não requer parâmetros obrigatórios, portanto, a consulta pode ser realizada informando apenas a url do endpoint.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados de cultura da SUSEP. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar as culturas SUSEP, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_fruta_grao_cultura_susep
number

Código de identificação da cultura SUSEP. O parâmetro é opcional.

nm_fruta_grao_cultura_susep
string

Nome da cultura SUSEP. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "CulturaSusep": [
    ]
}

Consultar Unidade de Produto

Realiza a busca de todos os tipos de unidade de produto cadastrados no Sistema de Gestão. A requisição não requer parâmetros obrigatórios, portanto, a consulta pode ser realizada informando apenas a url do endpoint.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da unidade de produto. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar as unidades de produto, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_unidade
number

Código de identificação da unidade de produto. O parâmetro é opcional.

nm_unidade
string

Nome da unidade de produto. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "UnidadeProduto": [
    ]
}

Consultar Grupo de Produtos

Realiza a busca por grupos de produto cadastrados no sistema. A requisição não requer parâmetros obrigatórios, portanto, a consulta pode ser realizada informando apenas a url do endpoint.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do grupo de produto. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar os grupos de produto, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_produto
number

Código de identificação do produto. O parâmetro é opcional.
Pode ser obtido através da API Consultar Produto.

nm_produto
string

Nome do produto. O parâmetro é opcional.

cd_usuario
string

Login do usuário do corretor responsável pela venda. O parâmetro é opcional.

nm_usuario
string

Nome do usuário do corretor. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "id_grp_produto": 12,
  • "nr_grp_produto": 3,
  • "nm_grp_produto": "GRUPO AGRÍCOLA",
  • "Produto": [
    ]
}

Consultar Tipo de Cultura

A requisição realiza a busca por todos os tipos de cultura cadastrados no sistema. A requisição não requer parâmetros obrigatórios, portanto, a consulta pode ser realizada informando apenas a url do endpoint.

O tipo de cultura não é utilizado pela seguradora, portanto, a requisição está sendo documentada apenas para registro de informação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do tipo de cultura. Caso houver erro na chamada, será retornado o status 400 (erro na requisição) e apresentará a mensagem de erro.

Para consultar o tipo de cultura, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_tp_cultura
number

Código de identificação do tipo de cultura. O parâmetro é opcional.

nm_cultura
string

Nome do tipo de cultura. O parâmetro é opcional.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_tp_cultura": 1,
  • "nm_cultura": "OLEAGINOSAS"
}

Sinistros

Esta documentação descreve o comportamento das APIs utilizadas na criação de um aviso de sinistro para os diversos ramos do sistema de gestão. Cada grupo de ramo possui uma API de inclusão de aviso de sinistro específica.

As APIs de inclusão de avisos permite adicionar aos sinistros os movimentos de aviso de “Indenização”, “Despesas” e “Honorários” a cobertura indicada. Posteriormente, após incluir o sinistro, é possível adicionar novos movimentos para coberturas distintas.

Se houver alguma restrição aplicável à apólice ou ao cliente no momento da criação do aviso de sinistro, o sistema de gestão fará o registro inicial como um pré-aviso. O lançamento efetivo do sinistro será bloqueado. Para prosseguir, a Seguradora deverá realizar uma análise detalhada e executar a ação necessária para possibilitar que o pré-aviso seja transformado em um aviso de sinistro oficial.

Criar Aviso de Sinistro do Ramo Automóveis

Esta API permite criar um aviso de sinistro para o ramo automóveis, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo automóveis, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Veículo colidiu com outro automóvel em cruzamento.",
  • "nm_descricao_danos": "Amassamento na lateral direita e quebra do farol dianteiro.",
  • "nm_obs_sinistro": "Sem vítimas. Condutor apresentava CNH válida.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24T10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Risco de Engenharia

Esta API permite criar um aviso de sinistro para o ramo risco de engenharia, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo risco de engenharia, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Queda de estrutura em obra causando danos materiais.",
  • "nm_descricao_danos": "Danos em máquinas e equipamentos no canteiro de obras.",
  • "nm_obs_sinistro": "Sem vítimas. Área isolada após o evento.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Garantia

Esta API permite criar um aviso de sinistro para o ramo garantia, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo garantia, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Ocorrência de sinistro conforme relato do segurado.",
  • "nm_descricao_danos": "Descrição detalhada dos danos reclamados.",
  • "nm_obs_sinistro": "Observações adicionais sobre o sinistro.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro dos Ramos Patrimoniais

Esta API permite criar um aviso de sinistro para os ramos patrimoniais (residencial, empresarial e condomínio), possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro dos ramos patrimoniais, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Ocorrência de sinistro conforme relato do segurado.",
  • "nm_descricao_danos": "Descrição detalhada dos danos reclamados.",
  • "nm_obs_sinistro": "Observações adicionais sobre o sinistro.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Responsabilidades

Esta API permite criar um aviso de sinistro para o ramo responsabilidades, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo responsabilidades, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Ocorrência de sinistro conforme relato do segurado.",
  • "nm_descricao_danos": "Descrição detalhada dos danos reclamados.",
  • "nm_obs_sinistro": "Observações adicionais sobre o sinistro.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Riscos Diversos

Esta API permite criar um aviso de sinistro para os ramos riscos diversos (Equipamentos), possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro dos ramos riscos diversos, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Ocorrência de sinistro conforme relato do segurado.",
  • "nm_descricao_danos": "Descrição detalhada dos danos reclamados.",
  • "nm_obs_sinistro": "Observações adicionais sobre o sinistro.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Rural

Esta API permite criar um aviso de sinistro para o ramo rural, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo rural, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number
Value: 1

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_item
required
number

Código de identificação do item segurado.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nr_cnpj_cpf_perito
required
string

CPF/CNPJ do perito/vistoriador do item segurado após a ocorrência do sinistro.

dt_visita_perito
required
string

Data da visita do perito/vistoriador.

id_evento_sinistro
required
number
Enum: 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

Código do evento do sinistro vinculado ao MAPA (Ministério da Agricultura, Pecuária e Abastecimento).
63 = Chuva Excessiva
64 = Geada
65 = Granizo
66 = Incêndio
67 = Raio
68 = Seca
69 = Tromba D'água
70 = Variação Excessiva de Temperatura
71 = Ventos Fortes
72 = Ventos Frios
73 = Morte
74 = Inundação/Alagamento
75 = Queda de Aeronave
76 = Redução do Preço
77 = Não-Germinação
78 = Replantio
79 = Cura
80 = Perda de Qualidade
81 = Queda de Parreiral
82 = Tratamento Fitossanitário
83 = Perda de Produção
84 = Compreensiva de Florestas
85 = Madeira Cortada
86 = Despesas de Combate a Incêndio
87 = Desentulho
88 = Ajuste de Dano
89 = Raleio
90 = Dispensa de Frutos
91 = Reembolso de Salvamento
92 = Variação de Temperatura
93 = Variação de Preço
94 = Outros
95 = Baixa de Índice de Produtividade Forçada
96 = Faturamento Menor Garantido
97 = Doença
98 = Pragas

pe_perda_plantio
required
number

Porcentagem estimada de perda do plantio.

nr_produtividade_obtida
required
number

Produtividade obtida em quilos por hectare.

dt_inicio_plantacao
required
string

Data inicial do plantio.

dt_fim_plantacao
required
string

Data final do plantio.

nr_area_sinistrada
required
number

Área sinistrada em hectares do item de risco.

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number
Enum: 0 1

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

cd_moeda
required
number
Value: 1

Código de identificação da moeda no sistema.
1 = Real

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_item": 1001,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Estrada Municipal, Sítio Exemplo, Zona Rural",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "Londrina",
  • "nr_cnpj_cpf_perito": "12345678901",
  • "dt_visita_perito": "2025-11-25T09:00:00",
  • "id_evento_sinistro": 63,
  • "pe_perda_plantio": 35.5,
  • "nr_produtividade_obtida": 2500,
  • "dt_inicio_plantacao": "2025-09-01T00:00:00",
  • "dt_fim_plantacao": "2025-09-15T00:00:00",
  • "nr_area_sinistrada": 10,
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Chuva excessiva provocou alagamento da lavoura.",
  • "nm_descricao_danos": "Perda parcial da produção em função de encharcamento do solo.",
  • "nm_obs_sinistro": "Área vistoriada, aguarda laudo final do perito.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL",
  • "cd_moeda": 1
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Criar Aviso de Sinistro do Ramo Vida Individual

Esta API permite criar um aviso de sinistro para o ramo vida individual, possibilitando inserir os movimentos de indenização, despesas e honorários.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado, ou do pré-aviso devido a existência de alguma restrição. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para criar um aviso de sinistro do ramo vida individual, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme a lista detalhada a seguir.

Request Body schema: application/json
required
id_endosso
required
number

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

cd_apolice
required
number

Número da apólice de seguro.

id_sinistro_tipo
required
number
Value: 1

Código de identificação do tipo de sinistro.
1 = Administrativo

id_ramo
required
number

Código de identificação do ramo no sistema
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

id_pessoa_item
required
number

Código de identificação do item da pessoa segurada.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

nr_certificado
required
number

Número do certificado da pessoa segurada.

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

nr_sinistro_lider
string

Número do sinistro líder.
Informar somente se o aviso de sinistro possuir um sinistro líder.

nr_diarias
required
number

Número de dias hospitalizado.

vl_estimado
required
number

Valor estimado da indenização.
Adiciona o movimento de aviso de indenização ao sinistro com o valor informado.

vl_estimado_despesa
required
number

Valor estimado de despesas.
Adiciona o movimento de aviso de despesa ao sinistro com o valor informado.

vl_estimado_honorarios
required
number

Valor estimado de honorários.
Adiciona o movimento de aviso de honorários ao sinistro com o valor informado.

nm_reclamante
required
string

Nome da pessoa que reclamou o sinistro.

nr_fone_reclamante
required
string

Telefone do reclamante do aviso de sinistro.

nm_email_reclamante
required
string

E-mail do reclamante do aviso de sinistro.

nm_comunicante
required
string

Nome do comunicante do aviso de sinistro.

nr_fone_comunicante
required
string

Número do telefone do comunicante do aviso de sinistro.

nm_email_comunicante
required
string

E-mail do comunicante do aviso de sinistro.

id_sinistro_relacao
required
number

Código de identificação da relação do comunicante com o segurado.
Pode ser obtido através da API Consultar Lista de Relação Entre Comunicante e Segurado.

cd_causa
required
number

Código de identificação da causa do sinistro.
Pode ser obtido através da API Consultar Causas de Sinistro da Cobertura.

dt_comunicado
required
string

Data em que o sinistro foi comunicado.

dt_ocorrencia
required
string

Data em que o sinistro foi ocorreu.

hr_ocorrencia
required
string

Horário que o sinistro ocorreu.

nr_cnpj_cpf_sinistrado
required
string

CPF/CNPJ da pessoa sinistrada.

nm_local_ocorrencia
required
string

Endereço da ocorrência do sinistro

cd_uf_ocorrencia
required
number

Código de identificação do estado da ocorrência do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Listar Estados.

nm_cidade_ocorrencia
required
string

Cidade da ocorrência do sinistro

nm_email_corretor
required
string

E-mail do corretor da apólice.

nm_descricao_sinistro
required
string

Descrição da ocorrência do sinistro. Campo de livre digitação.

nm_descricao_danos
required
string

Descrição de danos do sinistro. Campo de livre digitação.

nm_obs_sinistro
required
string

Observação do sinistro. Campo de livre digitação.

nr_aviso_sinistro_central_atendimento
number

Número do protocolo gerado na central de atendimento. Informar somente se o aviso de sinistro possuir um atendimento efetuado na central de atendimentos.

dv_bo
required
number
Enum: 0 1

Indica se houve criação do boletim de ocorrência.
0 = Não foi criado boletim de ocorrência
1 = Boletim de ocorrência gerado.

nr_bo
string

Número do boletim de ocorrência.
Informar somente quando o campo “nr_bo” possuir o valor “1”.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "id_endosso": 123456,
  • "cd_apolice": 101910000001234,
  • "id_sinistro_tipo": 1,
  • "id_ramo": 17,
  • "id_pessoa_item": 987654,
  • "nr_certificado": 123456,
  • "id_produto_cobertura": 5001,
  • "nr_sinistro_lider": "2025000123",
  • "nr_diarias": 5,
  • "vl_estimado": 15000.5,
  • "vl_estimado_despesa": 500.75,
  • "vl_estimado_honorarios": 800,
  • "nm_reclamante": "João da Silva",
  • "nr_fone_reclamante": "+55 11 91234-5678",
  • "nm_email_reclamante": "reclamante@example.com",
  • "nm_comunicante": "Maria Oliveira",
  • "nr_fone_comunicante": "+55 11 99876-5432",
  • "nm_email_comunicante": "comunicante@example.com",
  • "id_sinistro_relacao": 3,
  • "cd_causa": 101,
  • "dt_comunicado": "2025-11-24T10:30:00",
  • "dt_ocorrencia": "2025-11-20T21:15:00",
  • "hr_ocorrencia": "21:15:00",
  • "nr_cnpj_cpf_sinistrado": "12345678901",
  • "nm_local_ocorrencia": "Rua Exemplo, 123, Bairro Centro",
  • "cd_uf_ocorrencia": 35,
  • "nm_cidade_ocorrencia": "São Paulo",
  • "nm_email_corretor": "corretor@example.com",
  • "nm_descricao_sinistro": "Ocorrência de sinistro conforme relato do segurado.",
  • "nm_descricao_danos": "Descrição detalhada dos danos reclamados.",
  • "nm_obs_sinistro": "Observações adicionais sobre o sinistro.",
  • "nr_aviso_sinistro_central_atendimento": 987654321,
  • "dv_bo": 1,
  • "nr_bo": "2025-BO-000123",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_evento": 123,
  • "dt_movimento": "2025-11-24 10:30:00",
  • "id_sin_movto": 98765,
  • "id_sinistro_preaviso": 54321,
  • "nr_sinistro": 101910000009999
}

Consultar Sinistro

Realiza a consulta de um aviso de sinistro criado. Permite realizar a consulta informando apenas um dos parâmetros obrigatoriamente “nr_sinistro”, “cd_apolice” ou “id_endosso”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do sinistro. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para consultar um sinistro, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme a lista detalhada a seguir.

query Parameters
nr_sinistro
number
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta.

cd_apolice
number
Example: cd_apolice=101910000001234

Número da apólice de seguro.

id_endosso
number
Example: id_endosso=123456

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultarSinistro_V2": [
    ]
}

Consultar Lista de Sinistros do Corretor

Realiza a consulta de uma lista de sinistros criados por corretor. Apenas o parâmetro “id_pessoa_corretor” é obrigatório. Para realizar uma consulta detalhada de um sinistro utilizar a API Consultar Sinistro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados dos sinistros. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para consultar os sinistros do corretor, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme a lista detalhada a seguir.

query Parameters
id_pessoa_corretor
required
number
Example: id_pessoa_corretor=123456

Código de identificação do corretor no sistema. Este é o único parâmetro obrigatório.
Buscar o campo “id_pessoa” através da API APIs Compartilhadas | Consultar Corretor.

nr_sinistro
string
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta.

cd_apolice
string
Example: cd_apolice=101910000001234

Número da apólice de seguro.

nr_endosso
number
Example: nr_endosso=1

Número do endosso.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

id_endosso
number
Example: id_endosso=123456

Código de identificação do endosso no sistema.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

nr_ramo
number
Example: nr_ramo=17

Número do ramo do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

nr_cnpj_cpf_segurado
string
Example: nr_cnpj_cpf_segurado=12345678901

CPF/CNPJ do segurado.

dt_comunicado
string
Example: dt_comunicado=2025-11-24T10:30:00

Data de comunicação do sinistro.

dt_ocorrencia
string
Example: dt_ocorrencia=2025-11-20T21:15:00

Data de ocorrência do sinistro.

offset
number

Elimina da consulta os primeiros sinistros listados na resposta da requisição.
Exemplo: Caso informe o valor “2”, os 2 primeiros sinistros que seriam listados na resposta são ocultados.

limit
number
Example: limit=10

Determina um número máximo de sinistros a serem listados na resposta.
Exemplo: Caso informe o valor “10”, a resposta da requisição irá listar no máximo 10 sinistros.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "snsp_consultar_sinistro_lote_ws_table_1": [
    ]
}

Consultar Pré-Aviso

Realiza a consulta de um pré-aviso criado. O parâmetro “id_pessoa_corretor” é obrigatório e deve ser informado junto ao “nr_pre_aviso” ou “nr_sinistro”.

A consulta de pré-aviso é permitida mesmo que o sinistro já tenha sido criado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do pré-aviso ou sinistro. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para consultar um pré-aviso, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme a lista detalhada a seguir.

query Parameters
id_pessoa_corretor
required
number
Example: id_pessoa_corretor=123456

Código de identificação do corretor no sistema. Este parâmetro obrigatório.
Buscar o campo “id_pessoa” através da API APIs Compartilhadas | Consultar Corretor.

nr_pre_aviso
string
Example: nr_pre_aviso=297

Número do pré-aviso de sinistro.

nr_sinistro
string
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "SinistroPreAviso": [
    ]
}

Consultar Lista de Pré-Avisos do Corretor

Realiza a consulta de uma lista de pré-avisos criados por corretor. Apenas o parâmetro “id_pessoa_corretor” é obrigatório. Para realizar uma consulta detalhada de um pré-aviso utilizar a API Consultar Pré-Aviso.

A consulta de lista de pré-aviso é permitida mesmo que o sinistro já tenha sido criado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados dos pré-avisos ou sinistros. Caso apresente erro, será retornado mensagem de validação para ajuste nos dados da requisição.

Para consultar os pré-avisos do corretor, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme a lista detalhada a seguir.

query Parameters
id_pessoa_corretor
required
number
Example: id_pessoa_corretor=123456

Código de identificação do corretor no sistema. Este é o único parâmetro obrigatório.
Buscar o campo “id_pessoa” através da API APIs Compartilhadas | Consultar Corretor.

nr_pre_aviso
string
Example: nr_pre_aviso=297

Número do pré-aviso de sinistro.

nr_sinistro
string
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta.

cd_apolice
string
Example: cd_apolice=101910000001234

Número da apólice de seguro.

cd_grupo_ramo
number
Example: cd_grupo_ramo=5

Código de identificação do grupo do ramo do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

nr_ramo
number
Example: nr_ramo=53

Número do ramo do sinistro.
Pode ser obtido através da API APIs Compartilhadas | Consultar Apólice.

cd_tipo_pessoa_segurado
number
Example: cd_tipo_pessoa_segurado=1

Código de identificação do tipo de pessoa do segurado.
Pode ser obtido ao buscar por “TipoPessoa” na API APIs Compartilhadas | Consulta de Domínios.

nr_cnpj_cpf_segurado
number
Example: nr_cnpj_cpf_segurado=35054994000103

CPF/CNPJ do segurado.

dt_comunicado_inicio
string
Example: dt_comunicado_inicio=2025-11-01T00:00:00

Filtro de data de comunicação. Informar a data inicial de comunicação do pré-aviso a ser buscado.

dt_comunicado_fim
string
Example: dt_comunicado_fim=2025-11-30T23:59:59

Filtro de data de comunicação. Informar a data final de comunicação do pré-aviso a ser buscado.

dt_ocorrencia_inicio
string
Example: dt_ocorrencia_inicio=2025-11-01T00:00:00

Filtro de data de ocorrência. Informar a data inicial de ocorrência do pré-aviso a ser buscado.

dt_ocorrencia_fim
string
Example: dt_ocorrencia_fim=2025-11-30T23:59:59

Filtro de data de ocorrência. Informar a data final de ocorrência do pré-aviso a ser buscado.

offset
number

Elimina da consulta os primeiros pré-avisos listados na resposta da requisição.
Exemplo: Caso informe o valor “2”, os 2 primeiros pré-avisos que seriam listados na resposta são ocultados.

limit
number
Example: limit=10

Determina um número máximo de pré-avisos a serem listados na resposta.
Exemplo: Caso informe o valor “10”, a resposta da requisição irá listar no máximo 10 pré-avisos.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "SinistroPreAviso": [
    ]
}

Transformar Pré-Aviso Em Sinistro

Esta API permite criar um aviso de sinistro transformando um pré-aviso existente no sistema de gestão.

Quando há restrições aplicáveisss à apólice ou ao cliente no momento da criação do aviso de sinistro, o sistema de gestão fará o registro como um pré-aviso, bloqueando a criação do sinistro. Para que seja possível transformar o pré-aviso desejado em um sinistro, a Seguradora deverá executar a ação necessária para possibilitar que a transformação do pré-aviso para sinistro seja possível.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do aviso de sinistro criado. Caso apresente erro, será retornado mensagem de validação.

Para transformar um pré-aviso em um sinistro, é necessário possuir o token de acesso e preencher o campo contido no corpo da requisição, conforme detalhado a seguir.

Request Body schema: application/json
required
id_sinistro_preaviso
required
number

Número do pré-aviso desejado.

Responses

Request samples

Content type
application/json
{
  • "id_sinistro_preaviso": 297
}

Response samples

Content type
application/json
{
  • "id_sinistro_preaviso": 297
}

Incluir Follow-Up

Esta API permite incluir follow-up em um sinistro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o código de identificação do follow-up inserido. Caso apresente erro, será retornado mensagem de validação.

Para incluir um follow-up no sinistro, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme lista detalhada a seguir.

Request Body schema: application/json
required
nr_sinistro
required
number

Número do sinistro que o follow-up será incluído.

id_tp_followup
required
number
Enum: 2 3 4 5 11 38 40 42 43 44 46 47 50 55 57 59 61

Código de identificação do tipo do follow-up.
2 = Investigação/Perícia
3 = Outros
4 = Recusa
5 = Cartas
11 = Pendência Documentação
38 = Solicitação de Documentos
40 = Solicitação de Documentos ao Segurado/Corretor
42 = Retorno Corretor
43 = Aviso Call Center
44 = Solicitações
46 = Comunicação Sinistro Direto Corretor
47 = Fornecimentos de Peças
50 = Pedido Encerramento de Sinistro
55 = Status do Processo
57 = Invalidez
59 = Solicitação de Vistoria/Regulação
61 = Informativo

ds_followup
required
string

Descrição do follow-up. Campo de livre digitação

id_pessoa_prestador
number

Código de identificação da pessoa que irá realizar a perícia.
Informar somente quando o tipo do follow-up for “2 = Investigação/Perícia”.
Pode ser obtido através do campo “id_pessoa” na resposta da API APIs Compartilhadas | Pesquisar Pessoa.

dt_inicio_pericia
string

Data inicial da pericia.
Informar somente quando o tipo do follow-up for “2 = Investigação/Perícia”.

dt_fim_pericia
string

Data final da pericia.
Informar somente quando o tipo do follow-up for “2 = Investigação/Perícia”.

Responses

Request samples

Content type
application/json
{
  • "nr_sinistro": 101910000009999,
  • "id_tp_followup": 2,
  • "ds_followup": "Contato realizado com o segurado para solicitar documentos adicionais.",
  • "id_pessoa_prestador": 987654,
  • "dt_inicio_pericia": "2025-11-25T09:00:00",
  • "dt_fim_pericia": "2025-11-25T11:00:00"
}

Response samples

Content type
application/json
{
  • "nr_sinistro": 101910000009999,
  • "id_tp_followup": 2,
  • "ds_followup": "Contato realizado com o segurado para solicitar documentos adicionais.",
  • "id_pessoa_prestador": 987654,
  • "dt_inicio_pericia": "2025-11-25T09:00:00",
  • "dt_fim_pericia": "2025-11-25T11:00:00"
}

Consultar Follow-Up

Realiza a consulta dos follow-ups incluídos em um sinistro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados dos follow-up do sinistro desejado. Caso apresente erro, será retornado mensagem de validação.

Para consultar os follow-ups do sinistro, é necessário possuir o token de acesso e preencher o parâmetro contido na chamada da API, conforme lista detalhada a seguir.

query Parameters
nr_sinistro
required
string
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta. O campo é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "snsp_consultar_followup_sinistro_ws_table_1": [
    ]
}

Incluir Movimento no Sinistro

Permite incluir um movimento no sinistro. É possível adicionar novos movimentos de aviso de “Indenização”, “Despesas” ou “Honorários” para outras coberturas da apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o movimento inserido. Caso apresente erro, será retornado mensagem de validação.

Para incluir um movimento no sinistro, é necessário possuir o token de acesso e preencher os campos contidos no corpo da requisição, conforme lista detalhada a seguir.

Request Body schema: application/json
required
nr_sinistro
required
number

Número do sinistro que o movimento será incluído.

cd_evento
required
number
Enum: 10101 12001 13001

Código de identificação do movimento de aviso a ser lançado no sinistro.
10101 = Aviso de Indenização
12001 = Aviso de despesas
13001 = Aviso de honorários

id_produto_cobertura
required
number

Código de identificação da cobertura do item segurado.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

cd_moeda
required
number
Value: 1

Código de identificação da moeda no sistema.
1 = Real

vl_operacao
required
number

Valor do movimento de aviso a ser incluído.

nm_observacao
string

Observação. Campo de livre digitação.

nm_login_usuario
required
string

Login do usuário de inclusão do aviso de sinistro.

Responses

Request samples

Content type
application/json
{
  • "nr_sinistro": 101910000009999,
  • "cd_evento": 10101,
  • "id_produto_cobertura": 5001,
  • "cd_moeda": 1,
  • "vl_operacao": 15000.5,
  • "nm_observacao": "Observações adicionais sobre o movimento de sinistro.",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Response samples

Content type
application/json
{
  • "nr_sinistro": 101910000009999,
  • "cd_evento": 10101,
  • "id_produto_cobertura": 5001,
  • "cd_moeda": 1,
  • "vl_operacao": 15000.5,
  • "nm_observacao": "Observações adicionais sobre o movimento de sinistro.",
  • "nm_login_usuario": "USUARIO_PORTAL"
}

Consultar Movimentos do Sinistro

Realiza a consulta dos movimentos incluídos em um sinistro. Somente o parâmetro “nr_sinistro” é obrigatório, se informado apenas o número de sinistro, todos os movimentos cadastrados no sinistro serão listados.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os movimentos do sinistro desejado. Caso apresente erro, será retornado mensagem de validação.

Para consultar os movimentos do sinistro, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
nr_sinistro
required
string
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta. O campo é obrigatório.

cd_grp_evento
required
number
Enum: 1000 1200 1300
Example: cd_grp_evento=1000

Código de identificação do grupo de movimento.
1000 = Grupo de Indenização
1200 = Grupo de Despesas
1300 = Grupo de Honorários

cd_evento
required
number
Enum: 10101 12001 13001
Example: cd_evento=10101

Código de identificação do movimento de aviso a ser lançado no sinistro.
10101 = Aviso de Indenização
12001 = Aviso de despesas
13001 = Aviso de honorários

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "snsp_consultar_movimento_sinistro_ws_table_1": [
    ]
}

Consultar Pagamentos do Sinistro

Realiza a consulta dos movimentos de pagamento do sinistro. Somente o parâmetro “nr_sinistro” é obrigatório, se informado apenas o número de sinistro, todos os movimentos de pagamento do sinistro serão listados. A consulta também pode ser realizada informando o CPF/CNPJ do beneficiário ou favorecido junto ao número do sinistro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os movimentos de pagamento do sinistro desejado. Caso apresente erro, será retornado mensagem de validação.

Para consultar os movimentos de pagamento do sinistro, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
nr_sinistro
required
number
Example: nr_sinistro=101910000009999

Número do sinistro desejado para consulta. O campo é obrigatório.

nr_cnpj_cpf_favorecido
string
Example: nr_cnpj_cpf_favorecido=35054994000103

CPF/CNPJ do favorecido do pagamentos de despesas ou honorários.
Caso informe o CPF/CNPJ do favorecido, o campo “nr_cnpj_cpf_beneficiario” não poderá ser informado.

nr_cnpj_cpf_beneficiario
string
Example: nr_cnpj_cpf_beneficiario=12345678901

CPF/CNPJ do beneficiário do pagamento de indenização.
Caso informe o CPF/CNPJ do beneficiário, o campo “nr_cnpj_cpf_favorecido” não poderá ser informado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "ConsultarPagamentoSinistro_V2_table_1": [
    ]
}

Consultar Vigência dos Endossos da Apólice

Lista todos os endossos com vigência ativa da apólice no momento da ocorrência do sinistro. Todos os parâmetros são obrigatórios para realizar a consulta.

Se a consulta não apresentar nenhum endosso, indica que a apólice não possui vigência para a data de ocorrência do sinistro, portanto não será possível criar o aviso de sinistro.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a vigência dos endossos da apólice. Caso apresente erro, será retornado mensagem de validação.

Para consultar a vigência dos endossos da apólice, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_apolice
required
string
Example: cd_apolice=101910000001234

Número da apólice que ocorreu o sinistro a ser avisado. Campo é obrigatório.

dt_ocorrencia
required
string
Example: dt_ocorrencia=2025-11-20T21:15:00

Data de ocorrência do sinistro. Campo é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Endossos": [
    ]
}

Consultar Itens Segurados no Endosso

Lista todos os itens segurados no endosso. Somente o parâmetro “id_endosso” é obrigatório para realizar a consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará a itens segurados dos endossos da apólice. Caso apresente erro, será retornado mensagem de validação.

Para consultar os itens do endosso, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_apolice
required
number
Example: cd_apolice=101910000001234

Número da apólice que ocorreu o sinistro a ser avisado.

id_endosso
required
number
Example: id_endosso=19608

Código de identificação do endosso no sistema. Campo é obrigatório.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Itens": [
    ]
}

Consultar Coberturas do Item Segurado

Lista todas as coberturas que o item segurado possui. Os parâmetros “id_endosso” e “id_item” são obrigatórios para realizar a consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as coberturas do item segurado. Caso apresente erro, será retornado mensagem de validação.

Para consultar as coberturas de um item segurado, é necessário possuir o token de acesso e preencher os parâmetros contidos na chamada da API, conforme lista detalhada a seguir.

query Parameters
cd_apolice
required
number
Example: cd_apolice=101910000001234

Número da apólice que ocorreu o sinistro a ser avisado.

id_endosso
required
number
Example: id_endosso=19608

Código de identificação do endosso no sistema. Campo é obrigatório.
Pode ser obtido através da API Consultar Vigência dos Endossos da Apólice.

id_item
required
number
Example: id_item=1001

Código de identificação do item segurado. Campo é obrigatório.
Pode ser obtido através da API Consultar Itens Segurados no Endosso.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Coberturas": [
    ]
}

Consultar Causas de Sinistro da Cobertura

Lista todas as causas de sinistro vinculadas a cobertura do item. O parâmetro “id_produto_cobertura” é obrigatório para realizar a consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as causas vinculadas a cobertura do item segurado. Caso apresente erro, será retornado mensagem de validação.

Para consultar as causas, é necessário possuir o token de acesso e preencher o parâmetro contido na chamada da API, conforme lista detalhada a seguir.

query Parameters
id_produto_cobertura
required
number
Example: id_produto_cobertura=5001

Código de identificação da cobertura. Campo é obrigatório.
Pode ser obtido através da API Consultar Coberturas do Item Segurado.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Causas": [
    ]
}

Consultar Lista de Relação Entre Comunicante e Segurado

Lista todos as relações possíveis que a pessoa que comunicou o sinistro pode ter com o segurado da apólice sinistrada. A requisição não possui parametrização, ao realizar a consulta todas as relações cadastradas no sistema de gestão serão exibidas.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará as relações possíveis do comunicante com o segurado.

Para consultar as relações, é necessário possuir o token de acesso.

Exemplo de envio da requisição.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Relacao": [
    ]
}

Vida Individual

Neste documento é descrito o funcionamento das APIs do módulo Vida individual utilizadas para incluir uma cotação, proposta e apólice no Sistema de Gestão, abrangendo todas as etapas do processo.

No fluxo abaixo são demonstradas as etapas para a emissão de uma apólice de Vida Individual vinculadas ao Sistema de Gestão.

Para visualizar o fluxo em outra aba, clique com o botão direito sobre a imagem e selecione “Abrir imagem em uma nova guia”.

Inserir Cotação

Realiza a inclusão de uma cotação do ramo Vida Individual.

Para incluir a cotação, além de possuir o token de acesso, o usuário deve informar o código do produto, o código das coberturas, os dados do segurado, o corretor a ser utilizado e se necessário o cônjuge do segurado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da cotação inserida. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

A requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
nm_login
required
string

Login do usuário a incluir a cotação.

nr_cpf_cnpj_corretor
number

CNPJ/CPF do corretor.

id_pessoa_corretor
number

Código de identificação do corretor no sistema.
Obter em APIs Compartilhadas | Consultar Corretor se necessário.

id_responsavel_venda
number

Código de identificação do usuário responsável pela venda.
Obter em APIs Compartilhadas | Consultar Usuário do Corretor se necessário.

nm_proponente
required
string

Nome do segurado.

nm_proponente_social
string

Nome social do segurado.

nr_cpf
required
string

CPF do segurado.

dt_nasc
required
string

Data de nascimento do segurado.

cd_sexo
required
number

Código de identificação do gênero do segurado.
Consultar “sexo” na API de Consultar Domínios Vida Individual se necessário.

nr_ddd
required
number

DDD do telefone do segurado.

nr_telefone
required
string

Número do telefone do segurado.

nm_email
required
string

E-mail do segurado.

id_perfil
number

Indica se o segurado é fumante. Informar “1” para não fumante. Informar “2” para fumante.
Consultar “perfil” na API de Consultar Domínios Vida Individual se necessário.

cd_profissao
required
number

Código de identificação da profissão no sistema.
Consultar “profissao” na API de Consultar Domínios Vida Individual se necessário.

cd_produto
required
number

Número do produto no sistema.
Consultar o nome do produto em APIs Compartilhadas | Consultar Produto se necessário.

id_canal_venda
required
number

Código de identificação do canal de venda no sistema. Informar o valor “2”.

vl_renda_mensal
required
number

Renda mensal do segurado.

cd_atividade_esportiva
number

Código de identificação da atividade esportiva que o segurado pratica no sistema.
Consultar “atividade_esportiva” na API de Consultar Domínios Vida Individual se necessário.

fl_seg_vida_vigente
boolean

Indica se o segurado possui um seguro de vida vigente. Informar “true” se possuir, “false” caso contrário.

id_seguradora
number

Código de identificação da seguradora em que o segurado possui o seguro de vida vigente. Informar somente se fl_seg_vida_vigente=true.
Consultar “seguradora” na API de Consultar Domínios Vida Individual se necessário.

vl_capital_outra_seguradora
number

Valor do seguro de vida vigente do segurado. Informar somente se fl_seg_vida_vigente=true.

id_agenciador
number

Código de identificação do agenciador no sistema.
Obter em APIs Compartilhadas | Pesquisar Pessoa se necessário.

nr_perc_corretor
number

Percentual de comissão do corretor.

nr_perc_agenciador
number

Percentual de comissão do agenciador.

id_estado_civil
number

Código de identificação do estado civil do segurado.
Consultar “estado_civil” na API de Consultar Domínios Vida Individual se necessário.

nm_conjuge
string

Nome do cônjuge do segurado.

nm_conjuge_social
string

Nome social do cônjuge do segurado.

nr_cpf_conjuge
string

CPF do cônjuge do segurado.

cd_sexo_conj
number

Código de identificação do gênero do cônjuge do segurado.
Consultar “sexo” na API de Consultar Domínios Vida Individual se necessário.

dt_nasc_conj
string

Data de nascimento do cônjuge do segurado.

id_perfil_conj
number

Indica se o cônjuge do segurado é fumante.
Informar “1” para não fumante. Informar “2” para fumante.
Consultar “perfil” na API de Consultar Domínios Vida Individual se necessário.

qt_filho
number

Quantidade de filhos do segurado.

required
Array of objects (SviV8_InserirCotacao_CoberturaDto)

Lista de coberturas da cotação.

Responses

Request samples

Content type
application/json
{
  • "nm_login": "usuario@teste.com",
  • "nr_cpf_cnpj_corretor": "12345678000199",
  • "id_pessoa_corretor": 456,
  • "id_responsavel_venda": 789,
  • "nm_proponente": "João da Silva",
  • "nm_proponente_social": "Joana Silva",
  • "nr_cpf": "12345678901",
  • "dt_nasc": "1985-05-20T00:00:00",
  • "cd_sexo": 1,
  • "nr_ddd": 11,
  • "nr_telefone": "987654321",
  • "nm_email": "joao@email.com",
  • "id_perfil": 1,
  • "cd_profissao": 321,
  • "cd_produto": 1141,
  • "id_canal_venda": 2,
  • "vl_renda_mensal": 5000.75,
  • "cd_atividade_esportiva": 12,
  • "fl_seg_vida_vigente": true,
  • "id_seguradora": 45,
  • "vl_capital_outra_seguradora": 100000,
  • "id_agenciador": 789,
  • "nr_perc_corretor": 10,
  • "nr_perc_agenciador": 5,
  • "id_estado_civil": 1,
  • "nm_conjuge": "Maria da Silva",
  • "nm_conjuge_social": "Marina da Silva",
  • "nr_cpf_conjuge": "98765432100",
  • "cd_sexo_conj": 2,
  • "dt_nasc_conj": "1987-07-15T00:00:00",
  • "id_perfil_conj": 1,
  • "qt_filho": 2,
  • "InserirCotacaoCobertura": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_chave_externa": 12345,
  • "id_simulador_cotacao": 67890,
  • "nr_cotacao": 202500123
}

Alterar Cotação

Realiza a alteração de uma cotação do ramo Vida Individual. O Alterar Cotação não permite mudar o segurado, produto, comissão do corretor e agenciador informados ao inserir a cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da cotação alterada. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para alterar uma cotação, além de possuir o token de acesso, devem ser informados os seguintes campos listados abaixo.

Request Body schema: application/json
required
nr_cotacao
required
number

Número da cotação a ser alterada.

nm_login
required
string

Login do usuário a incluir a cotação.

nr_cpf_cnpj_corretor
required
number

CNPJ/CPF do corretor.

id_responsavel_venda
number

Código de identificação do usuário responsável pela venda.
Obter em APIs Compartilhadas | Consultar Usuário do Corretor se necessário.

cd_profissao
required
number

Código de identificação da profissão no sistema.
Consultar “profissao” na API de Consultar Domínios Vida Individual se necessário.

vl_renda_mensal
required
number

Renda mensal do segurado.

cd_atividade_esportiva
number

Código de identificação da atividade esportiva que o segurado pratica no sistema.
Consultar “atividade_esportiva” na API de Consultar Domínios Vida Individual se necessário.

fl_seg_vida_vigente
required
boolean

Indica se o segurado possui um seguro de vida vigente.
true = possui; false = não possui.

vl_capital_outra_seguradora
required
number

Valor do seguro de vida vigente do segurado.
Informar somente se fl_seg_vida_vigente=true.

id_estado_civil
number

Código de identificação do estado civil do segurado.
Consultar “estado_civil” na API de Consultar Domínios Vida Individual se necessário.

nm_conjuge
string

Nome do cônjuge do segurado.

nr_cpf_conjuge
number

CPF do cônjuge do segurado.

cd_sexo_conj
number

Código de identificação do gênero do cônjuge do segurado.
Consultar “sexo” na API de Consultar Domínios Vida Individual se necessário.

dt_nasc_conj
string <date-time>

Data de nascimento do cônjuge do segurado.

id_perfil_conj
number

Indica se o cônjuge do segurado é fumante.
1 = não fumante; 2 = fumante.
Consultar “perfil” na API de Consultar Domínios Vida Individual se necessário.

qt_filho
number

Quantidade de filhos do segurado.

required
Array of objects (SviV8_AlterarCotacao_CoberturaDto)

Lista de coberturas da cotação.

Responses

Request samples

Content type
application/json
{
  • "nr_cotacao": 123456,
  • "nm_login": "usuario@teste.com",
  • "nr_cpf_cnpj_corretor": 12345678000199,
  • "id_responsavel_venda": 789,
  • "cd_profissao": 321,
  • "vl_renda_mensal": 5000.75,
  • "cd_atividade_esportiva": 12,
  • "fl_seg_vida_vigente": true,
  • "vl_capital_outra_seguradora": 100000,
  • "id_estado_civil": 1,
  • "nm_conjuge": "Maria da Silva",
  • "nr_cpf_conjuge": 98765432100,
  • "cd_sexo_conj": 2,
  • "dt_nasc_conj": "1987-07-15T00:00:00",
  • "id_perfil_conj": 1,
  • "qt_filho": 2,
  • "AlterarCotacaoCobertura": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_simulador_cotacao": 67890
}

Salvar Cotação

Salva uma cotação inserida anteriormente. Esta etapa é necessária para que seja possível transformar a cotação em proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso.

Para salvar a cotação, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

Request Body schema: application/json
required
nr_cotacao
required
number

Número da cotação a ser salva.

Responses

Request samples

Content type
application/json
{
  • "nr_cotacao": 123456
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Consultar Cotação

Realiza consulta de uma cotação, sendo obrigatório informar o número da cotação e o CPF/CNPJ do corretor, ou, o login do usuário de inclusão da cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para consultar uma cotação, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario@teste.com

Login do usuário de inclusão da cotação. Campo é obrigatório somente se o campo “nr_cpf_cnpj_corretor” não for informado.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678000199

CPF/CNPJ do corretor. Campo é obrigatório somente se o campo “nm_login” não for informado.

nr_cotacao
required
number
Example: nr_cotacao=123456

Número da cotação a ser consultada. Campo é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Infos_Simulacao": [
    ]
}

Consultar Lista de Cotações Resumida

Realiza consulta de uma lista de cotações apresentadas de forma resumida. Para obter os dados de uma cotação de forma detalhada utilizar a requisição Consultar Cotação.

É necessário informar obrigatoriamente apenas um dos campos disponíveis na requisição.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das cotações.

Para consultar uma cotação, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario@teste.com

Login do usuário de inclusão da cotação.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678000199

CPF/CNPJ do corretor.

nr_cpf
string
Example: nr_cpf=12345678901

CPF do segurado.

nm_proponente
string
Example: nm_proponente=João da Silva

Nome do segurado.

cd_status
number
Example: cd_status=1

Código de identificação do status da cotação no sistema.
Consultar “status_simulacao” na API de Consultar Domínios Vida Individual se necessário.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Infos_Simulacao_Resumo": [
    ]
}

Imprimir Formulário de Cotação

Disponibiliza a impressão do formulário da cotação criada em código base64 no formato PDF.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Em caso de erro na chamadas será retornado mensagem com a correção necessária.

Para imprimir a cotação, além de possuir o token de acesso, o usuário deve informar o seguinte parâmetro listado abaixo.

query Parameters
nr_cotacao
number
Example: nr_cotacao=123456789

Número da cotação a ser impressa.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_simulador_cotacao": 67890,
  • "nr_simulador": 12345,
  • "id_periodo_premio": 12,
  • "cd_empresa": 101,
  • "id_relatorio": 2024,
  • "CotacaoValores": {
    }
}

Inserir Proposta

Transforma em proposta uma cotação salva. Para inserir a proposta, a cotação criada deve ser salva através da API Salvar Cotação.

Para alterar os dados da proposta, é necessário utiliza a API Alterar Proposta, o inserir proposta somente transforma uma cotação salva em proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da proposta inserida.

Para inserir a proposta, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
nr_cotacao
number

Número da cotação salva.

id_periodicidade_pagamento
number

Código de identificação da periodicidade de pagamento. Informar “1” para pagamento com parcelamento em “1 + 11” (12 vezes), sendo 1 parcela de entrada e 11 parcelas mensais. Informar “7” para pagamento “à vista”.

Responses

Request samples

Content type
application/json
{
  • "nr_cotacao": 123456,
  • "id_periodicidade_pagamento": 1
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "dv_questionario": true,
  • "id_proposta": 12345,
  • "nr_proposta": 1822211183
}

Alterar Proposta

Realiza a alteração de uma proposta do ramo Vida Individual.

O Alterar Proposta também é utilizado para adicionar o beneficiário, a forma de pagamento da proposta e responder o questionário da Declaração Pessoal de Saúde (DPS), pois, somente é possível realizar a inclusão destes dados nesta etapa, portanto a execução da API Alterar Proposta é obrigatória para realizar a emissão da apólice.

O Questionário e Respostas da Declaração Pessoal de Saúde (DPS) deve ser obtido através da API Consultar Proposta. Caso o produto não exija o preenchimento da DPS, o resultado da API Consultar Proposta não apresentará dados de questionário.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso e dados da proposta.

Para alterar a proposta, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
nr_proposta
required
number

Número da proposta no sistema.

dt_assinatura
string <date-time>

Data de assinatura.

dt_protocolo
string <date-time>

Data do protocolo.

dt_inicio_vigencia
string <date-time>

Data de início de vigência do seguro.

cd_tp_assinatura
number

Código de identificação do tipo de assinatura. Consultar “tipo_assinatura” na API de Consultar Domínios Vida Individual se necessário.

nm_pessoa
string

Nome do segurado.

nm_pessoa_social
string

Nome social do segurado.

id_estado_civil
number

Código de identificação do estado civil do segurado. Consultar “estado_civil” na API de Consultar Domínios Vida Individual se necessário.

nm_conjuge
string

Nome do cônjuge do segurado.

nr_cpf_conjuge
number

CPF do cônjuge do segurado.

dt_nasc_conjuge
string <date-time>

Data de nascimento do cônjuge do segurado.

cd_sexo_conjuge
number

Código de identificação do gênero do cônjuge do segurado. Consultar “sexo” na API de Consultar Domínios Vida Individual se necessário.

fl_ppe
required
boolean

Informa se o segurado é politicamente exposto. Deve ser true ou false. Se true o segurado é uma pessoa politicamente exposta. Se false o segurado não é uma pessoa politicamente exposta.

fl_relaciona_ppe
boolean

Informa se o segurado se relaciona com uma pessoa politicamente exposta. Deve ser true ou false. Se true o segurado se relaciona com uma pessoa politicamente exposta. Se false o segurado não se relaciona com uma pessoa politicamente exposta.

nm_ppe
string

Nome da pessoa politicamente exposta. Informar somente se o campo “fl_relaciona_ppe” for true.

fl_aceita_ce
boolean

Informa se o segurado aceita receber correspondência eletrônica. Deve ser true ou false. Se true o segurado receberá correspondência eletrônica. Se false o segurado não receberá correspondência eletrônica.

fl_endereco_exterior
boolean

Informa se o segurado possui endereço no exterior. Deve ser true ou false. Se true o segurado possui endereço no exterior. Se false o segurado não possui endereço no exterior.

nm_endereco_exterior
string

Endereço do segurado no exterior. Informar somente se o campo “fl_endereco_exterior” for true.

cd_pais_nacionalidade
required
number

Código de identificação da nacionalidade do segurado. Consultar “nacionalidade” na API de Consultar Domínios Vida Individual se necessário.

nr_altura
required
number

Altura do segurado.

vl_peso
required
number

Peso do segurado.

nr_rg
string

Número do RG do segurado.

dt_emissao_rg
string <date-time>

Data de emissão do RG do segurado.

nm_orgao_emissor
string

Órgão emissor do RG do segurado.

nr_cnh
string

Número da CNH do segurado.

dt_primeira_cnh
string <date-time>

Data da primeira CNH do segurado.

dt_validade_cnh
string <date-time>

Data de validade da CNH do segurado.

nr_passaporte
string

Número do passaporte do segurado.

cd_nacionalidade_passaporte
number

Código de identificação da nacionalidade do passaporte do segurado. Consultar “nacionalidade” na API de Consultar Domínios Vida Individual se necessário.

nm_empresa
string

Nome da empresa em que o segurado trabalha ou é sócio.

nr_empresa_cnpj
string

CNPJ da empresa do segurado.

vl_renda_mensal
required
number

Renda mensal bruta do segurado.

vl_renda_mensal_liquida
number

Renda mensal liquida do segurado.

vl_renda_bruta_anual
number

Renda anual bruta do segurado.

fl_outra_fonte_renda
boolean

Informa se o segurado possui outra fonte de renda. Deve ser true ou false. Se true o segurado possui outra fonte de renda. Se false o segurado não possui outra fonte de renda.

id_outra_fonte_renda
number

Código de identificação da outra fonte de renda. Informar somente se o campo “fl_outra_fonte_renda” for true.

vl_outra_fonte_renda
number

Valor da outra fonte de renda. Informar somente se o campo “fl_outra_fonte_renda” for true.

fl_diferenca_peso
boolean

Informa se houve aumento ou diminuição de peso do segurado, de 10 quilos ou mais, durante os últimos 6 meses? Deve ser true ou false. Se true o segurado teve aumento ou diminuição de peso. Se false o segurado não teve aumento ou diminuição de peso.

nr_cigarro_dia
number

Número de cigarros fumados por dia pelo segurado.

id_perfil_conjuge
number

Indica se o cônjuge do segurado é fumante. Informar “1” para não fumante. Informar “2” para fumante. Consultar “perfil” na API de Consultar Domínios Vida Individual se necessário.

qt_filho
number

Quantidade de filhos do segurado.

Array of objects (SviV8_AlterarProposta_AlterarEnderecoItemDto)

Lista de endereços para alteração/inclusão.

Array of objects (SviV8_AlterarProposta_AlterarComunicacaoItemDto)

Lista de meios de comunicação para alteração/inclusão.

object (SviV8_AlterarProposta_FilhoWrapperDto)

Filhos do segurado.

Array of objects (SviV8_AlterarProposta_AlterarBeneficiarioItemDto)

Lista de beneficiários da proposta.

object (SviV8_AlterarProposta_ParticipanteWrapperDto)

Participantes associados à proposta.

object (AlterarCobrancaDto)

Dados de cobrança da proposta.

Array of objects (SviV8_AlterarProposta_InserirFollowupItemDto)

Follow-ups a serem inseridos na proposta.

Array of objects (SviV8_AlterarProposta_AlterarCoberturaItemDto)

Coberturas a serem alteradas/selecionadas.

required
object (SviV8_AlterarProposta_AlterarQuestionarioWrapperDto)

Questionário de saúde/avaliação associado à proposta.

Array of objects (SviV8_AlterarProposta_InserirDocumentoItemDto)

Documentos a serem inseridos na proposta.

Array of objects (SviV8_AlterarProposta_AlterarCorretorItemDto)

Corretores a serem vinculados/alterados. Indica qual operação será realizada com o corretor informado. O corretor pode ser incluído, alterado e excluído. Se o “id_tp_operacao” não for informado, nenhuma alteração será feita nos dados dos corretores. O campo aceita os seguintes valores: “A” => Alterar o corretor; “I” => Incluir um corretor; “E” => Excluir o corretor;

Responses

Request samples

Content type
application/json
{
  • "nr_proposta": 1001401301819,
  • "dt_assinatura": "2025-09-28T00:00:00",
  • "dt_protocolo": "2025-09-29T00:00:00",
  • "dt_inicio_vigencia": "2025-10-01T00:00:00",
  • "cd_tp_assinatura": 1,
  • "nm_pessoa": "João da Silva",
  • "nm_pessoa_social": "Joana da Silva",
  • "id_estado_civil": 1,
  • "nm_conjuge": "Maria da Silva",
  • "nr_cpf_conjuge": 98765432100,
  • "dt_nasc_conjuge": "1987-07-15T00:00:00",
  • "cd_sexo_conjuge": 2,
  • "fl_ppe": false,
  • "fl_relaciona_ppe": false,
  • "nm_ppe": "Autoridade X",
  • "fl_aceita_ce": true,
  • "fl_endereco_exterior": false,
  • "nm_endereco_exterior": "221B Baker Street, London",
  • "cd_pais_nacionalidade": 1058,
  • "nr_altura": 1.75,
  • "vl_peso": 80.5,
  • "nr_rg": "1234567-8",
  • "dt_emissao_rg": "2010-01-01T00:00:00",
  • "nm_orgao_emissor": "SSP-SP",
  • "nr_cnh": "99999999999",
  • "dt_primeira_cnh": "2005-01-01T00:00:00",
  • "dt_validade_cnh": "2030-01-01T00:00:00",
  • "nr_passaporte": "AB1234567",
  • "cd_nacionalidade_passaporte": 1058,
  • "nm_empresa": "Empresa XYZ LTDA",
  • "nr_empresa_cnpj": "12345678000199",
  • "vl_renda_mensal": 5000.75,
  • "vl_renda_mensal_liquida": 4200.5,
  • "vl_renda_bruta_anual": 60000,
  • "fl_outra_fonte_renda": false,
  • "id_outra_fonte_renda": 2,
  • "vl_outra_fonte_renda": 1200,
  • "fl_diferenca_peso": false,
  • "nr_cigarro_dia": 0,
  • "id_perfil_conjuge": 1,
  • "qt_filho": 2,
  • "AlterarEndereco": [
    ],
  • "AlterarComunicacao": [
    ],
  • "Filho": {
    },
  • "AlterarBeneficiario": [
    ],
  • "participante": {
    },
  • "AlterarCobranca": {
    },
  • "InserirFollowup": [
    ],
  • "AlterarCobertura": [
    ],
  • "AlterarQuestionario": {
    },
  • "InserirDocumento": [
    ],
  • "AlterarCorretor": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta": 101234,
  • "nm_chave_valores": "VALORES_PROP_2025",
  • "AlterarEndereco": [
    ],
  • "AlterarComunicacao": [
    ],
  • "Filho": {
    },
  • "AlterarBeneficiario": [
    ],
  • "participante": {
    },
  • "AlterarCobranca": { },
  • "AlterarDadosCobrancaComplementar": { },
  • "InserirFollowup": [
    ],
  • "AlterarCobertura": [
    ],
  • "AlterarQuestionario": {
    },
  • "InserirDocumento": [
    ],
  • "AlterarCorretor": [
    ],
  • "checklist": {
    }
}

Efetivar Proposta

Realiza a efetivação da proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso.

Para efetivar a proposta, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

Request Body schema: application/json
required
nr_proposta
required
number

Número da proposta.

Responses

Request samples

Content type
application/json
{
  • "nr_proposta": 1001401301819
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Inserir Follow-Up Vida Individual

Realiza a inserção de follow-ups em propostas de produtos do ramo vida individual.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do follow-up inserido. Caso houver erro na chamada, será retornado o status e apresentará na resposta a mensagem de erro.

Para inserir o follow-up, além de possuir o token de acesso, o usuário deve informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
id_proposta
number

Código de identificação da proposta.

nm_descricao_fup
required
string

Descrição de livre digitação do follow-up.

dt_inclusao_fup
required
string

Data de inclusão do follow-up.

id_usuario
number

Código de identificação do usuário a incluir follow-up.

Responses

Request samples

Content type
application/json
{
  • "id_proposta": 1801368538,
  • "nm_descricao_fup": "Contato realizado com o cliente",
  • "dt_inclusao_fup": "2025-09-04T10:15:30",
  • "id_usuario": 1234
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Consultar Status da Proposta

Realiza a consulta do status atual da proposta. A API permite consultar o status de mais de uma proposta por chamada, pois aceita uma lista de números de proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o status e Follow-Ups da proposta.

Para consultar o status da proposta, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
nr_proposta
required
Array of numbers
Example: nr_proposta=130000000004054&nr_proposta=130000000004055

Número da proposta.
Pode repetir: ?nr_proposta=130...&nr_proposta=130...

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Proposta

Realiza consulta de uma proposta, sendo obrigatório informar o número da proposta e o CPF/CNPJ do corretor, ou, o login do usuário de inclusão.

O Questionário e Respostas da Declaração Pessoal de Saúde (DPS) é obtido através desta consulta. Caso o produto não possua DPS, o resultado não apresentará dados de questionário.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da proposta.

Para consultar uma proposta, além de possuir o token de acesso, o usuário pode informar os seguintes parâmetros listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario_teste

Login do usuário de inclusão. Obrigatório somente se “nr_cpf_cnpj_corretor” não for informado.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678901

CPF/CNPJ do corretor. Obrigatório somente se “nm_login” não for informado.

nr_proposta
required
number
Example: nr_proposta=1822211183

Número da proposta a ser consultada. Campo obrigatório.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Lista de Propostas Resumida

Realiza consulta de uma lista de propostas apresentadas de forma resumida. Para obter os dados de uma proposta de forma detalhada utilizar a requisição Consultar Proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das propostas.

Para consultar uma proposta, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario.teste

Login do usuário de inclusão. Campo é obrigatório somente se “nr_cpf_cnpj_corretor” não for informado.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678901

CPF/CNPJ do corretor. Campo é obrigatório somente se “nm_login” não for informado.

nr_proposta
number
Example: nr_proposta=1822211183

Número da proposta desejada.

cd_status
number
Example: cd_status=1

Código de identificação do status da proposta no sistema. Consultar a API Consultar Status da Proposta se necessário.

nm_pessoa
string
Example: nm_pessoa=João da Silva

Nome do segurado.

nr_cpf
string
Example: nr_cpf=12345678901

CPF do segurado.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Imprimir Formulário de Proposta

Disponibiliza a impressão do formulário da proposta criada em código base64 no formato PDF. A requisição possui 2 parâmetros, sendo necessário informar apenas 1 parâmetro obrigatoriamente.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso. Em caso de erro na chamadas será retornado mensagem com a correção necessária.

Para imprimir a proposta, além de possuir o token de acesso, o usuário deve informar os seguintes parâmetros listados abaixo.

query Parameters
id_proposta
number
Example: id_proposta=12345

Código de identificação da proposta a ser impressa.

nr_proposta
number
Example: nr_proposta=130000000004054

Número da proposta a ser impressa.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta": 12345,
  • "id_relatorio": 6789,
  • "cd_empresa": 10,
  • "pdf_documento": {
    }
}

Cancelar Proposta

A requisição realiza o cancelamento de uma proposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso.

Para cancelar uma proposta, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

Request Body schema: application/json
required
nr_proposta
number

Número da proposta a ser cancelada.

Responses

Request samples

Content type
application/json
{
  • "nr_proposta": 1822211183
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Emitir Apólice ao Assinar Proposta

A API realiza a confirmação da assinatura da proposta, informando a data da assinatura e a forma utilizada para a assinatura.

Após confirmado assinatura, a API realiza a emissão da proposta para apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e realizará a emissão da proposta para apólice.

Para realizar a emissão de apólice, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

Request Body schema: application/json
required
nr_proposta
required
number

Número da proposta a ser emitida.

dt_assinatura
required
string <date-time>

Data da assinatura da proposta.

cd_tp_assinatura
required
number

Código de identificação do tipo de assinatura.
Consultar “tipo_assinatura” na API de Consultar Domínios Vida Individual se necessário.

ds_lk_documento
string

Descrição, campo de livre digitação.

nm_login
required
string

Login do usuário de inclusão.

Responses

Request samples

Content type
application/json
{
  • "nr_proposta": 1822211183,
  • "dt_assinatura": "2025-09-28T14:30:00",
  • "cd_tp_assinatura": 1,
  • "ds_lk_documento": "Assinado digitalmente pelo segurado.",
  • "nm_login": "usuario.teste"
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "cd_status_output": 1,
  • "ds_status": "Assinatura realizada com sucesso",
  • "id_proposta": 12345,
  • "nr_proposta_output": 1822211183
}

Consultar Apólice

Realiza consulta de uma apólice, sendo obrigatório informar o número da apólice e o CPF/CNPJ do corretor, ou, o login do usuário de inclusão.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da apólice.

Para consultar uma apólice, além de possuir o token de acesso, o usuário pode informar os seguintes parâmetros listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario.teste

Login do usuário de inclusão. Campo é obrigatório somente se “nr_cpf_cnpj_corretor” não for informado.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678901

CPF/CNPJ do corretor. Campo é obrigatório somente se “nm_login” não for informado.

nr_apolice
required
number
Example: nr_apolice=1011401000758

Número da apólice a ser consultada. Campo é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Infos_Apolice": [
    ]
}

Consultar Coberturas da Apólice

Realiza consulta de uma lista de apólices com as coberturas contidas, sendo obrigatório informar apenas um dos parâmetros da requisição para consulta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados de cobertura da apólice.

Para consultar as coberturas da apólice, além de possuir o token de acesso, o usuário pode informar os seguintes parâmetros listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario.teste

Login do usuário de inclusão.

nr_cpf_proponente
string
Example: nr_cpf_proponente=12345678901

CPF do segurado.

nr_apolice
number
Example: nr_apolice=1011401000758

Número da apólice.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso"
}

Consultar Lista de Apólices Resumida

Realiza consulta de uma lista de apólice apresentadas de forma resumida. Para obter os dados de uma apólice de forma detalhada utilizar a requisição Consultar Apólice.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados das apólices.

Para consultar uma apólice, além de possuir o token de acesso, o usuário pode informar os seguintes campos listados abaixo.

query Parameters
nm_login
string
Example: nm_login=usuario.teste

Login do usuário de inclusão. Campo é obrigatório somente se “nr_cpf_cnpj_corretor” não for informado.

nr_cpf_cnpj_corretor
number
Example: nr_cpf_cnpj_corretor=12345678901

CPF/CNPJ do corretor. Campo é obrigatório somente se “nm_login” não for informado.

nr_apolice
number
Example: nr_apolice=1011401000758

Número da apólice desejada.

nm_proponente
string
Example: nm_proponente=João da Silva

Nome do segurado.

nm_proponente_social
string
Example: nm_proponente_social=Joana da Silva

Nome social do segurado.

nr_cpf
string
Example: nr_cpf=12345678901

CPF do segurado.

cd_status
number
Example: cd_status=1

Código de identificação do status da apólice no sistema.
Consultar “status_apolice” na API de Consultar Domínios Vida Individual se necessário.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Infos_Apolice": [
    ]
}

Imprimir Formulário de Apólice

Disponibiliza a impressão do formulário da apólice em código base64 no formato PDF.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o código Base64 do formulário da apólice.

Para imprimir a apólice, além de possuir o token de acesso, o usuário deve informar os seguintes parâmetros listados abaixo.

query Parameters
cd_apolice
number
Example: cd_apolice=1011401000758

Número da apólice a ser impressa. Campo é obrigatório.

nr_aditivo
number
Example: nr_aditivo=1

Número do endosso a ser impresso. Campo é obrigatório.

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_apolice": 12345,
  • "id_relatorio": 6789,
  • "cd_empresa": 10,
  • "id_apolice_adtv": 999,
  • "pdf_documento": {
    }
}

Consultar Domínios Vida Individual

Esta requisição realiza a consulta dos domínios do módulo Vida Individual do Sistema de Gestão. Os domínios retornados são: Atividade esportiva, estado civil, nacionalidade, pais, perfil, profissão, seguradora, sexo, status de apólice, status de cotação, tipo de assinatura, tipo de convênio bancário, tipo de documento da proposta, tipo de endereço, tipo de parentesco, tipo do produtor, tipo de renda, estado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os cadastros do domínio consultado.

Para consultar domínios do vida individual, além de possuir o token de acesso, o usuário deve informar o seguinte campo listado abaixo.

query Parameters
nm_dominio
string
Example: nm_dominio=estado_civil

Nome do domínio a ser buscado. Caso o campo não seja informado, será listado todos os domínios disponíveis para consulta.
Podem ser informados os seguintes domínios para consulta: atividade_esportiva, estado_civil, nacionalidade, pais, perfil, profissao, seguradora, sexo, status_apolice, status_simulacao, tipo_assinatura, tipo_convenio_bancario, tipo_documento_proposta, tipo_endereco, tipo_parentesco, tipo_produtor, tipo_renda, uf

Responses

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "Info_Dominio": [
    ],
  • "ConsultaDominioTable2": [
    ],
  • "ConsultaDominioTable3": [
    ],
  • "ConsultaDominioTable4": [
    ],
  • "ConsultaDominioTable5": [
    ],
  • "ConsultaDominioTable6": [
    ],
  • "ConsultaDominioTable7": [
    ],
  • "ConsultaDominioTable8": [
    ],
  • "ConsultaDominioTable9": [
    ],
  • "ConsultaDominioTable10": [
    ],
  • "ConsultaDominioTable11": [
    ],
  • "ConsultaDominioTable12": [
    ],
  • "ConsultaDominioTable13": [
    ],
  • "ConsultaDominioTable14": [
    ],
  • "ConsultaDominioTable15": [
    ],
  • "ConsultaDominioTable16": [
    ],
  • "ConsultaDominioTable17": [
    ],
  • "ConsultaDominioTable18": [
    ],
  • "ConsultaDominioTable19": [
    ]
}

Consultar Coberturas do Produto

Realiza consulta das coberturas configuradas no produto. Todos os parâmetros são obrigatórios para obter a resposta.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o os dados de cobertura do produto. Caso apresente erro, será retornado status 400 (erro) com a mensagem de erro para ajuste na requisição.

Para consultar as coberturas, além de possuir o token de acesso, o usuário deve informar os seguintes parâmetros listados abaixo.

query Parameters
cd_produto
required
number
Example: cd_produto=20

Código do produto no sistema.
O campo é obrigatório.
Consultar o nome do produto em APIs Compartilhadas | Consultar Produto se necessário.

dt_nascimento
required
string <date-time>
Example: dt_nascimento=1985-02-10T00:00:00

Data de nascimento do segurado que pretende contratar a cobertura.
O campo é obrigatório.

cd_profissao
required
number
Example: cd_profissao=1234

Código de identificação da profissão do segurado que pretende contratar a cobertura no sistema.
O campo é obrigatório.
Consultar “profissao” na API de Consultar Domínios Vida Individual se necessário.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gerar Proposta Direta

Realiza a geração direta de uma proposta, pulando a etapa da cotação.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará o número da proposta gerada.

Para gerar a proposta diretamente, além de possuir o token de acesso, a requisição é composta pelos seguintes campos listados abaixo.

Request Body schema: application/json
required
nm_login
required
string

Login do usuário a incluir a proposta.

nr_cpf_cnpj_corretor
required
number

CNPJ/CPF do corretor.

nm_proponente
required
string

Nome do segurado.

nm_social_proponente
string

Nome social do segurado.

nr_documento
required
string

CPF do segurado.

dt_nasc
required
string <date-time>

Data de nascimento do segurado.

cd_sexo
required
number

Código de identificação do gênero do segurado.
Consultar “sexo” na API de Consultar Domínios Vida Individual se necessário.

id_estado_civil
required
number

Código de identificação do estado civil do segurado.
Consultar “estado_civil” na API de Consultar Domínios Vida Individual se necessário.

cd_pais_nacionalidade
required
number

Código de identificação da nacionalidade do segurado.
Consultar “nacionalidade” na API de Consultar Domínios Vida Individual se necessário.

nr_ddd
number

DDD do telefone do segurado.

nr_telefone
string

Número do telefone do segurado.

nm_email
string

E-mail do segurado.

id_perfil
required
number

Indica se o segurado é fumante.
Informar “1” para não fumante.
Informar “2” para fumante.
Consultar “perfil” na API de Consultar Domínios Vida Individual se necessário.

cd_profissao
required
number

Código de identificação da profissão no sistema.
Consultar “profissao” na API de Consultar Domínios Vida Individual se necessário.

cd_produto
required
number

Número do produto no sistema.
Consultar o nome do produto em APIs Compartilhadas | Consultar Produto se necessário.

id_canal_venda
required
number

Código de identificação do canal de venda no sistema.
Informar o valor “2”.

vl_renda_mensal
number

Renda mensal do segurado.

nr_rg
string

Número do RG do segurado.

dt_emissao_rg
string <date-time>

Data de emissão do RG do segurado.

nm_orgao_emissor
string

Órgão emissor do RG do segurado.

nr_cnh
string

Número da CNH do segurado.

dt_primeira_cnh
string <date-time>

Data da primeira CNH do segurado.

dt_validade_cnh
string <date-time>

Data de validade da CNH do segurado.

nr_passaporte
string

Número do passaporte do segurado.

cd_nacionalidade_passaporte
string

Código de identificação da nacionalidade do passaporte do segurado.
Consultar “nacionalidade” na API de Consultar Domínios Vida Individual se necessário.

required
Array of objects (SviV8_Proposta_EnderecoDto)

Endereços do segurado.

required
Array of objects (SviV8_Proposta_CoberturaDto)

Coberturas da proposta.

required
object (SviV8_Proposta_CobrancaDto)

Dados de cobrança.

required
Array of objects (SviV8_Proposta_BeneficiarioDto)

Beneficiários da proposta.

required
Array of objects (SviV8_Proposta_FollowupDto)

Follow-ups da proposta.

required
Array of objects (SviV8_Proposta_ComunicacaoDto)

Meios de comunicação do segurado.

required
Array of objects (SviV8_Proposta_CorretorDto)

Corretores associados à proposta.

Responses

Request samples

Content type
application/json
{
  • "nm_login": "usuario.teste",
  • "nr_cpf_cnpj_corretor": 12345678901,
  • "nm_proponente": "João da Silva",
  • "nm_social_proponente": "Joana da Silva",
  • "nr_documento": "12345678901",
  • "dt_nasc": "1985-02-10T00:00:00",
  • "cd_sexo": 1,
  • "id_estado_civil": 2,
  • "cd_pais_nacionalidade": 76,
  • "nr_ddd": 11,
  • "nr_telefone": "999999999",
  • "nm_email": "cliente@email.com",
  • "id_perfil": 1,
  • "cd_profissao": 1234,
  • "cd_produto": 20,
  • "id_canal_venda": 2,
  • "vl_renda_mensal": 15000.75,
  • "nr_rg": "123456789",
  • "dt_emissao_rg": "2010-01-10T00:00:00",
  • "nm_orgao_emissor": "SSP-SP",
  • "nr_cnh": "XYZ12345",
  • "dt_primeira_cnh": "2005-05-01T00:00:00",
  • "dt_validade_cnh": "2030-05-01T00:00:00",
  • "nr_passaporte": "AB1234567",
  • "cd_nacionalidade_passaporte": "BR",
  • "endereco": [
    ],
  • "cobertura": [
    ],
  • "cobranca": {
    },
  • "beneficiario": [
    ],
  • "followup": [
    ],
  • "comunicacao": [
    ],
  • "corretor": [
    ]
}

Response samples

Content type
application/json
{
  • "cd_retorno": 0,
  • "nm_retorno": "Operação realizada com sucesso",
  • "id_proposta_ws": 9876,
  • "proposta": [
    ]
}