Mobile Trust
Introdução
Proteção com o BigData ClearSale, insights e identificação de fraude via mobile.
Transação
Envio
Este método é utilizado para fazer o envio de uma transação no MobileTrust.
Requisição
POST https://api.clearsale.com.br/v1/mobiletrust/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
"Document" : "12345678912",
"DocumentType" : "CPF",
"AreaCode" : "11", // opcional
"Phone" : "123456789", // opcional
"BlockSmsSending":false, // Por padrão é falso, caso seja true não envia sms.
"ZipCode" : "00000-000", // opcional
"Email" : "joao.silva@email.com.br", // opcional
"AdditionalInformation" : { // opcional
"Transaction" : "PED0123", // opcional
"Item" : "Produto Item", // opcional e tamanho máximo de 30 caracteres.
"Price" : "23.60", // opcional
"CustomerName" : "João da Silva Junior", // opcional
"Other" : "Outra informação" // opcional
}
}
POST https://homologacao.clearsale.com.br/api/v1/mobiletrust/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
"Document" : "12345678912",
"DocumentType" : "CPF",
"AreaCode" : "11", // opcional
"Phone" : "123456789", // opcional
"BlockSmsSending":false, // Por padrão é falso, caso seja true não envia sms.
"ZipCode" : "00000-000", // opcional
"Email" : "joao.silva@email.com.br", // opcional
"AdditionalInformation" : { // opcional
"Transaction" : "PED0123", // opcional
"Item" : "Produto Item", // opcional e tamanho máximo de 30 caracteres.
"Price" : "23.60", // opcional
"CustomerName" : "João da Silva Junior", // opcional
"Other" : "Outra informação" // opcional
}
}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ID": 1,
"Document": "12345678912",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "123456789",
"ZipCode": "00000-000",
"Email": "joao.silva@email.com.br",
"AdditionalInformation" : {
"Transaction" : "PED0123",
"Item" : "Produto Item",
"Price" : "23.60",
"CustomerName" : "João da Silva Junior",
"Other" : "Outra informação"
},
"Rating": 5,
"Diagnostics": [
{
"Code": "TEL01",
"Description": "O Celular informado não é um Hotfone da pessoa.",
"Type": 1
}
],
"SentSms": {
"Text" : "Olá João Silva! Você está participando do teste do MobileTrust? Responda gratis 1) SIM 2) NÃO 3) NÃO SOU João.",
"Date" : "2018-06-05T12:00:00.000"
},
"RepliedSms" : null,
"CreationDate": "2018-06-05T12:00:00.000"
}Consulta
Este método é utilizado para buscar informações de uma transação no MobileTrust.
Requisição
GET https://api.clearsale.com.br/v1/mobiletrust/transaction/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
GET https://homologacao.clearsale.com.br/api/v1/mobiletrust/transaction/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {Token}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ID": 1,
"Document": "12345678912",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "123456789",
"ZipCode": "00000-000",
"Email": "joao.silva@email.com.br",
"AdditionalInformation" : {
"Transaction" : "PED0123",
"Item" : "Produto Item",
"Price" : "23.60",
"CustomerName" : "João da Silva Junior",
"Other" : "Outra informação"
},
"Rating": 5,
"Diagnostics": [
{
"Code": "TEL01",
"Description": "O Celular informado não é um Hotfone da pessoa.",
"Type": 1
}
],
"SentSms": {
"Text" : "Olá João Silva! Você está participando do teste do MobileTrust? Responda gratis 1) SIM 2) NÃO 3) NÃO SOU João.",
"Date" : "2018-06-05T12:00:00.000"
},
"RepliedSms" : {
"Text" : "1) SIM",
"Code" : "EDA",
"Date" : "2018-06-05T12:45:00.000"
},
"CreationDate": "2018-06-05T12:00:00.000"
}HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ID": 1,
"Document": "12345678912",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "123456789",
"ZipCode": "00000-000",
"Email": "joao.silva@email.com.br",
"AdditionalInformation" : {
"Transaction" : "PED0123",
"Item" : "Produto Item",
"Price" : "23.60",
"CustomerName" : "João da Silva Junior",
"Other" : "Outra informação"
},
"Rating": 5,
"Diagnostics": [
{
"Code": "TEL01",
"Description": "O Celular informado não é um Hotfone da pessoa.",
"Type": 1
}
],
"SentSms": {
"Text" : "Olá João Silva! Você está participando do teste do MobileTrust? Responda gratis 1) SIM 2) NÃO 3) NÃO SOU João.",
"Date" : "2018-06-05T12:00:00.000"
},
"RepliedSms" : {
"Text" : "1) SIM",
"Code" : "EDA",
"Date" : "2018-06-05T12:45:00.000"
},
"CreationDate": "2018-06-05T12:00:00.000"
}| AnswerCode | Sigla |
|---|---|
| Cliente de acordo com a transação. | EDA |
| Cliente não reconhece a transação. | ENS |
Listar transações
Requisição
GET https://api.clearsale.com.br/v1/mobiletrust/transactions?page=1&per_page=10 HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
GET https://homologacao.clearsale.com.br/api/v1/mobiletrust/transactions?page=1&per_page=10 HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"EntityID": 0,
"Page": 1,
"Pages": 2,
"PerPage": 10,
"Total": 20,
"Transactions": [
{
"ID": 1,
"Document": "12345678912",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "123456789",
"CreationDate": "2018-06-05T12:00:00.000",
"HasAnswer": true
},
{
"ID": 2,
"Document": "22222222222",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "222222222",
"CreationDate": "2018-06-01T15:59:56.427",
"HasAnswer": false
},
{
"ID": 3,
"Document": "33333333333",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "333333333",
"CreationDate": "2018-06-01T15:54:59.113",
"HasAnswer": false
},
{
"ID": 4,
"Document": "44444444444",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "444444444",
"CreationDate": "2018-06-01T15:54:40.833",
"HasAnswer": false
},
{
"ID": 5,
"Document": "55555555555",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "555555555",
"CreationDate": "2018-06-01T15:53:02.06",
"HasAnswer": false
}
]
}HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"EntityID": 0,
"Page": 1,
"Pages": 2,
"PerPage": 10,
"Total": 20,
"Transactions": [
{
"ID": 1,
"Document": "12345678912",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "123456789",
"CreationDate": "2018-06-05T12:00:00.000",
"HasAnswer": true
},
{
"ID": 2,
"Document": "22222222222",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "222222222",
"CreationDate": "2018-06-01T15:59:56.427",
"HasAnswer": false
},
{
"ID": 3,
"Document": "33333333333",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "333333333",
"CreationDate": "2018-06-01T15:54:59.113",
"HasAnswer": false
},
{
"ID": 4,
"Document": "44444444444",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "444444444",
"CreationDate": "2018-06-01T15:54:40.833",
"HasAnswer": false
},
{
"ID": 5,
"Document": "55555555555",
"DocumentType": "CPF",
"AreaCode": "11",
"Phone": "555555555",
"CreationDate": "2018-06-01T15:53:02.06",
"HasAnswer": false
}
]
}Dicionário de variáveis
| Nome | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| Document | Documento do cliente | String | 11 | Sim |
| DocumentType | Tipo do documento do cliente | String | - | Sim |
| AreaCode | Código de área do celular do cliente | String | 2 | Sim (se enviado celular) |
| Phone | Número do celular do cliente | String | 9 | Não |
| BlockSmsSending | Bloqueio do envio de SMS | Boolean | - | Não |
| ZipCode | Código Postal do endereço do cliente | String (0000-000) | 9 | Não |
| Email do cliente | String | 150 | Não | |
| AdditionalInformation | Informações adicionais para a transação | Objeto contendo informações adicionais | - | Não |
| Transaction | Código da transação | String (dentro do AdditionalInformation) | 50 | Não |
| Item | Item da transação | String (dentro do AdditionalInformation) | 30 | Não |
| Price | Valor do Item da transação | String (dentro do AdditionalInformation) | - | Não |
| CustomerName | Nome do cliente da transação | String (dentro do AdditionalInformation) | 200 | Não |
| Other | Outras informações para a transação | String (dentro do AdditionalInformation) | - | Não |
Lista de Insights
Insights RealTime
| Código | Descrição |
|---|---|
| TEL0001 | O celular informado é um Hotphone da pessoa |
| TEL0002 | O celular informado não foi encontrado em nossas pesquisas vinculado a esta pessoa |
| TEL0500 | O celular informado nunca foi visto no Big Data |
| TEL0006 | Existe outro Hotphone mais provável |
| TEL0007 | Existem outros celulares possíveis para a pessoa |
| TEL0310 | O celular informado já foi envolvido em fraude para essa pessoa há menos de 1 mês |
| TEL0320 | O celular informado já foi envolvido em fraude para essa pessoa entre 1 e 3 meses |
| TEL0330 | O celular informado já foi envolvido em fraude para essa pessoa entre 3 e 6 meses |
| TEL0340 | O celular informado já foi envolvido em fraude para essa pessoa entre 6 meses e 1 ano |
| TEL0350 | O celular informado já foi envolvido em fraude para essa pessoa entre 1 e 2 anos |
| TEL0360 | O celular informado já foi envolvido em fraude para essa pessoa entre 2 e 3 anos |
| TEL0370 | O celular informado já foi envolvido em fraude para essa pessoa há mais de 3 anos |
| TEL0410 | O celular informado já foi envolvido em fraude para outra pessoa há menos de 1 mês |
| TEL0420 | O celular informado já foi envolvido em fraude para outra pessoa entre 1 e 3 meses |
| TEL0430 | O celular informado já foi envolvido em fraude para outra pessoa entre 3 e 6 meses |
| TEL0440 | O celular informado já foi envolvido em fraude para outra pessoa entre 6 meses e 1 ano |
| TEL0450 | O celular informado já foi envolvido em fraude para outra pessoa entre 1 e 2 anos |
| TEL0460 | O celular informado já foi envolvido em fraude para outra pessoa entre 2 e 3 anos |
| TEL0470 | O celular informado já foi envolvido em fraude para outra pessoa há mais de 3 anos |
| TEL0510 | O celular informado foi visto pela primeira vez há menos de 1 mês |
| TEL0520 | O celular informado foi visto pela primeira vez entre 1 e 3 meses |
| TEL0530 | O celular informado foi visto pela primeira vez entre 3 e 6 meses |
| TEL0540 | O celular informado foi visto pela primeira vez entre 6 meses e 1 ano |
| TEL0550 | O celular informado foi visto pela primeira vez entre 1 e 2 anos |
| TEL0560 | O celular informado foi visto pela primeira vez entre 2 e 3 anos |
| TEL0570 | O celular informado foi visto pela primeira vez há mais de 3 anos |
| TEL0610 | O celular informado foi visto pela última vez há menos de 1 mês |
| TEL0620 | O celular informado foi visto pela última vez entre 1 e 3 meses |
| TEL0630 | O celular informado foi visto pela última vez entre 3 e 6 meses |
| TEL0640 | O celular informado foi visto pela última vez entre 6 meses e 1 ano |
| TEL0650 | O celular informado foi visto pela última vez entre 1 e 2 anos |
| TEL0660 | O celular informado foi visto pela última vez entre 2 e 3 anos |
| TEL0670 | O celular informado foi visto pela última há mais de 3 anos |
| TEL0020 | O celular informado foi utilizado pela pessoa pela última vez há menos de um mês |
| TEL0030 | O celular informado foi utilizado pela pessoa pela última vez entre 1 e 3 meses |
| TEL0040 | O celular informado foi utilizado pela pessoa pela última vez entre 3 e 6 meses |
| TEL0050 | O celular informado foi utilizado pela pessoa pela última vez entre 6 meses e 1 ano |
| TEL0060 | O celular informado foi utilizado pela pessoa pela última vez entre 1 e 2 anos |
| TEL0070 | O celular informado foi utilizado pela pessoa pela última vez de 2 a 3 anos |
| TEL0080 | O celular informado foi utilizado pela pessoa pela última vez há mais de 3 anos |
| GER0141 | O celular informado é da mesma região que a pessoa transita, com base nos endereços encontrados no Big Data |
| GER0121 | O celular informado é do mesmo estado que a pessoa transita, com base nos endereços encontrados no Big Data |
| GER0122 | O celular informado não é do mesmo estado que a pessoa transita, com base nos endereços encontrados no Big Data |
| GER0161 | O celular informado possui vínculo regional, por DDD, com a pessoa |
| GER0181 | O celular informado possui vínculo estadual, por DDD, com a pessoa |
| GER0191 | O celular informado não possui vínculo estadual, por DDD, com a pessoa |
| GER0060 | O DDD e o CPF informados pertencem ao mesmo estado de origem |
| GER0070 | O CPF não foi emitido no mesmo estado do celular informado |
| TEL0270 | A pessoa já foi vítima de Fraude com o celular informado há mais de 3 anos |
| TEL0210 | A pessoa já foi vítima de Fraude com o celular informado há menos de 1 mês |
| TEL0220 | A pessoa já foi vítima de Fraude com o celular informado entre 1 e 3 meses |
| TEL0230 | A pessoa já foi vítima de Fraude com o celular informado entre 3 e 6 meses |
| TEL0240 | A pessoa já foi vítima de Fraude com o celular informado entre 6 meses e 1 ano |
| TEL0250 | A pessoa já foi vítima de Fraude com o celular informado entre 1 e 2 anos |
| TEL0260 | A pessoa já foi vítima de Fraude com o celular informado entre 2 e 3 anos |
| GER0151 | O celular informado não é da mesma região que pessoa transita, com base nos endereços encontrados no Big Data |
| GER0171 | O celular informado não possui vínculo regional, por DDD, com a pessoa |
| TEL1010 | Resposta dada por um Hotphone diferente do celular informado |
| TEL1000 | Resposta dada no celular informado |
| TEL1310 | A pessoa já foi vítima de fraude com o celular da resposta há menos de 1 mês |
| TEL1320 | A pessoa já foi vítima de fraude com o celular da resposta entre 1 e 3 meses |
| TEL1330 | A pessoa já foi vítima de fraude com o celular da resposta entre 3 e 6 meses |
| TEL1340 | A pessoa já foi vítima de fraude com o celular da resposta entre 6 meses e 1 ano |
| TEL1350 | A pessoa já foi vítima de fraude com o celular da resposta entre 1 e 2 anos |
| TEL1360 | A pessoa já foi vítima de fraude com o celular da resposta entre 2 e 3 anos |
| TEL1370 | A pessoa já foi vítima de fraude com o celular da resposta há mais de 3 anos |
| TEL1410 | O celular da resposta já foi envolvido em fraude com outra pessoa há menos de 1 mês |
| TEL1420 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 1 e 3 meses |
| TEL1430 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 3 e 6 meses |
| TEL1440 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 6 meses e 1 ano |
| TEL1450 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 1 e 2 anos |
| TEL1460 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 2 e 3 anos |
| TEL1470 | O celular da resposta já foi envolvido em fraude com outra pessoa há mais de 3 anos |
| TEL1210 | O celular da resposta foi utilizado pela pessoa há menos de um mês |
| TEL1220 | O celular da resposta foi utilizado pela pessoa pela última vez entre 1 e 3 meses |
| TEL1230 | O celular informado foi utilizado pela pessoa pela última vez entre 3 e 6 meses |
| TEL1240 | O celular da resposta foi utilizado pela pessoa pela última vez entre 6 meses e 1 ano |
| TEL1250 | O celular da resposta foi utilizado pela pessoa pela última vez entre 1 e 2 anos |
| TEL1260 | O celular da resposta foi utilizado pela pessoa pela última vez entre 2 e 3 anos |
| TEL1270 | O celular da resposta foi utilizado pela pessoa pela última vez há mais de 3 anos |
| TEL1510 | Celular da resposta foi visto pela primeira vez há menos de 1 mês |
| TEL1520 | Celular da resposta foi visto pela primeira vez entre 1 e 3 meses |
| TEL1530 | Celular da resposta foi visto pela primeira vez entre 3 e 6 meses |
| TEL1540 | Celular da resposta foi visto pela primeira vez entre 6 meses e 1 ano |
| TEL1550 | Celular da resposta foi visto pela primeira vez entre 1 e 2 anos |
| TEL1560 | Celular da resposta foi visto pela primeira vez entre 2 e 3 anos |
| TEL1570 | Celular da resposta foi visto pela primeira vez há mais de 3 anos |
| TEL1610 | Celular da resposta foi visto pela ultima vez há menos de 1 mês |
| TEL1620 | Celular da resposta foi visto pela ultima vez entre 1 e 3 meses |
| TEL1630 | Celular da resposta foi visto pela ultima vez entre 3 e 6 meses |
| TEL1640 | Celular da resposta foi visto pela ultima vez entre 6 meses e 1 ano |
| TEL1650 | Celular da resposta foi visto pela ultima vez entre 1 e 2 anos |
Insights Resposta
| Código | Descrição |
|---|---|
| TEL1010 | Resposta dada por um Hotphone diferente do celular informado |
| TEL1000 | Resposta dada no celular informado |
| TEL1310 | A pessoa já foi vítima de fraude com o celular da resposta há menos de 1 mês |
| TEL1320 | A pessoa já foi vítima de fraude com o celular da resposta entre 1 e 3 meses |
| TEL1330 | A pessoa já foi vítima de fraude com o celular da resposta entre 3 e 6 meses |
| TEL1340 | A pessoa já foi vítima de fraude com o celular da resposta entre 6 meses e 1 ano |
| TEL1350 | A pessoa já foi vítima de fraude com o celular da resposta entre 1 e 2 anos |
| TEL1360 | A pessoa já foi vítima de fraude com o celular da resposta entre 2 e 3 anos |
| TEL1370 | A pessoa já foi vítima de fraude com o celular da resposta há mais de 3 anos |
| TEL1410 | O celular da resposta já foi envolvido em fraude com outra pessoa há menos de 1 mês |
| TEL1420 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 1 e 3 meses |
| TEL1430 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 3 e 6 meses |
| TEL1440 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 6 meses e 1 ano |
| TEL1450 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 1 e 2 anos |
| TEL1460 | O celular da resposta já foi envolvido em fraude com outra pessoa entre 2 e 3 anos |
| TEL1470 | O celular da resposta já foi envolvido em fraude com outra pessoa há mais de 3 anos |
| TEL1210 | O celular da resposta foi utilizado pela pessoa há menos de um mês |
| TEL1220 | O celular da resposta foi utilizado pela pessoa pela última vez entre 1 e 3 meses |
| TEL1230 | O celular informado foi utilizado pela pessoa pela última vez entre 3 e 6 meses |
| TEL1240 | O celular da resposta foi utilizado pela pessoa pela última vez entre 6 meses e 1 ano |
| TEL1250 | O celular da resposta foi utilizado pela pessoa pela última vez entre 1 e 2 anos |
| TEL1260 | O celular da resposta foi utilizado pela pessoa pela última vez entre 2 e 3 anos |
| TEL1270 | O celular da resposta foi utilizado pela pessoa pela última vez há mais de 3 anos |
| TEL1510 | Celular da resposta foi visto pela primeira vez há menos de 1 mês |
| TEL1520 | Celular da resposta foi visto pela primeira vez entre 1 e 3 meses |
| TEL1530 | Celular da resposta foi visto pela primeira vez entre 3 e 6 meses |
| TEL1540 | Celular da resposta foi visto pela primeira vez entre 6 meses e 1 ano |
| TEL1550 | Celular da resposta foi visto pela primeira vez entre 1 e 2 anos |
| TEL1560 | Celular da resposta foi visto pela primeira vez entre 2 e 3 anos |
| TEL1570 | Celular da resposta foi visto pela primeira vez há mais de 3 anos |