Introdução

Descrição do Produto

Segurança

Funcionalidades Disponíveis

Fluxo de Integração

Swagger

Autenticação

Este endpoint está disponível na API na seguinte rota "/v1/authentication".

Todas as requisições submetidas à API devem ser realizadas utilizando um token, gerado a partir de um usuário e senha que serão fornecidos pela ClearSale.

Na autenticação, é retornado o token e 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. Somente gere um novo token após a expiração do seu token atual.

Feedbackfraud - Post - Retroalimentação de marcações de fraude

Este endpoint está disponível na API na seguinte rota "v1/feedback/frauds". Tem a finalidade de receber dados relacionados a um alerta de fraude relacionado a alguma informação do contexto da nossa solução.

AntifraudScore - Post - Geração de Score sobre análise da transação

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifraudscore". Tem a finalidade de analisar os dados relacionados entre dois participantes, podendo ser pessoa física o/ou jurídica e gerar resultados de score de risco de 0 a 1000.
Referente ao score, quanto maior o valor, maior será o risco de fraude e o mesmo vale inversamente.
Obs:

• Campos com obrigatoriedade "opcional" caso preenchido, será necessário preencher campos obrigatório que dependam do objeto pai.
• O exemplo de retorno está no AntifraudScore - Get.

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
  "operationType": 1,
  "cashType": 1,
  "recipient": {
    "document": "47739506842",
    "documentType": "CPF",
    "email": "teste.souza@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 981710000
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
    },
    "zipCode": "90660130",
    "ipDevice": "192.168.18.8"
  },
  "sender": {
    "document": "04518345851",
    "documentType": "CPF",
    "email": "teste@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 995756363
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
     },
    "zipCode": "90660120",
    "ipDevice": "192.168.200.68",
  },
   "key": {
      "value": "47739506842",
      "type": "CPF",
      "creationDateKey": "2023-08-29T19:20:50.197Z",
      "creationDateAccount": "2023-08-29T19:20:50.197Z"
    },
  "currency": "BRL",
  "amount": 200,
  "referenceDate": "2023-10-01T09:00:00-03:00",
  "statistics": {
    "lastUpdated": "2023-08-29T19:20:50.197Z",
    "counters": [
      {
        "type": "Confirmed_Frauds",
        "by": "key",
        "d3": 3,
        "d30": 15,
        "m6": 30
      }
    ]
  }
}

AntifraudScore - Get - Retorna informação da análise de transações

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifraudscore/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente, retornando somente o Score da transação e ScoreComportamental.

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "id": "94f82ab97c194c3f85e8262df4d13b7f",
    "score": {
        "value": 773.749267578125,
        "date": "2024-07-03T17:12:38.6898434+00:00"
    },
    "comportamentalScore": 916.41015625
}

AntifraudDecision - Post - Geração de Score e Aplicação de Regra sobre análise da transação

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifrauddecision". Tem a finalidade de analisar os dados relacionados entre dois participantes, podendo ser pessoa física o/ou jurídica e gerar resultados de score de risco de 0 a 1000, bem como, regra aplicada de acordo com o motor de decisão.
Referente ao score, quanto maior o valor, maior será o risco de fraude e o mesmo vale inversamente.
Obs:

• Campos com obrigatoriedade "opcional" caso preenchido, será necessário preencher campos obrigatório que dependam do objeto pai.
• O exemplo de retorno está no AntifraudDecision - Get.

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
  "operationType": 1,
  "cashType": 1,
  "recipient": {
    "document": "47739506842",
    "documentType": "CPF",
    "email": "teste.souza@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 981710000
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
    },
    "zipCode": "90660130",
    "ipDevice": "192.168.18.8"
  },
  "sender": {
    "document": "04518345851",
    "documentType": "CPF",
    "email": "teste@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 995756363
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
     },
    "zipCode": "90660120",
    "ipDevice": "192.168.200.68",
  },
   "key": {
      "value": "47739506842",
      "type": "CPF",
      "creationDateKey": "2023-08-29T19:20:50.197Z",
      "creationDateAccount": "2023-08-29T19:20:50.197Z"
    },
  "currency": "BRL",
  "amount": 200,
  "referenceDate": "2023-10-01T09:00:00-03:00",
  "statistics": {
    "lastUpdated": "2023-08-29T19:20:50.197Z",
    "counters": [
      {
        "type": "Confirmed_Frauds",
        "by": "key",
        "d3": 3,
        "d30": 15,
        "m6": 30
      }
    ]
  }
}

AntifraudDecision - Get - Retorna informação da análise de transações

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifrauddecision/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente, retornando Score calculado por transação e regras que determinou a aprovação (APA) ou reprovação (RPA).

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "id": "4dc3c4dbe86f444e8931e8c30c498aea",
    "score": {
        "value": 862.3741455078125,
        "date": "2024-07-03T11:42:24.4173372-03:00"
    },
    "decidedRuleName": "Aprovar_pix_goodList",
    "finalDecision": "APA",
    "comportamentalScore": 892.904755175415
}