Pular para o conteúdo principal

3.1. Gerar Simulação e Proposta de Seguro

Endpoints para geração de simulação e proposta de seguro utilizando o provider 180 Seguros (provider: 9514).

Planos Disponíveis

O campo selectedQuotation define o plano de seguro contratado. O integrador é responsável por escolher o plano desejado:

CódigoPlano
1Bronze
2Prata
3Ouro

Códigos dos Provedores​

Os Códigos dos Provedores são utilizados para identificar e rotear as suas operações para a instituição correta.

ProvedorCódigo
180 Seguros9514

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}

POST Gerar Simulação​

https://integration.ajin.io/v3/loan-insurance-simulations

Gera uma simulação de seguro para o tomador informado, retornando os dados da proposta com o plano selecionado.

Parâmetros​

Visualizar Parâmetros

Campos Obrigatórios

CampoTipoObrigatórioDescrição
selectedQuotationintegerSimPlano selecionado: 1 (Bronze), 2 (Prata), 3 (Ouro)
creditMethodintegerSimMétodo de crédito. Ex: 2 (PIX) 3 (Boleto Bancário) 4 (Cartão de crédito)
termintegerSimPrazo (Informar caso seja cartão de crédito)
step.codeintegerSimCódigo da etapa
step.namestringSimNome da etapa. Ex: "Dados Cadastrais"

Borrower — Dados do Tomador

CampoTipoObrigatórioDescrição
borrower.namestringSimNome completo
borrower.birthDatestringSimData de nascimento (ISO 8601: YYYY-MM-DDTHH:mm:ss.sssZ)
borrower.identitystringSimCPF
borrower.phonestringSimTelefone
borrower.emailstringSimEndereço de e-mail

Borrower — Endereço

CampoTipoObrigatórioDescrição
borrower.address.streetstringSimLogradouro
borrower.address.numberstringSimNúmero
borrower.address.complementstringNãoComplemento
borrower.address.districtstringSimBairro
borrower.address.citystringSimCidade
borrower.address.statestringSimUF. Ex: "SP"
borrower.address.zipCodestringSimCEP

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "borrower": {
        "name": "REDACTED BORROWER NAME",
        "birthDate": "****-**-**T**:**:**.***Z",
        "identity": "***********",
        "phone": "***********",
        "email": "********@********.com",
        "sex": "",
        "motherName": "",
        "nationality": null,
        "maritalStatus": "",
        "document": {
            "type": {
                "code": "rg",
                "name": "RG"
            },
            "number": "",
            "issuingDate": null,
            "issuingEntity": "",
            "issuingState": ""
        },
        "address": {
            "id": "********-****-****-****-************",
            "prefix": null,
            "street": "REDACTED STREET",
            "number": "****",
            "complement": "",
            "district": "REDACTED DISTRICT",
            "city": "São Paulo",
            "state": "SP",
            "country": null,
            "zipCode": "********"
        }
    },
    "selectedQuotation": 1, 
    "creditMethod": 2,
    "term": 0,
    "step": {
        "code": 1,
        "name": "Dados Cadastrais"
    }
}

POST Gerar Proposta​

https://integration.ajin.io/v3/loan-insurance-simulations/{{simulationId}}/confirm

aviso

Confirma a simulação gerada e cria a proposta de seguro. O simulationId deve ser o id retornado no endpoint de Gerar Simulação.

Parâmetros​

Visualizar Parâmetros

Parâmetros de URL

ParâmetroTipoObrigatórioDescrição
simulationIdstringSimID da simulação retornado no endpoint de Gerar Simulação (UUID v4)

Campos do Body

CampoTipoObrigatórioDescrição
commandstringSimComando de confirmação. Valor fixo: "create_loans"

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "command": "create_loans"
}