Credit Risk

Última atualização: 8 de Dezembro de 2022

Introdução

Score de Crédito com objetivo de analisar o potencial e capacidade de cada comprador para usufruir dos serviços prestados pela sua instituição.

Autenticação

Todas as requisições submetidas à nossa API devem ser realizadas através de um token de 2048 caracteres.

O token é gerado através de um usuário e senha que devem ser fornecidos pela ClearSale.

Entre em contato com o seu consultor de vendas para maiores informações.

Na autenticação, além do token retornamos seu tempo de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração.

Para o recebimento desse dado é necessário que reserve um espaço de 2048 caracteres. Só gere um novo token após a expiração do seu token atual.

Requisição
POST https://productsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}
POST https://hmlproductsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "Token": "{Valor do Token}",
    "ExpiresInSeconds": "{Tempo de Expiração do Token}"
}

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "errors": {
        "ExampleProperty": [
            "error description."
        ],
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "error title.",
    "status": 400,
    "traceId": "automatically generate id"
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
{
    "message": "Username or Password is incorrect"
}

Transação

Envio

Este método é utilizado para fazer o envio de uma transação no Credit Risk.

Requisição
POST https://productsapi.clearsale.com.br/v1/creditrisk/ HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "Document": "12345678912", (obrigatório),
    "ReferenceDate": "2021-04-30T00:00:00", (opcional)
    "OrderId": "1452291" (opcional)
}
POST https://hmlproductsapi.clearsale.com.br/v1/creditrisk/ HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "Document": "12345678912", (obrigatório),
    "ReferenceDate": "2021-04-30T00:00:00", (opcional)
    "OrderId": "1452291" (opcional)
}
Resposta
HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "Id": 30,
    "OrderId": "1452291",
    "ReferenceDate": "2021-04-30T00:00:00",
    "Document": "12345678912",
    "Score": 402,
    "CreationDate": "2021-04-30T15:50:42.3553027-03:00",
    "Digital": true,
    "GoodFor": "g",
    "VarietyIndex": 511,
    "BehaviourIndex": 404,
    "ProfileIndex": 376,
    "StatusIndex": 460,
    "PostalIndex": 369,
    "RapportIndex": 385
}

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "errors": {
        "ExampleProperty": [
            "error description."
        ],
    },
    "title": "error title.",
    "status": 400,
    "traceId": "automatically generate id"
}

HTTP/1.1 204 No Content

HTTP/1.1 401 Unauthorized  

HTTP/1.1 403 Forbidden

Consulta

Este método é utilizado para buscar informações de uma transação no Credit Risk.

Requisição
GET https://productsapi.clearsale.com.br/v1/creditrisk/{transactionId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
GET https://hmlproductsapi.clearsale.com.br/v1/creditrisk/{transactionId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
Resposta
HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "Id": 30,
    "OrderId": "1452291",
    "ReferenceDate": "2021-04-30T00:00:00",
    "Document": "12345678912",
    "Score": 402,
    "CreationDate": "2021-04-30T15:50:42.3553027-03:00",
    "Digital": true,
    "Goodfor": "g",
    "VarietyIndex": 511,
    "BehaviourIndex": 404,
    "ProfileIndex": 376,
    "StatusIndex": 460,
    "PostalIndex": 369,
    "RapportIndex": 385
}
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "errors": {
        "ExampleProperty": [
            "error description."
        ],
    },
    "title": "error title.",
    "status": 400,
    "traceId": "automatically generate id"
}

HTTP/1.1 401 Unauthorized  

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

Dicionário de variáveis

Transaction

Nome Descrição Tipo Tamanho Obrigatório
Document CPF para consulta String 11 Sim
OrderId Código do pedido inserido pelo cliente para controle String 30 Não
ReferenceDate Data de referência para realizar consulta DateTime - Não

Results

Nome Descrição Tipo Tamanho
Id Código da transação Int -
OrderId Código do pedido inserido pelo cliente para controle String 30
Document CPF consultado String 11
ReferenceDate Data de referência consultada DateTime -
CreationDate Data de criação da transação DateTime -
Score Score geral de crédito Int 4
Digital Parâmetro de classificação que indica se o cliente tem ou não presença digital Boolean 1
GoodFor Total de compras, tipos de cartões usados e CEPs relacionados ao cliente String 1
VarietyIndex * Qualidade e variedade do que o cliente compra Int 4
BehaviourIndex * Formas de pagamento utilizadas e frequência de compra do cliente Int 4
ProfileIndex Tipo de endereço, tipo de device, categoria do cartão do cliente Int 4
StatusIndex Características fixas como data e local de nascimento do cliente Int 4
PostalIndex Valor e frequência de compras nos CEPs relacionados ao cliente Int 4
RapportIndex * Scores dos CPF relacionados ao cliente Int 4

Os scores marcados com "*" podem não ser gerados caso o cliente consultado não tenha presença digital.

Homologação

Para realizar testes e validações por faixa de score principal, utilize os respectivos CPF:

  • 000.235.082-30 para score na faixa 100
  • 003.879.762-30 para score na faixa 200
  • 366.708.678-40 para score na faixa 300
  • 438.415.112-87 para score na faixa 400
  • 032.995.682-56 para score na faixa 500
  • 274.917.408-20 para score na faixa 600
  • 756.097.622-00 para score na faixa 700
  • 013.563.708-29 para score na faixa 800
  • 380.068.688-08 para score na faixa 900