Logo da Sancor Seguros
API docs by Redocly

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

Download OpenAPI specification:

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

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
number

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
number

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
number

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
number

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
number

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

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
number

Código de cadastro do corretor no sistema

Responses

Response samples

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

Vida Flexível

Consulta de Domínios

Authorizations:
requestAuthorizer
query Parameters
nmDominio
required
string
Enum: "profissao" "perfil" "sexo" "estado_civil" "tipo_parentesco" "uf" "nacionalidade" "renda_mensal" "tipo_endereco"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta de Coberturas

Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta de Carregamentos

Authorizations:
requestAuthorizer
query Parameters
cdUsuario
required
string
cdProduto
string^[0-9]+$
tipoCarregamento
string
idTpCarregamento
string^[0-9]+$

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Busca de dados do Corretor

Authorizations:
requestAuthorizer
query Parameters
cdUsuario
required
string

Responses

Response samples

Content type
application/json
{
  • "idUsuario": 0,
  • "dadosCorretor": [
    ]
}

Criação de Cotação

Authorizations:
requestAuthorizer
Request Body schema: application/json
cdUsuario
required
string
nmLogin
required
string
nrCpfCnpjCorretor
required
string
idPessoaCorretor
required
number
idResponsavelVenda
required
number
nmProponente
required
string
nmPessoaSocial
string
nrCpf
required
string
dtNasc
required
string

yyyy-mm-dd

cdSexo
required
number
nrDdd
number
nrTelefone
string
nmEmail
string
idPerfil
required
number
cdProfissao
required
number
vlRendaMensal
required
number
nrPercCorretor
required
number
nrPercAgenciador
required
number
idEstadoCivil
number
object
qtFilho
number
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "cdUsuario": "string",
  • "nmLogin": "string",
  • "nrCpfCnpjCorretor": "string",
  • "idPessoaCorretor": 0,
  • "idResponsavelVenda": 0,
  • "nmProponente": "string",
  • "nmPessoaSocial": "string",
  • "nrCpf": "string",
  • "dtNasc": "yyyy-mm-dd",
  • "cdSexo": 0,
  • "nrDdd": 0,
  • "nrTelefone": "string",
  • "nmEmail": "string",
  • "idPerfil": 0,
  • "cdProfissao": 0,
  • "vlRendaMensal": 0,
  • "nrPercCorretor": 0,
  • "nrPercAgenciador": 0,
  • "idEstadoCivil": 0,
  • "conjuge": {
    },
  • "qtFilho": 0,
  • "coberturas": [
    ]
}

Response samples

Content type
application/json
{
  • "nrCotacao": 0
}

Consulta de Endereços

Authorizations:
requestAuthorizer
path Parameters
cep
required
string
Example: 66082105

Código do CEP contendo somente 8 digitos

Responses

Response samples

Content type
application/json
{
  • "nmEndereco": "string",
  • "nmBairro": "string",
  • "idLocal": "string",
  • "nmUf": "string",
  • "nmCidade": "string"
}

Consulta de Formas de Pagamento

Authorizations:
requestAuthorizer
query Parameters
cdUsuario
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta de Periodicidade de Pagamento

Authorizations:
requestAuthorizer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Criação de Proposta

Authorizations:
requestAuthorizer
Request Body schema: application/json
nrCotacao
required
number
idPeriodicidadePagamento
required
number
nmLogin
required
string
nrCpfCnpjCorretor
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "nrCotacao": 0,
  • "idPeriodicidadePagamento": 0,
  • "nmLogin": "string",
  • "nrCpfCnpjCorretor": "string",
  • "alterarProposta": {
    }
}

Response samples

Content type
application/json
{
  • "idProposta": 0,
  • "nrProposta": 0
}

Impressão de Cotação

Authorizations:
requestAuthorizer
query Parameters
nrCotacao
required
string^[0-9]+$
cdUsuario
required
string

Responses

Response samples

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

Impressão de Proposta

Authorizations:
requestAuthorizer
query Parameters
idProposta
string^[0-9]+$
nrProposta
string^[0-9]+$

Responses

Response samples

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

Impressão de Apólice

Authorizations:
requestAuthorizer
query Parameters
cdApolice
required
string^[0-9]+$

Responses

Response samples

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

Apis Agro

Consultar Apólice

Realiza a consulta de dados de uma apólice.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

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á na resposta o código e a mensagem de erro. Se o parâmetro cd_apolice não for informado, a resposta apresentará o status 500 (Erro do servidor interno).

Authorizations:
IBM_App_ID_Token
query Parameters
cd_apolice
required
number

Número da apólice desejada para consulta.

cd_usuario_venda
string

Código de identificação do usuário do corretor que realizou a venda.

Responses

Response samples

Content type
application/json
{
  • "id_apolice": 0,
  • "cd_apolice": 0,
  • "cd_proposta": 0,
  • "nr_cotacao": 0,
  • "cd_tp_origem": 0,
  • "cd_tp_apolice": 0,
  • "cd_status": 0,
  • "nm_status": "string",
  • "cd_filial": 0,
  • "cd_produto": 0,
  • "nm_produto": "string",
  • "id_pessoa_cliente": 0,
  • "id_endereco": 0,
  • "id_endosso": 0,
  • "dt_inicio_vigencia": "string",
  • "dt_fim_vigencia": "string",
  • "dt_proposta": "string",
  • "dt_vencimento_proposta": "string",
  • "id_tp_subvencao": 0,
  • "nm_tp_subvencao": "string",
  • "qt_dias_vigencia": 0,
  • "Endosso": [
    ],
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Inserir Apólice

A requisição realiza a emissão de apólice de uma proposta efetivada.

No cabeçalho da requisição deverá e ser informado o token de acesso.

O corpo da requisição contém apenas o campo id_endosso, neste campo deve ser informado o código de identificação do endosso da 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 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.

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

Código de identificação do endosso da proposta efetivada

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Consulta Nível Cobertura

Realiza a busca do nível de cobertura para o cultivo no local desejado. Apenas o parâmetro id_fruta_grao é obrigatório, neste caso, o sistema irá listar todas os níveis de cobertura cadastrados no cultivo.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de nível de cobertura. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
id_fruta_grao
required
number

Código de identificação do cultivo.

id_local
number

Código de identificação do município.

cd_uf
number

Código de identificação do estado.

nr_cnpj_cpf
string

CPF/CNPJ do segurado.

nr_cnpj_cpf_corretor
string

CPF/CNPJ do corretor.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta Subvenção

A requisição de consultar subvenção busca a subvenção federal e estadual disponível com base no cultivo e o estado da propriedade do segurado. Nesta requisição, todos os parâmetros são obrigatórios.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados de subvenção. 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 não informe algum dos parâmetros será retornado o status 500 (Erro do servidor interno).

Authorizations:
IBM_App_ID_Token
query Parameters
cd_produto
required
number

Código de identificação do produto.

id_fruta_grao
required
number

Código de identificação do cultivo.

cd_uf_propriedade
required
number

Código de identificação do estado.

Responses

Response samples

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

Consultar Contrato Subvenção

Exibe os dados do contrato de subvenção desejado, sendo necessário informar obrigatoriamente o número do contrato da subvenção a ser consultada.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do contrato de subvenção. 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 não informe o parâmetro “nr_contrato” será retornado o status 500 (Erro do servidor interno).

Authorizations:
IBM_App_ID_Token
query Parameters
nr_contrato
required
string

Número do contrato de subvenção.

dv_exibir_municipio
boolean

Exibe informações de município, deve possuir o valor true ou false. Caso o valor for true, as informações de município serão exibidas na resposta.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Cultivo Município

Realiza a busca dos municípios cadastrados para o cultivo desejado. Ao informar o código de identificação do grupo do cultivo, o código de identificação do cultivo ou o nome do cultivo, a requisição busca as variedades ativas do cultivo.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization. Para realizar a consulta é necessário informar obrigatoriamente um dos parâmetros id_grp_cultivo, id_fruta_grao ou nm_fruta_grao.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados dos municípios do cultivo. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
id_grp_cultivo
number

Código de identificação do grupo de cultivo. O parâmetro é obrigatório, caso os parâmetros id_fruta_grao ou nm_fruta_grao não tenham sido informados.

id_fruta_grao
number

Código de identificação do cultivo. O parâmetro é obrigatório, caso os parâmetros id_grp_cultivo ou nm_fruta_grao não tenham sido informados.

nm_fruta_grao
string

Nome do cultivo. O parâmetro é obrigatório, caso os parâmetros id_grp_cultivo ou id_fruta_grao não tenham sido informados.

cd_uf
number

Código de identificação do estado.

nm_uf
string

Nome do estado.

nm_local
string

Nome do Município.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Cultura Susep

A requisição busca por todos as culturas SUSEP cadastradas no sistema. Nenhum dos parâmetros é obrigatório, portanto, a consulta de cultura pode ser realizada apenas chamando diretamente a API CulturaSusep.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados da cultura SUSEP. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_fruta_grao_cultura_susep
number

Código de identificação da cultura SUSEP.

nm_fruta_grao_cultura_susep
string

Nome da cultura SUSEP.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Efetivar Proposta

A requisição realiza a efetivação da proposta. A efetivação torna possível emitir a apólice e realizar o registro da primeira parcela na instituição financeira. Dado que a efetivação da proposta seja realizada, não será mais permitido alterar dados da proposta.

No cabeçalho da requisição deverá e ser informado o token de acesso.

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á na resposta o código e a mensagem de erro.

Authorizations:
IBM_App_ID_Token
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.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Lista Proposta Apólice

Lista dados de propostas e apólices do corretor desejado. A busca pode ser realizada informando o número da proposta, o número da apólice, o corretor ou a data de início e fim de vigência. Pelo menos um dos parâmetros deve ser informado.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados da apólice ou proposta informada. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_apolice
required
number

Número da apólice desejada para consulta. Caso informado o campo cd_apolice, o campo cd_proposta não deve ser informado.

cd_proposta
number

Número da proposta desejada para consulta. Caso informado o campo cd_proposta, o campo cd_apolice não deve ser informado.

id_pessoa_corretor
number

Código de identificação do corretor. Caso informado apenas o id_pessoa_corretor, a requisição irá buscar somente por apólices.

cd_status
number

Código do status da proposta ou apólice.

dt_inicio
string

Data de início de vigência da proposta ou apólice. Caso informado apenas o dt_inicio, a requisição irá buscar somente por apólices

dt_fim
string

Data de fim de vigência da proposta ou apólice. Caso informado apenas o dt_inicio, a requisição irá buscar somente por apólices

Responses

Response samples

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

Inserir Proposta

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

Para realizar a chamada do inserir proposta é necessário possui r o token de acesso do usuário do corretor e escolher qual será a forma de pagamento e parcelamento a ser utilizada na proposta.

Será necessário informar novamente os dados já informados ao criar a cotação e algumas novas que serão descritas na tabela abaixo.

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.

Authorizations:
IBM_App_ID_Token
Request Body schema: application/json
required
Array
nr_cotacao
number

Número da cotação a ser transformada em proposta.

cd_produto
required
number

Código do produto a ser disponibilizado.

cd_tp_origem
required
number

Código do tipo de origem deve ser “2”, referente ao tipo de origem “Cotação”.

cd_filial
required
number

Código da filial Sancor a ser disponibilizado, exemplo: cd_filial “3” referente a Sancor Matriz.

cd_tp_resseguro_aberto
required
number

Tipo de resseguro da proposta. Informar “6”, neste caso o seguro será retido apenas pela seguradora.

id_canal_venda
number

Canal de venda da proposta. Campo não utilizado.

id_pessoa_cliente
required
number

Código de identificação do cliente a ser segurado na cotação. Deve ser buscado através da chamada de API a ser disponibilizada.

id_endereco
required
number

Código de identificação do endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

dv_busca_cep
boolean

Deve ser “True” ou “False”. Realiza a busca do CEP informado caso o valor do campo seja “True”.

id_tp_endereco
number

Código de identificação do tipo de endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

nm_cep_livre
string

CEP do endereço do cliente.

nm_endereco_livre
string

Nome da rua do endereço do cliente.

nm_bairro_bcep
string

Bairro do endereço do cliente.

nm_complemento_bcep
string

Complemento do endereço do cliente.

nr_rua_endereco_bcep
number

Número do endereço do cliente.

nm_cidade_bcep
string

Cidade do endereço do cliente.

cd_uf_bcep
number

Código do estado a ser disponibilizado do endereço do cliente.

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. Buscar através da API Produto.

dt_vencimento_pparcela
required
string

Data de vencimento da 1ª parcela.

cd_forma_pagamento_pparcela
required
number

Código da forma de pagamento da 1ª parcela. Buscar através da API Produto.

cd_forma_pagamento
required
number

Código da forma de pagamento das demais parcelas, quando houver. Buscar através da API Produto.

id_conta_corrente
number

Código de identificação da conta corrente do pagador. Necessário informar somente quando a forma de pagamento for do tipo débito em conta.

nr_dia_cobranca
number

Dia de cobrança das demais parcelas, quando houver.

nm_texto_livre
string

Campo de livre digitação.

nm_texto_anexo
string

Campo de livre digitação.

cd_usuario_venda
required
string

Código do usuário do corretor responsável pela cotação.

qt_dias_vigencia
number

Quantidade de dias de vigência do seguro.

required
Array of objects (ApiRur_PostProposta_Req_Corretor)
Array of objects (ApiRur_PostProposta_Req_DadosBeneficiario)
required
Array of objects (ApiRur_PostProposta_Req_DadosRisco)
Array of objects (ApiRur_PostProposta_Req_SubvencaoManual)
Array of objects (ApiRur_PostProposta_Req_QuestionarioItem)
object (ApiRur_PostProposta_Req_TipoCarregamento)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Proposta

Esta requisição realiza a consulta de uma proposta.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

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 o código e a mensagem de erro. Se o parâmetro cd_proposta não for informado, a resposta apresentará o status 500 (Erro do servidor interno).

Authorizations:
IBM_App_ID_Token
query Parameters
cd_proposta
required
number

Número da proposta desejada para consulta.

cd_usuario_venda
string

Código de identificação do usuário do corretor que realizou a venda.

cd_produto
number

Código de identificação do produto utilizado na proposta.

Responses

Response samples

Content type
application/json
{
  • "id_apolice": 0,
  • "cd_apolice": 0,
  • "cd_proposta": "string",
  • "nr_cotacao": "string",
  • "cd_tp_origem": 0,
  • "cd_tp_apolice": 0,
  • "cd_status": 0,
  • "nm_status": "string",
  • "cd_filial": 0,
  • "cd_produto": 0,
  • "nm_produto": "string",
  • "id_pessoa_cliente": 0,
  • "cd_tp_pessoa": 0,
  • "nm_tp_pessoa": "string",
  • "nr_cnpj_cpf": "string",
  • "nm_pessoa_razao_social": "string",
  • "nm_email": "string",
  • "nr_ddd_celular": 0,
  • "nr_telefone_celular": "string",
  • "id_endereco": 0,
  • "nm_cep": "string",
  • "nm_endereco": "string",
  • "nr_endereco": 0,
  • "nm_bairro": "string",
  • "nm_complemento": "string",
  • "cd_uf": 0,
  • "nm_cidade": "string",
  • "id_tp_endereco": 0,
  • "nm_tp_endereco": "string",
  • "fl_principal": true,
  • "id_endosso": 0,
  • "dt_inicio_vigencia": "string",
  • "dt_fim_vigencia": "string",
  • "dt_proposta": "string",
  • "dt_vencimento_proposta": "string",
  • "id_tp_subvencao": 0,
  • "nm_tp_subvencao": "string",
  • "cd_usuario_venda": "string",
  • "qt_dias_vigencia": 0,
  • "Endosso": [
    ],
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Alterar Proposta

Esta chamada realiza a alteração de uma proposta já inserida pelo usuário do corretor anteriormente.

Esta requisição possui estrutura semelhante ao Inserir Proposta, sendo necessário apenas adicionar os campos para identificar a proposta a ser alterada.

Campos para identificação da proposta já existente descritos na tabela abaixo.

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.

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

Código de identificação da proposta existente.

cd_produto
required
number

Código do produto a ser disponibilizado.

cd_tp_origem
required
number

Código do tipo de origem deve ser “2”, referente ao tipo de origem “Cotação”.

cd_filial
required
number

Código da filial Sancor a ser disponibilizado, exemplo: cd_filial “3” referente a Sancor Matriz.

cd_tp_resseguro_aberto
required
number

Tipo de resseguro da proposta. Informar “6”, neste caso o seguro será retido apenas pela seguradora.

id_canal_venda
required
number

Canal de venda da proposta.

id_pessoa_cliente
required
number

Código de identificação do cliente a ser segurado na cotação. Deve ser buscado através da chamada de API a ser disponibilizada.

id_endereco
required
number

Código de identificação do endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

dv_busca_cep
required
boolean

Deve ser “True” ou “False”. Realiza a busca do CEP informado caso o valor do campo seja “True”.

id_tp_endereco
required
number

Código de identificação do tipo de endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

nm_cep_livre
required
string

CEP do endereço do cliente.

nm_endereco_livre
required
string

Nome da rua do endereço do cliente.

nm_bairro_bcep
required
string

Bairro do endereço do cliente.

nm_complemento_bcep
required
string

Complemento do endereço do cliente.

nr_rua_endereco_bcep
required
number

Número do endereço do cliente.

nm_cidade_bcep
required
string

Cidade do endereço do cliente.

cd_uf_bcep
required
number

Código do estado a ser disponibilizado do endereço do cliente.

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. Buscar através da API Produto.

cd_forma_pagamento_pparcela
required
number

Código da forma de pagamento da 1ª parcela. Buscar através da API Produto.

dt_vencimento_pparcela
required
string

Data de vencimento da 1ª parcela.

cd_forma_pagamento
required
number

Código da forma de pagamento das demais parcelas, quando houver. Buscar através da API Produto.

id_conta_corrente
required
number

Código de identificação da conta corrente do pagador. Necessário informar somente quando a forma de pagamento for do tipo débito em conta.

nr_dia_cobranca
required
number

Dia de cobrança das demais parcelas, quando houver.

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 da subvenção.

cd_usuario_venda
required
string

Código do usuário do corretor responsável pela cotação.

qt_dias_vigencia
required
number

Quantidade de dias de vigência do seguro.

required
Array of objects (ApiRur_PutProposta_Req_Corretor)
required
Array of objects (ApiRur_PutProposta_Req_Beneficiario)
required
Array of objects (ApiRur_PutProposta_Req_DadosRisco)
required
Array of objects (ApiRur_PutProposta_Req_QuestionarioItem)
required
object (ApiRur_PutProposta_Req_TipoCarregamento)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Questionário Resposta Produto Listar

Exibe os dados de respostas do questionário do produto. O questionário para produtos rural não é utilizado pela Sancor Seguros, portanto, a requisição está sendo documentada apenas para controle de informação.

Não é necessário informar nenhum dos parâmetros da requisição, portanto, a consulta de resposta do questionário pode ser realizada chamando diretamente a API QuestionarioRespostaProdutoListar”.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno as respostas 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_produto
number

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

id_produto_questionario
number

Código de identificação de uma pergunta do questionário. 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": "string",
  • "QuestionarioProdutoRespostaListar": [
    ]
}

Status Proposta

Esta API realiza a alteração do status da proposta desejada.

Para alterar o status da proposta o usuário deve possuir o token de acesso, o código de identificação da proposta e o código do status desejado.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará mensagem de sucesso para a alteração do status de proposta realizado. 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.

Authorizations:
IBM_App_ID_Token
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.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "cd_produto": 0,
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Consultar Tipo Solo

A requisição realiza a busca por todos os tipos de solo cadastrados no sistema. Não é necessário informar nenhum dos parâmetros da requisição, portanto, a consulta de tipos de solo pode ser realizada apenas chamando diretamente a API TipoSolo.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do tipo de solo. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
id_tp_solo
number

Código de identificação do tipo de solo.

nm_solo
string

Nome do tipo de solo.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cálculo Prêmio

Realizada novamente o cálculo do prêmio da proposta. Recalcular o prêmio é necessário quando há alguma alteração de informação na proposta que foi criada, se o recalculo não foi efetuado, não será permitido emitir a apólice.

No cabeçalho da requisição deverá e ser informado o token de acesso.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados do prêmio recalculado. 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.

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

Código de identificação do endosso da proposta.

dv_premio_calculo_manual
required
boolean

Opção de calcular o prêmio da proposta manualmente. Deve ser “true” ou “false”. Caso o valor seja “true”, o cálculo do prêmio será feito manualmente.

vl_premio_tecnico
required
number

Valor técnico do prêmio.

vl_net
required
number

Valor net do prêmio.

vl_premio_liquido
required
number

Valor líquido do prêmio.

vl_tarifario
required
number

Valor tarifário do prêmio.

vl_adicional
required
number

Valor adicional de prêmio.

pe_juros
required
number

Porcentagem de juros.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id_endosso": 0,
  • "vl_tarifario": 0,
  • "vl_iof": 0,
  • "vl_total": 0,
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Consulta Regra Produto

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

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno as regras do produto. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_produto
required
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
required
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.

cd_regra
required
number

Código de identificação da regra.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consulta Variedade

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

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

  • id_fruta_grao: Código de identificação do cultivo. O parâmetro é obrigatório. Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno as variedades ativas no cultivo. 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.
Authorizations:
IBM_App_ID_Token
query Parameters
id_fruta_grao
required
number

Código de identificação do cultivo.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inserir Cotação

Esta chamada realiza a inclusão de uma nova cotação do usuário do corretor.

Para inserir uma nova cotação, além de possuir token de acesso do usuário do corretor, é necessário possuir o código de identificação pessoa física ou jurídica que será o segurado da cotação realizada. O ambiente também deverá possuir a identificação do produto a ser utilizado, seja do tipo 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á na resposta o código e a mensagem de erro.

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

Código do produto a ser disponibilizado

cd_tp_origem
required
number

Código do tipo de origem deve ser “2”, referente ao tipo de origem “Cotação”.

cd_filial
required
number

Código da filial Sancor a ser disponibilizado, exemplo: cd_filial “3” referente a Sancor Matriz.

id_pessoa_cliente
required
number

Código de identificação do cliente a ser segurado na cotação. Deve ser buscado através da chamada de API a ser disponibilizada

id_endereco
required
number

Código de identificação do endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

dv_busca_cep
required
boolean

Deve ser “True” ou “False”. Realiza a busca do CEP informado caso o valor do campo seja “True”.

id_tp_endereco
required
number

Código de identificação do tipo de endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

nm_cep_livre
required
string

CEP do endereço do cliente.

nm_endereco_livre
required
string

Nome da rua do endereço do cliente.

nm_bairro_bcep
required
string

Bairro do endereço do cliente.

nm_complemento_bcep
required
string

Complemento do endereço do cliente.

nr_rua_endereco_bcep
required
number

Número do endereço do cliente.

nm_cidade_bcep
required
string

Cidade do endereço do cliente.

cd_uf_bcep
required
number

Código do estado a ser disponibilizado do endereço do cliente.

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_tp_subvencao
required
number

Código de identificação do tipo de subvenção a ser buscado através da API ConsultaSubvencao.

nm_texto_livre
required
string

Campo de livre digitação.

cd_usuario_venda
required
string

Código do usuário 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)
required
Array of objects (ApiRur_PostCot_Req_DadosRisco)
required
object (ApiRur_PostCot_Req_TipoCarregamento)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Cotação

Esta requisição realiza a consulta de uma cotação.

  • A requisição não possui corpo, é informado no cabeçalho da Authorization e na url da requisição, é obrigatório informar o parâmetro id_cotacao, que se trata do código de identificação da cotação, esta informação é necessária para realizar a consulta para a consulta desejada.

  • Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação informada. 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.,

Authorizations:
IBM_App_ID_Token
query Parameters
id_cotacao
required
number

Identificador da cotação

Responses

Response samples

Content type
application/json
{
  • "cd_produto": 0,
  • "cd_tp_origem": 0,
  • "cd_filial": 0,
  • "id_pessoa_cliente": 0,
  • "id_endereco": 0,
  • "dv_busca_cep": true,
  • "id_tp_endereco": 0,
  • "nm_cep_livre": "string",
  • "nm_endereco_livre": "string",
  • "nm_bairro_cep": "string",
  • "nm_complemento_cep": "string",
  • "nr_rua_endereco_cep": 0,
  • "nm_cidade_cep": "string",
  • "cd_uf_cep": 0,
  • "dt_inicio_vigencia": "string",
  • "dt_fim_vigencia": "string",
  • "id_tp_subvencao": 0,
  • "nm_texto_livre": "string",
  • "cd_usuario_venda": "string",
  • "qt_dias_vigencia": 0,
  • "Corretor": [
    ],
  • "DadosRisco": [
    ],
  • "TipoCarregamento": {
    },
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Alterar Cotação

Esta chamada realiza a alteração de uma cotação já inserida pelo usuário do corretor anteriormente.

  • Esta requisição possui estrutura semelhante ao Inserir Cotação, sendo necessário apenas adicionar os campos para identificar a cotação a ser alterada.

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

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

Código de identificação da cotação existente.

cd_produto
required
number

Código do produto a ser disponibilizado

cd_tp_origem
required
number

Código do tipo de origem deve ser “2”, referente ao tipo de origem “Cotação”.

cd_filial
required
number

Código da filial Sancor a ser disponibilizado, exemplo: cd_filial “3” referente a Sancor Matriz.

id_pessoa_cliente
required
number

Código de identificação do cliente a ser segurado na cotação. Deve ser buscado através da chamada de API a ser disponibilizada

id_endereco
required
number

Código de identificação do endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

dv_busca_cep
required
boolean

Deve ser “True” ou “False”. Realiza a busca do CEP informado caso o valor do campo seja “True”.

id_tp_endereco
required
number

Código de identificação do tipo de endereço do cliente, deve ser buscado através da chamada de API a ser disponibilizada.

nm_cep_livre
required
string

CEP do endereço do cliente.

nm_endereco_livre
required
string

Nome da rua do endereço do cliente.

nm_bairro_bcep
required
string

Bairro do endereço do cliente.

nm_complemento_bcep
required
string

Complemento do endereço do cliente.

nr_rua_endereco_bcep
required
number

Número do endereço do cliente.

nm_cidade_bcep
required
string

Cidade do endereço do cliente.

cd_uf_bcep
required
number

Código do estado a ser disponibilizado do endereço do cliente.

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_tp_subvencao
required
number

Código de identificação do tipo de subvenção a ser buscado através da API ConsultaSubvencao.

nm_texto_livre
required
string

Campo de livre digitação.

cd_usuario_venda
required
string

Código do usuário 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)
required
Array of objects (ApiRur_PutCot_Req_DadosRisco)
required
object (ApiRur_PutCot_Req_TipoCarregamento)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Consultar Cultivos

Realiza a busca de todos os cultivos cadastrados. Nenhum dos parâmetros é obrigatório, portanto, a consulta de cultivos pode ser realizada apenas executando uma chamada direta para a API Cultivos.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

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 o código e a mensagem de erro.

Authorizations:
IBM_App_ID_Token
query Parameters
id_grp_cultivo
number

Código de identificação do grupo de cultivo.

id_fruta_grao
number

Código de identificação do cultivo.

nm_fruta_grao
string

Nome do cultivo.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Efetivar Cotação

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

Para efetivar a cotação, além de possuir token de acesso do usuário do corretor, é necessário possuir o código de identificação da cotação a ser efetivada.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará os dados da cotação efetivada. 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.

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

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Grupo de Produtos

A requisição realiza a busca por grupos de produto cadastrados no sistema. Não é necessário informar nenhum dos parâmetros da requisição, portanto, a consulta de grupo de produto pode ser realizada chamando diretamente a API *GrupoDeProdutos.

A requisição não possui corpo, é informado no cabeçalho o valor da variável “Authorization”.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do grupo de produto. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_produto
number

Código de identificação do produto.

nm_produto
string

Nome do produto.

cd_usuario
string

Código de identificação do usuário.

nm_usuario
string

Nome do usuário.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Produto

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

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

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á na resposta o código e a mensagem de erro.

Authorizations:
IBM_App_ID_Token
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
{
  • "ConsultaProdutoDetalhe": [
    ],
  • "cd_retorno": 0,
  • "nm_retorno": "string"
}

Questionário Produto Listar

Exibe os dados de perguntas do questionário do produto. O questionário para produtos rural não é utilizado pela Sancor Seguros, portanto, a requisição está sendo documentada apenas para controle de informação.

Para utilizar a consulta de questionário do produto é necessário informar obrigatoriamente o código de identificação do produto.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados 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 não informe o parâmetro cd_produto será retornado o status 500 (Erro do servidor interno).

Authorizations:
IBM_App_ID_Token
query Parameters
cd_produto
required
number

Código de identificação do produto

id_tipo_questionario
number

Código de identificação do tipo de questionário, se o questionário é do tipo item segurado ou do tipo proposta.

Responses

Response samples

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

Reapresentar Parcela Rural

Insere uma reprogramação de parcela, seja em uma proposta ou apólice. Na requisição é possível alterar a data de vencimento, a forma de pagamento e o número do título da parcela.

No cabeçalho da requisição deverá e ser informado o token de acesso.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno uma 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.

Authorizations:
IBM_App_ID_Token
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Tipo Cultura

A requisição realiza a busca por todos os tipos de cultura cadastrados no sistema. O tipo de cultura não é utilizado pela Sancor Seguros, portanto, a requisição está sendo documentada apenas para controle de informação.

Não é necessário informar nenhum dos parâmetros da requisição, portanto, a consulta de tipos de cultura pode ser realizada apenas chamando diretamente a API TipoCultura.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization.

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados do tipo de cultura. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_tp_cultura
number

Código de identificação do tipo de cultura.

nm_cultura
string

Nome do tipo de cultura.

Responses

Consultar Unidade Produto

A requisição realiza a busca por todos os tipos de unidade de produto cadastrados no sistema. Não é necessário informar nenhum dos parâmetros da requisição, portanto, a consulta de unidade de produto pode ser realizada chamando diretamente a API UnidadeProduto.

A requisição não possui corpo, é informado no cabeçalho o valor da variável Authorization

Se a requisição for executada com sucesso, será retornado status 200 (sucesso) e apresentará no retorno os dados da unidade de produto. 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.

Authorizations:
IBM_App_ID_Token
query Parameters
cd_unidade
number

Código de identificação da unidade de produto.

nm_unidade
string

Nome da unidade de produto.

Responses

Response samples

Content type
application/json
[
  • {
    }
]