Categorização do CPF com objetivo de classificar o risco do documento consultado para poder usufruir dos serviços prestados pela sua instituição. São três níveis de risco: baixo, moderado e alto.
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.
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}"
}
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"
}
Este método é utilizado para fazer o envio de uma transação para a API do Digital Trust Onboarding.
POST https://productsapi.clearsale.com.br/v1/digitaltrustonboarding/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
"Document": "12345678901" (obrigatório)
}
POST https://hmlproductsapi.clearsale.com.br/v1/digitaltrustonboarding/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
"Document": "12345678901" (obrigatório)
}
HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
"Code": "5f67fb47f8e74ff6a9f3dab49c04389a",
"Document": "12345678901",
"Category": 1,
"CreationDate": "2021-08-13T20:30:12.3553027-03:00"
}
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 204 No Content
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
Nome | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
Document | CPF para consulta | String | 11 | Sim |
Nome | Descrição | Tipo | Tamanho |
---|---|---|---|
Code | Código da transação | String | 32 |
Document | CPF consultado | String | 11 |
Category | Categorização do CPF informado | Int | 1 |
CreationDate | Data de criação da transação | DateTime | - |
Valor da categoria | Descrição |
---|---|
1 | Risco baixo |
2 | Risco moderado |
3 | Risco alto |
Para realizar testes e validações dos possíveis retornos da categorização do documento, utilize os respectivos CPFs: