Plataforma Data Trust BETA

Última atualização: 03 de Março de 2021

Introdução

Validação cadastral inteligente utilizando a proteção do Data Lake ClearSale, ratings, Insights e Score de Fraude, combinando as possíveis variáveis informadas - CPF, TEL, EMAIL, CEP.

Autenticação

Todas as requisições submetidas à nossa API devem ser realizadas por meio de um token de 2048 caracteres, 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 mais informações.

Na autenticação, além do token retornamos seu tempo de expiração em segundos. É 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 authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}
POST 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": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
    eyJzdWIiOiJUZXN0ZSIsImp0aSI6IjE5YTU2MWNhLWU3ODctNDVkYi05YzQyLWYyNWZlODVlYTM2NiIsImlhdCI6MTYwND
    U5NzY0OSwiZW50aXR5SWQiOiIxMjM0NTYiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50
    aXR5L2NsYWltcy9uYW1lIjoiVGVzdGUiLCJ1c2VySWQiOiIxIiwidHlwZSI6IkFwaSIsIm5iZiI6MTYwNDU5NzYzNCwiZX
    hwIjoxNjA0NjA0ODM0LCJpc3MiOiJBcGkuQXV0aGVudGljYXRpb24ifQRwOi8vc2NoZW1hRwOi8vc2NoZW1hRwOi8vc2No.
    Wfk2xpzl4vJ0hgXuFtJIBwKhlMgeO-Ikr1daYNcm8MQ",
    "expiresInSeconds": 7200
}
HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
{
    "message": "Username or Password is incorrect"
}

Fingerprint

Para completa utilização do Data Trust é necessário que o Fingerprint esteja integrado no ato da captura dos dados.

Para maiores informações sobre as configurações do Fingerprint clique aqui.

SDK

Para completa utilização do Fingerprint é necessário que o SDK esteja integrado no ato da captura dos dados no aplicativo.

Para maiores informações sobre as configurações do SDK clique aqui.

Transação

Envio

Este método é utilizado para fazer o envio de uma transação na API da Plataforma Data Trust.

Requisição
POST datatrust/ HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "documentType": "CPF",
    "document": "12345678912",
    "email": "joao.silva@email.com.br",
    "verifiedEmail": false,
    "sessionId": "SessionID123",
    "address": {
        "zipCode": "00000000",
        "street": "Rua teste",
        "number": "12355",
        "complement": "Esquina 3",
        "district": "B13",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil"
    },
    "phone": {
        "countryCode": 55,
        "areaCode": 11,
        "number": 985985875,
        "verified": false
    },
    "referenceDate": "2020-11-05T17:24:43.727Z",
    "type": 1
}
POST datatrust/ HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "documentType": "CPF",
    "document": "12345678912",
    "email": "joao.silva@email.com.br",
    "verifiedEmail": false,
    "sessionId": "SessionID123",
    "address": {
        "zipCode": "00000000",
        "street": "Rua teste",
        "number": "12355",
        "complement": "Esquina 3",
        "district": "B13",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil"
    },
    "phone": {
        "countryCode": 55,
        "areaCode": 11,
        "number": 985985875,
        "verified": false
    },
    "referenceDate": "2020-11-05T17:24:43.727Z",
    "type": 1
}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{
    "id": "string",
    "createdAt": "2020-11-05T17:24:43.727Z",
    "documentType": "CPF",
    "document": "12345678912",
    "email": "joao.silva@email.com.br",
    "verifiedEmail": false,
    "sessionId": "SessionID123",
    "address": {
        "zipCode": "00000000",
        "street": "Rua teste",
        "number": "12355",
        "complement": "Esquina 3",
        "district": "B13",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil"
    },
    "phone": {
        "countryCode": 55,
        "areaCode": 11,
        "number": 985985875,
        "verified": false
    },
    "referenceDate": "2020-11-05T17:24:43.727Z",
    "type": 1
}

Requisição com parâmetros inválidos

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "instance": "/",
    "errors": {
        "DocumentType": [
            "'Document Type' must not be empty.",
            "Document Type must be one of these values: cpf or CPF"
        ],
        "Document": [
            "'Document' must not be empty.",
            "CPF is invalid!"
        ]
    }
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consultas

Consulta de transação

Este método é utilizado para buscar informações de uma transação na API da Plataforma Data Trust.

Requisição
GET datatrust/{id} HTTP/1.1
    Authorization: Bearer {Token}
GET datatrust/{id} HTTP/1.1
    Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "id": "string",
    "createdAt": "2020-11-05T17:24:43.727Z",
    "documentType": "CPF",
    "document": "12345678912",
    "email": "joao.silva@email.com.br",
    "verifiedEmail": false,
    "sessionId": "SessionID123",
    "address": {
        "zipCode": "00000000",
        "street": "Rua teste",
        "number": "12355",
        "complement": "Esquina 3",
        "district": "B13",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brasil"
    },
    "phone": {
        "countryCode": 55,
        "areaCode": 11,
        "number": 985985875,
        "verified": false
    },
    "referenceDate": "2020-11-05T17:24:43.727Z",
    "type": 1
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição


HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta de resultados

Este método é utilizado para buscar informações de uma transação e suas respectivas análises na API da Plataforma Data Trust.

Requisição
GET datatrust/{id}/all HTTP/1.1
    Authorization: Bearer {Token}
GET datatrust/{id}/all HTTP/1.1
    Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "transaction": {
        "id": "63v6789ff91d4bdf8d10df0be1617b03",
        "createdAt": "2020-11-05T17:24:43.727Z",
        "documentType": "CPF",
        "document": "12345678912",
        "email": "joao.silva@email.com.br",
        "verifiedEmail": false,
        "sessionId": "SessionID123",
        "address": {
            "zipCode": "00000000",
            "street": "Rua teste",
            "number": "12355",
            "complement": "Esquina 3",
            "district": "B13",
            "city": "São Paulo",
            "state": "SP",
            "country": "Brasil"
        },
        "phone": {
            "countryCode": 55,
            "areaCode": 11,
            "number": 985985875,
            "verified": false
        },
        "referenceDate": "2020-11-05T17:24:43.727Z",
        "type": 1
    },
    "scores": [
        {
            "value": 33.0995528410065,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:36:59.0783706Z"
        }
    ],
    "ratings": [
        {
            "value": 3,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:10.4275409Z",
            "relatedTo": [
                "Document",
                "Email"
            ]
        },
        {
            "value": 2,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:10.5477269Z",
            "relatedTo": [
                "Email",
                "ZipCode"
            ]
        },
        {
            "value": 3,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:10.667731Z",
            "relatedTo": [
                "Document",
                "Phone"
            ]
        },
        {
            "value": 3,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:10.7886449Z",
            "relatedTo": [
                "Phone",
                "Email"
            ]
        },
        {
            "value": 3,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:10.9074352Z",
            "relatedTo": [
                "Document",
                "ZipCode"
            ]
        },
        {
            "value": 2,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:37:11.0264012Z",
            "relatedTo": [
                "Phone",
                "ZipCode"
            ]
        }
    ],
    "insights": [
        {
            "code": "GER2151",
            "description": "CPF com incidência de transações positivas",
            "type": "CPF",
            "category": "Característica CPF",
            "relevance": "Positivo",
            "relatedTo": [
                "Document"
            ]
        },
        {
            "code": "EML0001",
            "description": "O E-mail informado é um Hot-Email da pessoa",
            "type": "CPF Email",
            "category": "Vínculo Email",
            "relevance": "Positivo",
            "relatedTo": [
                "Document",
                "Email"
            ]
        }
    ],
    "smsToken": {
        "status": "Waiting",
        "createdAt": "2020-11-05T19:38:12.0236286Z"
    },
    "decision": {
        "status": "Approved",
        "createdAt": "2020-11-05T19:38:12.0236286Z"
    },
    "biometrics": {
        "status": "Done",
        "score": 63.54,
        "createdAt": "2021-03-30T19:16:38.8400487Z"
    }
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição


HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Transaction

Nome Descrição Tipo Tamanho Obrigatório
Document Documento do cliente String 11 Sim
DocumentType Tipo do documento do cliente String - Sim
Email Email do cliente String 200 Não
VerifiedEmail Flag de Email verificado Boolean - Não
SessionID Chave do device do cliente String - Não
Address Objeto com informações do endereço do cliente Address - Não
Phone Objeto com informações do número de telefone do cliente Phone - Não
ReferenceDate Data de referência da transação DateTime - Não
Type Tipo da transação (1- Presencial (Padrão); 2- Online) Int 1 Não

Address

Nome Descrição Tipo Tamanho Obrigatório
ZipCode Código Postal do endereço do cliente String 9 Não
Street Endereço do cliente String - Não
Number Número do endereço do cliente String - Não
Complement Complemento do endereço do cliente String - Não
District Distrito do endereço do cliente String - Não
City Cidade do cliente String - Não
State Estado do cliente String - Não
Country País do cliente String - Não

Phone

Nome Descrição Tipo Tamanho Obrigatório
CountryCode Código de país do número de telefone do cliente Int 2 Sim
AreaCode Código de área do número de telefone do cliente Int 2 Sim
Number Número de telefone do cliente Int 9 Sim
Verified Flag de número de telefone verificado Boolean - Não

Scores


Criação

Este método é utilizado para gerar o score de uma transação na API da Plataforma Data Trust.

Requisição
POST datatrust/{id}/scores HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/scores HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{    
    "value": 75.65744814737589,
    "reason": "Initial",
    "createdAt": "2020-11-05T19:47:48.4973013Z"       
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para buscar informações dos scores gerados para uma determinada transação na API da Plataforma Data Trust.

Requisição
GET datatrust/{id}/scores HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/scores HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "scores": [
        {
            "value": 75.65744814737589,
            "reason": "Initial",
            "createdAt": "2020-11-05T19:47:48.4973013Z"
        }
    ]
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "Not Found",
    "status": 404,
    "traceId": "string"
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Score

Nome Descrição Tipo
Value Valor do score Double
Reason Motivo de geração de Score String
CreatedAt Data UTC de criação do score DateTime

Insight


Criação

Este método é utilizado para gerar insights para uma transação na API da Plataforma Data Trust.

Requisição
POST datatrust/{id}/insights HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/insights HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{
    "insights": [
        {
            "code": "GER2151",
            "description": "CPF com incidência de transações positivas",
            "type": "CPF",
            "category": "Característica CPF",
            "relevance": "Positivo",
            "relatedTo": [
                "Document"
            ]
        },
        {
            "code": "EML0001",
            "description": "O E-mail informado é um Hot-Email da pessoa",
            "type": "CPF Email",
            "category": "Vínculo Email",
            "relevance": "Positivo",
            "relatedTo": [
                "Document",
                "Email"
            ]
        }
    ]
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 No Content
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para buscar informações de insights de uma determinada transação na API da Plataforma Data Trust.

Requisição
GET datatrust/{id}/insights HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/insights HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "insights": [
        {
            "code": "GER2152",
            "description": "CPF com alta incidência de transações positivas",
            "type": "CPF",
            "category": "Característica CPF",
            "relevance": "Positivo",
            "relatedTo": [
                "Document"
            ]
        },
        {
            "code": "GER2117",
            "description": "Estado de emissão do CPF: SP",
            "type": "CPF",
            "category": "Característica CPF",
            "relevance": "Neutro",
            "relatedTo": [
                "Document"
            ]
        }
    ]
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Insight

Nome Descrição Tipo
Code Código do insight String
Description Descrição do insight String
Type Tipo do insight (Consulta, retorno) String
Category Categoria do insight String
Relevance Relevância do insight String
RelatedTo Dados com os quais o insight é relacionado String

Lista de Insights

Baixe o arquivo para visualizar todos os insights

XLSX

Ratings

Criação

Este método é utilizado para gerar ratings para uma transação na API da Plataforma Data Trust.

Requisição
POST datatrust/{id}/ratings HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/ratings HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{
    "ratings": [
        {
            "value": 1,
            "reason": "Initial",
            "createdAt": "2020-11-06T13:25:20.5336846Z",
            "relatedTo": [
            "Document",
            "Email"
            ]
        },
        {
            "value": 1,
            "reason": "Initial",
            "createdAt": "2020-11-06T13:25:22.1575014Z",
            "relatedTo": [
            "Email",
            "ZipCode"
            ]
        }
    ]
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para buscar informações dos ratings gerados para uma determinada transação na API da Plataforma Data Trust.

Requisição
GET datatrust/{id}/ratings HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/ratings HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "ratings": [
        {
            "value": 1,
            "reason": "Initial",
            "createdAt": "2020-11-06T13:25:20.5336846Z",
            "relatedTo": [
            "Document",
            "Email"
            ]
        },
        {
            "value": 1,
            "reason": "Initial",
            "createdAt": "2020-11-06T13:25:22.1575014Z",
            "relatedTo": [
            "Email",
            "ZipCode"
            ]
        }
    ]
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Rating

Nome Descrição Tipo
Value Valor do rating da relação de dados enviados Int
Reason Motivo de geração do Rating String
CreatedAt Data UTC de criação do Rating DateTime
RelatedTo Dados referentes ao Rating String

Token

Módulo responsável para a realização de validação de token via sms e email.

Sms

Criação

Este método é utilizado para criar uma validação de token sms e enviar o sms para o celular informado na transação da Plataforma Data Trust.

Requisição
POST datatrust/{id}/sms/tokens HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/sms/tokens HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Waiting",
    "createdAt": "2020-11-06T14:41:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para consultar o estado dos tokens gerados para uma transação na Plataforma Data Trust.

Requisição
GET datatrust/{id}/sms/tokens HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/sms/tokens HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Waiting",
    "createdAt": "2020-11-06T14:41:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "Not Found",
    "status": 404,
    "traceId": "string"
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Validação

Este método é utilizado para validar o token gerado para uma transação na Plataforma Data Trust.

Requisição
POST datatrust/{id}/sms/tokens/validate HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "value": "123456"
}
POST datatrust/{id}/sms/tokens/validate HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "value": "123456"
}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Valid",
    "createdAt": "2020-11-09T14:47:37.7090041Z"
}

Requisição com parâmetros inválidos

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "instance": "/{id}/sms/token/validate",
    "errors": {
        "Value": [
            "'Value' must be 6 characters in length. You entered 0 characters."
        ]
    }
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Email

Criação

Este método é utilizado para criar uma validação de token email e enviar para o endereço de email informado na transação da Plataforma Data Trust.

Requisição
POST datatrust/{id}/emails/tokens HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/emails/tokens HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Waiting",
    "createdAt": "2020-11-06T14:41:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para consultar o estado dos tokens gerados para uma transação na Plataforma Data Trust.

Requisição
POST datatrust/{id}/emails/tokens HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/emails/tokens HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Valid",
    "createdAt": "2020-11-06T14:52:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "Not Found",
    "status": 404,
    "traceId": "string"
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis

Token

Nome Descrição Tipo
Status Estado do token gerado String
CreatedAt Data da última atualização de estado do token DateTime

Status

Nome Descrição
Waiting Status inicial da validação
Valid Status final de token válido informado
Incorrect Status parcial de token incorreto informado em até 3 tentativas
Invalid Status final de token inválido por ter superado 3 tentativas
Expired Status final de token expirado

Token Validate

Nome Descrição Tipo Tamanho Obrigatório
Value Valor do token para ser validado String 6 Sim

2º Fator de Autenticação

Módulo responsável pela realização de validação com segundo fator de autenticação via sms e email.

Sms

Criação

Este método é utilizado para criar uma validação de segundo fator de autenticação via sms e enviar o sms para o HotPhone da transação da Plataforma Data Trust.

Requisição
POST datatrust/{id}/sms/2fa HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/sms/2fa HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
    "text": "Olá, Joao, voce esta simulando a abertura de cartao nas lojas ACME?
    \n Responda gratis:\n1 para sim\n2 para nao\n3 para nao sou Joao",
    "type": "Sms",
    "status": "Sent",
    "createdAt": "2020-11-06T14:41:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para consultar o estado da validação enviada para uma transação na Plataforma Data Trust.

Requisição
GET datatrust/{id}/sms/2fa HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/sms/2fa HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
[
    {
        "text": "1",
        "type": "Sms",
        "status": "Replied",
        "createdAt": "2020-11-20T13:21:23.8796548Z"
    },
    {
        "text": "Olá, Joao, voce esta simulando a abertura de cartao nas lojas ACME?
        \n Responda gratis:\n1 para sim\n2 para nao\n3 para nao sou Joao",
        "type": "Sms",
        "status": "Sent",
        "createdAt": "2020-11-06T14:41:10.3785234Z"
    }
]

Requisição com 2FA expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Email

Criação

Este método é utilizado para criar uma validação de segundo fator de autenticação via email e enviar para o HotEmail da transação da Plataforma Data Trust.

Requisição
POST datatrust/{id}/emails/2fa HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/emails/2fa HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
    "text": "Por favor, clique na resposta abaixo abaixo para confirmar a simulação de abertura de cartão nas lojas
    ACME realizada em 06/11",
    "type": "Email",
    "status": "Sent",
    "createdAt": "2020-11-06T14:41:10.3785234Z"
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para consultar o estado da validação enviada para uma transação na Plataforma Data Trust.

Requisição
GET datatrust/{id}/emails/2fa HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/emails/2fa HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
[
    {
        "text": "1",
        "type": "Email",
        "status": "Replied",
        "createdAt": "2020-11-06T15:21:23.8796548Z"
    },
    {
        "text": "Por favor, clique na resposta abaixo abaixo para confirmar a simulação de abertura de cartão nas lojas
            ACME realizada em 06/11",
        "type": "Email",
        "status": "Sent",
        "createdAt": "2020-11-06T14:41:10.3785234Z"
    }
]

Requisição com Email expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis

2º Fator de Autenticação

Nome Descrição Tipo
Text Texto enviado/recebido no sms String
Type Tipo da Validação [Email/Sms] String
Status Status da Validação [Sent = Envio / Replied = Resposta] String
CreatedAt Data da Criação da Validação Datetime

Decisão

Criação

Este método é utilizado para solicitar uma recomendação de decisão para a transação na API da Plataforma Data Trust.

Requisição
POST datatrust/{id}/decisions HTTP/1.1
Authorization: Bearer {Token}
POST datatrust/{id}/decisions HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
    "status": "Approved",
    "createdAt": "2020-11-05T17:24:43.727Z"
}

Requisição com parâmetros inválidos

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "instance": "/",
    "errors": {
        "Id": [
            "'Id' must be entered and be 32 characters long."
        ]
    }
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  
HTTP/1.1 403 Forbidden  

Rota da requisição inválida

HTTP/1.1 404 Not Found

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta

Este método é utilizado para consultar a recomendação de decisão para a transação na API da Plataforma Data Trust.

Requisição
GET datatrust/{id}/decisions HTTP/1.1
Authorization: Bearer {Token}
GET datatrust/{id}/decisions HTTP/1.1
Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "status": "Approved",
    "createdAt": "2020-11-05T17:24:43.727Z"
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  
HTTP/1.1 403 Forbidden  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição


HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Nome Descrição Tipo
Status Status da decisão. String
CreatedAt Data de criação da decisão. DateTime

Biometria

Solicitação de Biolink

Este método é utilizado para solicitar a geração do Biolink, através dele será possível realizar a captura da selfie para uma transação da Plataforma Data Trust.

Requisição
POST datatrust/{id}/biometrics HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
{
    "name": "string",
    "birthdate": "1990-02-26T21:33:14.568Z",
    "identifierDate": "2021-02-26T21:33:14.568Z"
}
POST datatrust/{id}/biometrics HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
{
    "name": "string",
    "birthdate": "1990-02-26T21:33:14.568Z",
    "identifierDate": "2021-02-26T21:33:14.568Z"
}
Resposta

Requisição realizada com sucesso

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{    
    "url": "string",
    "createdAt": "2021-02-05T19:47:48.4973013Z",
    "identifierDate": "2021-02-26T21:33:14.568Z"     
}

Requisição com parâmetros inválidos

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "instance": "/",
    "errors": {
        "Name": [
            "'Name' must not be empty."
        ],
        "BirthDate": [
            "'BirthDate' must not be empty."
        ]
    }
}

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Consulta de Score de Biometria

Este método é utilizado para consultar o status de um Score de Biometria para uma transação da Plataforma Data Trust.

Requisição
GET datatrust/{id}/biometrics HTTP/1.1
Authorization: Bearer {Token}

    GET datatrust/{id}/biometrics HTTP/1.1
    Authorization: Bearer {Token}
Resposta

Requisição realizada com sucesso

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "score": 75.65744814737589,
    "status": "Done",
    "createdAt": "2021-03-25",
    "identifierDate": "2021-02-26T21:33:14.568Z"
    "message": "Ocorreu um erro na geração de score de biometria" //O campo "Message" só sera exibido em caso de "status": "Error"
}

Requisição sem resultados para exibição

HTTP/1.1 204 No Content

Requisição com token expirado ou inválido

HTTP/1.1 401 Unauthorized  

Requisição sem resultados para exibição

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
    "title": "string",
    "status": 404,
    "detail": "string",
    "instance": "string",
}

Erro no processamento da requisição

HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
    "type": "string",
    "title": "string",
    "status": 500,
    "detail": "string",
    "instance": "string",
}

Dicionário de variáveis


Request

Nome Descrição Tipo Tamanho Obrigatório
Id Identificador da transação gerada pelo Data Trust v2 String 32 Sim
Name Nome completo do cliente (Sem abreviaturas) String - Não
Birthdate Data de Aniversário - [YYYY-MM-DD] DateTime 10 Não
IdentifierDate Data do pedido - [YYYY-MM-DD] DateTime 10 Não

Response

Nome Descrição Tipo
Url Url do Biolink, que foi gerado no módulo de Biometria String
CreatedAt Data em que foi criada a url do Biolink. DateTime
Score Score de biometria gerado para a transação Double
Status Status da biometria. Possíveis status:
- Waiting = status inicial
- Error = caso tenha ocorrido algum erro na validação
- Done = Validação finalizada com sucesso
String
Message Mensagem que só será exibida na consulta de score de biometria caso tenha ocorrido algum erro no processo String

Webhook - Notificação de alteração de transação

Cadastro de Url

Sempre que ocorrer uma alteração de uma transação, o Webhook da Clearsale irá enviar uma notificação para uma URL que deverá ser implementada no lado do integrador.
Para cadastrar as URLs é necessário contatar seu gerente de conta informando os dados da tabela abaixo:

Dado Descrição
Nome Cliente Nome Fantasia do cliente que contratou Data Trust
URL URL que será chamada quando houver uma alteração na transação (a mesma URL poderá se repetir entre os tipos de alteração), exemplo: https://api.clearsale.com.br/products/v1/datatrust/webhook
Token O token informado deverá ser uma chave secreta que será enviado nas chamadas de Webhook no Header "Authorization: Bearer {Token}"
Tipo Opções de envio de validações (1- Token SMS; 2- Token Email; 3- 2º Fator HotPhone; 4- 2º Fator HotEmail)

Chamada de retorno

Os dados da alteração não serão informados na notificação do Webhook, portanto, fica a cargo do integrador o consumo da consulta.

Requisição
POST {URL_CADASTRADA}
Authorization: Bearer {TOKEN_CADASTRADO}
Content-Type: application/json; charset=utf-8
{
    "Code": "{CODIGO_DA_SUA_TRANSAÇÃO}",
    "TypeId": 2,
    "Description": "{DESCRIÇÃO_DA_ALTERAÇÃO}",
    "Date": "2020-12-28T12:45:00.000"
}

Dicionário de variáveis


Tipos de Validação

Abaixo constam os tipos retornados para o campo TypeId

TypeId Descrição
1 Token Sms
2 Token Email
4 2FA Sms
8 2FA Email
4096 Biometrics

Swagger

Para mais detalhes técnicos das requisições, consulte a nossa documentação do swagger clicando aqui

Suporte

Em caso de dúvidas ou problemas técnicos, contate o nosso suporte através do e-mail suporte@clear.sale