Insurance Auto Index

Última atualização: 22 de Setembro de 2021

Introdução

Com a nossa API para Seguros você obterá um digital score de risco de roubo, furto e perda total para seguradoras e insuretechs.

Nos ajude a melhorar cada vez mais seus indices nos enviando aqui os feeds relacionados às cotações realizadas. Aqui você poderá saber como nos retornar uma variável resposta e nos dizer se uma cotação virou apólice e até mesmo se essa apólice cobriu algum sinistro posteriomrente.

Geração de Score

Envio de cotação

Este método é utilizado para enviar as informações necessárias das cotações de seguro automotivo para ser analisadas pela ClearSale.

Requisição
POST https://api.clearsale.com.br/v1/insurance/auto/score HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "QuotationCode": "INSURANCE_20171205",
    "ReferenceDate": null,
    "FipeCode": "001022-2", 
    "ModelCarYear": 2017, 
    "Cpf": "12345678900",
    "ZipCode": "01144020"
}
POST https://homologacao.clearsale.com.br/api/v1/insurance/auto/score HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "QuotationCode": "INSURANCE_20171205",
    "ReferenceDate": null,
    "FipeCode": "001022-2", 
    "ModelCarYear": 2017, 
    "Cpf": "12345678900",
    "ZipCode": "01144020"
}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
      "ID": 1234,
      "QuotationCode": "INSURANCE_20171205",
      "ReferenceDate" : null,
      "FipeCode": "001022-2",
      "ModelCarYear": 2017,    
      "Cpf": "12345678900",   
      "ZipCode": "01144020",
      "Score": 950,
	  "DigitalLevel": "A"
}
Dicionário de variáveis
Nome Descrição Tipo Tamanho Obrigatório
QuotationCode Código da cotação String 64 Sim
ReferenceDate Data de Referência da cotação DateTime (yyyy-MM-dd) - Não
FipeCode Código FIPE do veículo String 10 Sim
ModelCarYear Ano do modelo do veículo Int 4 Sim
Cpf O CPF do futuro segurado String 20 Sim
ZipCode CEP do futuro segurado String 8 Sim

Retorno da Cotação

Este método será responsável por retornar os dados principais da cotação juntamente ao digital score.

Requisição
GET https://api.clearsale.com.br/v1/insurance/auto/score/{id} HTTP/1.1
Content-Type:application/json
Authorization: Bearer {Token}
GET https://homologacao.clearsale.com.br/api/v1/insurance/auto/score/{id} HTTP/1.1
Content-Type:application/json
Authorization: Bearer {Token}

O valor {id} deve ser preenchido com o id que foi retornado no envio da cotação.

Resposta
HTTP/1.1 200 OK
Content-Type:application/json
Authorization: Bearer {Token}
{
    "ID": 1234,
    "QuotationCode": "INSURANCE_20171205",
    "ReferenceDate" : null,
    "FipeCode": "001022-2",
    "ModelCarYear": 2017,    
    "Cpf": "12345678900",   
    "ZipCode": "01144020",
    "Score": 950,
    "DigitalLevel": "A"
}

Geração de Score

Envio de apólice

Se uma cotação enviada anteriormente virou efetivamente uma apólice, você pode nos informar através da requisição abaixo.

Requisição
POST https://api.clearsale.com.br/v1/insurance/auto/score/{id}/policy HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "PolicyCode": "APL123456"
}
POST https://homologacao.clearsale.com.br/api/v1/insurance/auto/score/{id}/policy HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "PolicyCode": "APL123456"
}

O valor {id} deve ser preenchido com o id que foi retornado no envio da cotação.

Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Authorization: Bearer {Token}
{
    "ID": 5678,
    "Created": "2017-12-28T13:20:24",
    "PolicyCode": "APL123456",
    "Score": {
        "ID": 5,
        "QuotationCode": "INSURANCE_20171205",
        "ReferenceDate": "2017-12-28T16:33:29.97",
        "FipeCode": "001022-2",
        "ModelCarYear": 2017,
        "Cpf": "35764535042",
        "ZipCode": "01144020",
        "Score": 871,
        "DigitalLevel": "A"
    }
}
Dicionário de variáveis
Nome Descrição Tipo Tamanho Obrigatório
PolicyCode Código da apólice String 15 Sim

Envio de sinistro

Aqui você poderá informar a ocorrência de sinistros em uma apólice.

Requisição
POST https://api.clearsale.com.br/v1/insurance/auto/score/{id}/policy/{policyID}/sinister HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "TypeID": 2,
    "Value": 200.5
}
POST https://homologacao.clearsale.com.br/api/v1/insurance/auto/score/{id}/policy/{policyID}/sinister HTTP/1.1
Content-Type:application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "TypeID": 2,
    "Value": 200.5
}

O valor {id} deve ser preenchido com o id que foi retornado no envio da cotação.
O {policyID} deve ser preenchido com o id que foi retornado no envio da apólice.

Resposta
HTTP/1.1 200 OK
Content-Type:application/json
Authorization: Bearer {Token}
{
    "ID": 9012,
    "Created": "2017-12-28T14:19:14.42",
    "TypeID": 2,
    "Value": 200.5,
    "Policy": {
        "ID": 5678,
        "Created": "2017-12-28T13:20:24",
        "PolicyCode": "APL123456",
        "Score": {
            "ID": 5,
            "QuotationCode": "INSURANCE_20171205",
            "ReferenceDate": "2017-12-28T16:33:29.97",
            "FipeCode": "001022-2",
            "ModelCarYear": 2017,
            "Cpf": "35764535042",
            "ZipCode": "01144020",
            "Score": 871,
            "DigitalLevel": "A"
        }
    }
}
Dicionário de variáveis
Nome Descrição Tipo Tamanho Obrigatório
TypeID Tipo de Sinistro. Onde:
1 - Perda parcial
2 - Perda Total
3 - Roubo
4 - Furto		 Int 4 Sim
Value Valor do Sinistro Decimal (5,2) Sim