01
Primeiros passos
02
Introdução
03
Rapid Score
Consulta
Resposta
04
Classic Score
Consulta
Resposta
05
Identidade Digital
06
Referências
Queries
Tipos de Entrada
Tipos
Enumerações
Leia Introdução ao GraphQL, com exemplos reais da nossa API.
Crie uma conta no portal do desenvolvedor.
Cadastre sua primeira aplicação.
Utilize o dashboard para acessar suas configurações de acesso.
Para explorar rapidamente as APIs aqui na página de documentação, use o console de GraphQL, na seção de referências. Nele, você pode ver as consultas de exemplo, executá-las e alterá-las.
Jaydson GomesDesenvolvedor Evangelista
Para efetuar consultas de avaliação de risco de email é necessário ter um usuário cadastrado na plataforma de APIs e estar registrado como Card Issuer, Acquirer ou Merchant.
Na query é possível informar o email
e outras informações de cadastro do usuário. O email
deve ser informado no padrão correto para que a análise possa ser realizada com sucesso. É importante que o máximo de informações possíveis sobre o usuário seja fornecida, isso pode ajudar a avaliar melhor o score de risco do e-mail informado.
São disponibilizadas duas querys para realizar a avaliação de risco. Caso haja a necessidade de obter uma resposta rápida, a query verifyEmailRapidScore
, deve ser utilizada. Caso contrário, a query verifyEmailClassicScore
, deve ser utilizada. As informações retornadas são distintas para cada uma das chamadas.
Veja abaixo um exemplo da chamada verifyEmailRapidScore
e os campos necessários. Para que a requisição seja executada com sucesso, deve ser enviado no header o client_id
e o access_token
obtido no login da plataforma de APIs da Elo.
A chamada verifyEmailRapidScore
deve ser usada para fluxos onde é necessário se obter uma resposta rápida sobre o score de fraude referente ao email informado. A resposta retornará em menos tempo se comparada com a chamada verifyEmailClassicScore
.
query {
verifyEmailRapidScore (
email: "rapidrisk12@emailage.com",
ipAddress: "192.168.10.5"
firstName: "joão",
lastName: "silva",
phoneNumber: "+5511999995999"
legalId: {
cpf: "43765876054"
},
transaction: {
numberBin: "655000"
}
address: [
{
zip: "06455030"
place: "alemeda xingu"
number: 512,
city: "Barueri",
state: "sp"
country: "brasil"
type: SHIPPING
},
{
zip: "06455030"
place: "alemeda xingu"
number: 512,
city: "Barueri",
state: "sp"
country: "brasil"
type: BILLING
}
]
) {
correlationId
version
created
trackingId
reason
riskBand
email {
exists
ownerNameMatch
totalHits
uniqueHits
firstVerificationDate
created
dateOfBirth
lastFlaggedOn
ownerName
gender
company
title
lastFlaggedIndustry
score {
reason
riskLevel
relevantInfoId
}
socialMedia {
socialMediaFriends
image
socialMediaLinks {
source
link
}
}
}
domain {
exists
categoryCode
corporate
created
name
company
country
score {
reason
riskLevel
relevantInfoId
}
}
transaction {
id
cardType
isPrepaid
issuerBank
issuerBrand
issuerCountry
cardCategory
score {
reason
riskLevel
relevantInfoId
}
}
device {
source
id
score {
reason
riskLevel
relevantInfoId
}
}
ip {
address
isCorporateProxy
isRiskCountry
isCountryMatch
isAnonymous
reputation
proxyType
proxyIdentification
billingAddressDistance
registration {
isp
org
asnum
domain
userType
netSpeedCell
}
location {
continentCode
countryCode
regionCode
city
postalCode
regionConfidence
timezoneOffset
cityConfidence
countryConfidence
postalCodeConfidence
callingCode
metroCode
latitude
longitude
}
score {
reason
riskLevel
relevantInfoId
}
}
service {
existingCustomer
location
detail
category
deliveryType
date
score {
reason
riskLevel
relevantInfoId
}
}
digitalIdentity {
overallScore
emailToIpConfidence
emailToPhoneConfidence
emailToBillAddressConfidence
emailToShipAddressConfidence
emailToFullNameConfidence
emailToLastNameConfidence
ipToPhoneConfidence
ipToBillAddressConfidence
phoneToFullNameConfidence
phoneToLastNameConfidence
shipAddressToBillAddressConfidence
shipAddressToFullNameConfidence
shipAddressToLastNameConfidence
billAddressToLastNameConfidence
}
phone {
isBillingLocation
number
ownerNameMatch
countryCode
carrier
ownerName
ownerType
score {
reason
riskLevel
relevantInfoId
}
}
address {
isShipForward
isShipCityPostalMatch
isBillCityPostalMatch
addressCheck
street1
street2
city
regionCode
postalCode
countryCode
company
type
score {
reason
riskLevel
relevantInfoId
}
}
}
}
Abaixo temos um exemplo de resposta da chamada verifyEmailRapidScore
. Para avaliar o risco de fraude, um identificador único será retornado no atributo riskBand
. Abaixo temos exemplos dos possíveis valores para o atributo riskBand
.
1 - Score de Fraude entre 0 e 100
2 - Score de Fraude entre 101 e 300
3 - Score de Fraude entre 301 e 600
4 - Score de Fraude entre 601 e 799
5 - Score de Fraude entre 800 e 899
6 - Score de Fraude entre 900 e 999
Para identificar o risco de fraude das demais informações contidas na resposta, é necessário avaliar cada objeto de retorno e os valores atribuidos a cada um deles. Dentro dos objetos de retorno, sempre serão retornados os atributos riskLevel
, relevantInfoId
e reason
.
riskLevel: Valor de risco atribuido para a informação em questão.
relevantInfoId: Informações relevantes sobre o score calculado.
reason: A razão do score estar associado as informações de fraude.
{
"data": {
"verifyEmailRapidScore": {
"correlationId": "cf4cc0fa-39e7-4466-966e-9f4a07063b8e",
"version": "2.0",
"created": "2020-07-03T13:36:58.094Z",
"trackingId": "1223334444",
"reason": "EMAIL_FIRST_SEEN_AT_LEAST_4_YEARS_AGO",
"riskBand": 1,
"email": {
"exists": 1,
"ownerNameMatch": null,
"totalHits": 3,
"uniqueHits": 2,
"firstVerificationDate": "2015-07-03T13:36:58.094Z",
"created": null,
"dateOfBirth": null,
"lastFlaggedOn": "2018-01-27T00:00:00.000Z",
"ownerName": "Rapid Risk",
"gender": null,
"company": "Emailage",
"title": "Mr.",
"lastFlaggedIndustry": "Technology",
"score": {
"reason": "EMAIL_FIRST_SEEN_AT_LEAST_4_YEARS_AGO",
"riskLevel": 5,
"relevantInfoId": 11390
},
"socialMedia": {
"socialMediaFriends": 804,
"image": "http://www.johnappleseed.com/pages/about/john-badge-small.png",
"socialMediaLinks": [
{
"source": "Twitter",
"link": "https://twitter.com/johnappleseed"
}
]
}
},
"domain": {
"exists": 1,
"categoryCode": 10244,
"corporate": 1,
"created": "2012-05-01T04:23:13.000Z",
"name": null,
"company": "Emailage Corp",
"country": "US",
"score": {
"reason": "USER_DEFINED_LOW_RISK_DOMAIN",
"riskLevel": 4,
"relevantInfoId": 20640
}
},
"transaction": {
"id": null,
"cardType": 1,
"isPrepaid": false,
"issuerBank": "Visa",
"issuerBrand": "Bank of America NA",
"issuerCountry": "US",
"cardCategory": "STANDARD",
"score": {
"reason": "MODERATE_RISK_TRANSACTION",
"riskLevel": 3,
"relevantInfoId": 69999
}
},
"device": {
"source": 150,
"id": "6d648d89-8811-43d2-82b4-c9942480f25f",
"score": {
"reason": "MODERATE_RISK_DEVICE",
"riskLevel": 3,
"relevantInfoId": 99999
}
},
"ip": {
"address": "60.70.80.90",
"isCorporateProxy": false,
"isRiskCountry": false,
"isCountryMatch": true,
"isAnonymous": false,
"reputation": 1,
"proxyType": 3,
"proxyIdentification": 3,
"billingAddressDistance": null,
"registration": {
"isp": "Cox Communication",
"org": "Cox Communication",
"asnum": "Cox Communications Inc.US",
"domain": "mac.com",
"userType": 20,
"netSpeedCell": 3
},
"location": {
"continentCode": "NA",
"countryCode": "US",
"regionCode": "US-AZ",
"city": "Phoenix",
"postalCode": "85032",
"regionConfidence": 90,
"timezoneOffset": -7,
"cityConfidence": 95,
"countryConfidence": 85,
"postalCodeConfidence": 0,
"callingCode": 480,
"metroCode": 101,
"latitude": 33.0581,
"longitude": -112.0476
},
"score": {
"reason": "MODERATE_RISK_IP",
"riskLevel": 3,
"relevantInfoId": 89999
}
},
"service": {
"existingCustomer": true,
"location": "Light Rail to Chandler DT",
"detail": "Light Rail Ticket X836724",
"category": "Metro Transit",
"deliveryType": "Electronic",
"date": "2017-08-16T21:23:50.260Z",
"score": {
"reason": "MODERATE_RISK_SERVICE_DETAILS",
"riskLevel": 3,
"relevantInfoId": 79999
}
},
"digitalIdentity": {
"overallScore": 47,
"emailToIpConfidence": 41,
"emailToPhoneConfidence": 72,
"emailToBillAddressConfidence": 40,
"emailToShipAddressConfidence": 72,
"emailToFullNameConfidence": 72,
"emailToLastNameConfidence": 72,
"ipToPhoneConfidence": 50,
"ipToBillAddressConfidence": 34,
"phoneToFullNameConfidence": 62,
"phoneToLastNameConfidence": 50,
"shipAddressToBillAddressConfidence": 35,
"shipAddressToFullNameConfidence": 35,
"shipAddressToLastNameConfidence": 35,
"billAddressToLastNameConfidence": 14
},
"phone": {
"isBillingLocation": null,
"number": null,
"ownerNameMatch": 1,
"countryCode": null,
"carrier": "AT&T",
"ownerName": "Rapid Risk",
"ownerType": "Private",
"score": {
"reason": "MODERATE_RISK_PHONE",
"riskLevel": 3,
"relevantInfoId": 39999
}
},
"address": [
{
"isShipForward": false,
"isShipCityPostalMatch": true,
"isBillCityPostalMatch": null,
"addressCheck": 4,
"street1": "25 S. Arizona Pl",
"street2": "Ste 400",
"city": "Chandler",
"regionCode": "AZ",
"postalCode": "85225",
"countryCode": "US",
"company": "Emailage",
"type": "SHIPPING",
"score": {
"reason": "MODERATE_RISK_SHIPADDRESS",
"riskLevel": 3,
"relevantInfoId": 49999
}
},
{
"isShipForward": null,
"isShipCityPostalMatch": null,
"isBillCityPostalMatch": true,
"addressCheck": 4,
"street1": "25 S. Arizona Pl",
"street2": "Ste 400",
"city": "Chandler",
"regionCode": "AZ",
"postalCode": "85225",
"countryCode": "US",
"company": "Emailage",
"type": "BILLING",
"score": {
"reason": "MODERATE_RISK_BILLADDRESS",
"riskLevel": 3,
"relevantInfoId": 59999
}
}
]
}
}
}
Veja abaixo um exemplo da chamada verifyEmailClassicScore
e os campos necessários para enviar uma requisição. Para que a requisição seja executada com sucesso, deve ser enviado no header o client_id
e o access_token
obtido no login da plataforma de APIs da Elo.
A chamada verifyEmailClassicScore
percorre a rede de dados buscando informações de fraude sobre o email e os demais dados enviados na requisição. Essa chamada pode ser mais demorada do que a verifyEmailRapidScore
pois utilizada diversas fontes de dados para realizar os calculos do score.
query {
verifyEmailClassicScore (
email: "elo@elo.com",
ipAddress: "192.168.10.5"
firstName: "joão",
lastName: "silva",
phoneNumber: "+5511999995999"
legalId: {
cpf: "43765876054"
},
transaction: {
numberBin: "655000"
}
address: [
{
zip: "06455030"
place: "alemeda xingu"
number: 512,
city: "Barueri",
state: "sp"
country: "brasil"
type: SHIPPING
},
{
zip: "06455030"
place: "alemeda xingu"
number: 512,
city: "Barueri",
state: "sp"
country: "brasil"
type: BILLING
}
]
) {
domain {
exists
name
company
country
category
corporate
riskLevel
relevantInfo
risklevelId
countryMatch
riskCountry
}
digitalIdentity {
overallScore
emailToIpConfidence
emailToPhoneConfidence
emailToBillAddressConfidence
emailToShipAddressConfidence
emailToFullNameConfidence
emailToLastNameConfidence
ipToPhoneConfidence
ipToBillAddressConfidence
phoneToFullNameConfidence
phoneToLastNameConfidence
shipAddressToBillAddressConfidence
shipAddressToFullNameConfidence
shipAddressToLastNameConfidence
billAddressToLastNameConfidence
}
ip {
riskLevelId
riskReasonId
riskLevel
riskReason
reputation
anonymousDetected
proxyType
isp
org
userType
netSpeedCell
corporateProxy
continentCode
country
countryCode
city
callingcode
metroCode
map
countrymatch
latitude
latitude
longitude
}
emailAge {
score
statusId
reasonId
adviceId
riskBandId
status
reason
advice
riskBand
}
email {
address
exists
gender
location
company
title
nameMatch
countryMatch
sourceIndustry
dateOfBirth
fraudRisk
fraudType
billRiskCountry
totalHits
uniqueHits
firstVerification
lastVerification
lastFlaggEdon
socialMedia {
socialMediaFriends
image
socialMediaLinks {
source
link
}
}
}
phone {
number
status
countryCode
carrier
carrierType
ownerName
ownerNameMatch
ownerType
}
transaction {
issuerBank
issuerBrand
issuerCountry
cardCategory
cardType
}
}
}
Abaixo temos um exemplo de resposta da chamada verifyEmailClassicScore
. As informações gerais sobre o score de fraude são retornadas no objeto emailAge
.
{
"data": {
"verifyEmailClassicScore": {
"domain": {
"exists": "Yes",
"name": "emailage.com",
"company": "Emailage Corp",
"country": "",
"category": "Fraud Mitigation Services",
"corporate": "Yes",
"riskLevel": "Low",
"relevantInfo": "Low Risk Domain",
"risklevelId": "4",
"countryMatch": "No",
"riskCountry": "No"
},
"digitalIdentity": {
"overallScore": 76,
"emailToIpConfidence": 50,
"emailToPhoneConfidence": 50,
"emailToBillAddressConfidence": 50,
"emailToShipAddressConfidence": 50,
"emailToFullNameConfidence": null,
"emailToLastNameConfidence": null,
"ipToPhoneConfidence": 50,
"ipToBillAddressConfidence": 50,
"phoneToFullNameConfidence": null,
"phoneToLastNameConfidence": null,
"shipAddressToBillAddressConfidence": 99,
"shipAddressToFullNameConfidence": null,
"shipAddressToLastNameConfidence": null,
"billAddressToLastNameConfidence": null
},
"ip": {
"riskLevelId": 3,
"riskReasonId": 301,
"riskLevel": "Moderate",
"riskReason": "Moderate Risk",
"reputation": "Good",
"anonymousDetected": "",
"proxyType": "",
"isp": "",
"org": "",
"userType": "",
"netSpeedCell": "",
"corporateProxy": "",
"continentCode": "",
"country": "",
"countryCode": "",
"city": "",
"callingcode": "",
"metroCode": "",
"map": "",
"countrymatch": "",
"latitude": null,
"longitude": null
},
"emailAge": {
"score": 709,
"statusId": 3,
"reasonId": 2,
"adviceId": 11,
"riskBandId": 4,
"status": "EmailInexistent",
"reason": "Email does not exist",
"advice": "Data Entry Review",
"riskBand": "Fraud Score 601 to 799"
},
"email": {
"address": "rapidrisk12@emailage.com",
"exists": "No",
"gender": "",
"location": "",
"company": "",
"title": "",
"nameMatch": "U",
"countryMatch": null,
"sourceIndustry": "",
"dateOfBirth": "",
"fraudRisk": "709 Review",
"fraudType": "",
"billRiskCountry": "No",
"totalHits": "55",
"uniqueHits": "1",
"firstVerification": "2020-07-03T13:36:48.000Z",
"lastVerification": "2020-07-03T13:36:48.000Z",
"lastFlaggEdon": null,
"socialMedia": {
"socialMediaFriends": null,
"image": null,
"socialMediaLinks": []
}
},
"phone": null,
"transaction": null
}
}
}
A identidade digital tem como objetivo retornar a relação de confiança entre as informações enviadas na requisição e as informações encontradas na rede de dados. Através dos valores de score retornados pela identidade digital, é possível saber, por exemplo, a confiança que obtivemos em relação aos dados de email e endereço de entrega estarem corretas.
Quanto maior o score retornado, maior é a confiança entre as informações.
Para obter as informações de identidade digital, bastar solicitar na query GraphQL que os objetos abaixo sejam retornados:
digitalIdentity {
overallScore
emailToIpConfidence
emailToPhoneConfidence
emailToBillAddressConfidence
emailToShipAddressConfidence
emailToFullNameConfidence
emailToLastNameConfidence
ipToPhoneConfidence
ipToBillAddressConfidence
phoneToFullNameConfidence
phoneToLastNameConfidence
shipAddressToBillAddressConfidence
shipAddressToFullNameConfidence
shipAddressToLastNameConfidence
billAddressToLastNameConfidence
}
Nota: Valores adicionais podem cobrados ao solicitar as informações de identidade digital
Argumentos:
email: String
obrigatório
Endereço de email valido
ipAddress: String
Endereços de rede IPv4 ou IPv6 de onde partiu a solicitação de criação.
Se for IPv6, deve estar entre colchetes. Exemplo: [::1] Se for IPv4, deve seguir a notação com pontos: 127.0.0.1
firstName: String
Primeiro nome.
lastName: String
Último nome.
phoneNumber: String
Número de telefone.
Utilizar o padrão ISO E.164.
Exemplo: "+5511123456789
"
legalId: LegalIdsPersonInput
Documento legal de identificação.
transaction: TransactionVerifyEmailAgeInput
Dados da transação.
Argumentos:
email: String
obrigatório
Endereço de email valido
ipAddress: String
Endereços de rede IPv4 ou IPv6 de onde partiu a solicitação de criação.
Se for IPv6, deve estar entre colchetes. Exemplo: [::1] Se for IPv4, deve seguir a notação com pontos: 127.0.0.1
firstName: String
Primeiro nome.
lastName: String
Último nome.
phoneNumber: String
Número de telefone.
Utilizar o padrão ISO E.164.
Exemplo: "+5511123456789
"
legalId: LegalIdsPersonInput
Documento legal de identificação.
transaction: TransactionVerifyEmailAgeInput
Dados da transação.
Campos:
zip
:
String
Código postal.
place
:
String
Nome da via, compondo as informações do endereço.
number
:
Int
Número da construção
city
:
String
Nome da cidade em UTF-8
state
:
String
Nome do estado por completo.
Exemplo: SP
, RJ
...
country
:
String
Nome do país
Exemplos: Brasil
, Chile
...
countryCode
:
String
Código do país. Utilizar o formato ISO 3166-1 alpha-2.
Campos:
exists
:
String
Informa se domínio existe ou não. Possíveis respostas = Sim; Não; Não mais; Não tenho certeza (quando o domínio não confirma a existência)
name
:
String
Nome do domínio do email informado.
company
:
String
Nome da empresa a qual pertence o domínio atrelado ao email.
country
:
String
País do domínio do email informado. Por exemplo BR, US, AUS.
category
:
String
Categoria da empresa a qual pertence o domínio atrelado ao email.
corporate
:
String
Indica se o domínio é corporativo.
riskLevel
:
String
Descrição do risco A descrição do nível de risco. Indica o nível de risco de fraude de um domínio. Consulte risklevelId para obter valores. 1 - Very High 2 - High 3 - Moderate 4 - Low 5 - Very Low 6 - Review
relevantInfo
:
String
Domínio de email de risco muito baixo para rede
risklevelId
:
String
Id do risco associado ao domínio. Somente um número é retornado. Possíveis valores 1 - Very High 2 - High 3 - Moderate 4 - Low 5 - Very Low 6 - Review
relevantInfoId
:
String
Código de 3 digitos que indica o relevância do dominio informado par a o email informado. Por exemplo 526 - Very Low Risk Email Domain for Network 501 - No Known Risk 502 - Risk Country 503 - High Risk Category 504 - High Risk Domain 505 - Recently Created 506 - Invalid Domain 507 - Low Risk Category 508 - Valid Domain From Country 509 - Valid Domain 510 - Low Risk Domain 511 - Review Risk Category 521 - Low Risk Email Domain for Company 522 - Low Risk Email Domain for Industry 523 - Low Risk Email Domain for Network 524 - Very Low Risk Email Domain for Company 525 - Very Low Risk Email Domain for Industry 526 - Very Low Risk Email Domain for Network 527 - High Risk Email Domain for Company 528 - High Risk Email Domain for Industry 529 - High Risk Email Domain for Network 530 - Very High Risk Email Domain for Company 531 - Very High Risk Email Domain for Industry 532 - Very High Risk Email Domain for Network
countryMatch
:
String
Indica se o país do email informado está relacionado ao endereço de entrega informado. Se retornado "NO", indica um alto risco de fraude. Retornará null caso o endereço não seja encontrado. Possíveis valores : Yes No Null
riskCountry
:
String
Indica se o domínio do email informado foi marcado como fraude em algum pais. Possíveis valores : Yes No Null
Campos:
overallScore
:
Int
Um valor total calculado usando um grau de confiança entre os dados informados na requisição e se eles pertencem a mesma pessoa.
emailToIpConfidence
:
Int
Score que relaciona os dados de email e do ip informados na requisição. Será informado um score entre 0 a 100.
emailToPhoneConfidence
:
Int
Score que relaciona os dados de email e do phone informados na requisição. Será informado um score entre 0 a 100.
emailToBillAddressConfidence
:
Int
Score que relaciona os dados de email e do billing address informados na requisição. Será informado um score entre 0 a 100.
emailToShipAddressConfidence
:
Int
Score que relaciona os dados de email e do shipping address informados na requisição. Será informado um score entre 0 a 100.
emailToFullNameConfidence
:
Int
Score que relaciona os dados de email e do nome completo (primeiro nome + sobrenome) informados na requisição. Será informado um score entre 0 a 100.
emailToLastNameConfidence
:
Int
Score que relaciona os dados de email e do sobrenome informados na requisição. Será informado um score entre 0 a 100.
ipToPhoneConfidence
:
Int
Score que relaciona os dados de ip e do phone informados na requisição. Será informado um score entre 0 a 100.
ipToBillAddressConfidence
:
Int
Score que relaciona os dados de ip e do billing address informados na requisição. Será informado um score entre 0 a 100.
ipToShipAddressConfidence
:
Int
Score que relaciona os dados de ip e do shipping address informados na requisição. Será informado um score entre 0 a 100.
ipToFullNameConfidence
:
Int
Score que relaciona os dados de ip e do nome completo (primeiro nome + sobrenome) informados na requisição. Será informado um score entre 0 a 100.
ipToLastNameConfidence
:
Int
Score que relaciona os dados de ip e do sobrenome informados na requisição. Será informado um score entre 0 a 100.
phoneToBillAddressConfidence
:
Int
Score que relaciona os dados de telefone e do billing address informados na requisição. Será informado um score entre 0 a 100.
phoneToShipAddressConfidence
:
Int
Score que relaciona os dados de phone e do shipping address informados na requisição. Será informado um score entre 0 a 100.
phoneToFullNameConfidence
:
Int
Score que relaciona os dados de phone e do nome completo (primeiro nome + sobrenome) informados na requisição. Será informado um score entre 0 a 100.
phoneToLastNameConfidence
:
Int
Score que relaciona os dados de phone e do sobrenome informados na requisição. Será informado um score entre 0 a 100.
billAddressToFullNameConfidence
:
Int
Score que relaciona os dados de billing addresse do nome completo (primeiro nome + sobrenome) informados na requisição. Será informado um score entre 0 a 100.
billAddressToLastNameConfidence
:
Int
Score que relaciona os dados de billing addresse do sobrenome informados na requisição. Será informado um score entre 0 a 100.
shipAddressToBillAddressConfidence
:
Int
Score que relaciona os dados de shipping address e do billing address informados na requisição. Será informado um score entre 0 a 100.
shipAddressToFullNameConfidence
:
Int
Score que relaciona os dados de shipping address e do nome completo informados na requisição. Será informado um score entre 0 a 100.
shipAddressToLastNameConfidence
:
Int
Score que relaciona os dados de shipping address e do sobrenome informados na requisição. Será informado um score entre 0 a 100.
Campos:
riskLevelId
:
Int
Retorna um identificador do IP informado relacionado ao risco de fraude.
Por exemplo:
1 - Very High
2 - High
3 - Moderate
4 - Low
5 - Very Low
6 - Review
riskReasonId
:
Int
Infomações adicionais sobre o risco de fraude do ip informado.
Por exemplo:
310 - IP Not Found
311 - Moderate By Proxy Reputation And Country Code [Good/High Risk/Moderate Risk Level] Proxy And [Country Code] IP
312 - Invalid IP Syntax
313 - TOR Network IP
riskLevel
:
String
Descrição do risco de fraude do IP informado. Por exemplo 1 - Very High 2 - High 3 - Moderate 4 - Low 5 - Very Low 6 - Review
riskReason
:
String
Descrição do identificador do motivo ipreasonId
TOR Network IP
Invalid IP Syntax
IP Not Found
TOR Network IP
reputation
:
String
A indicação de que ip informado está em proxu aberto. Possible values: Good Moderate High Risk Very High Risk
anonymousDetected
:
String
A indicação de que ip informado é anonimo. Possible values Yes No
proxyType
:
String
Tipo de proxy do servidor. Para um proxy não identificado o valor retornado será null. Os valores não são estáticos e podem mudar. Possible values : anonymous transparent hosting corporate public edu aol blackberry Null
isp
:
String
Nome do provedor de serviço do IP informado.
org
:
String
Nome da organização provedora do serviço do IP informado.
userType
:
String
Tipo do IP usado. wifi wired dialup mobile satellite business cafe cellular college contentDeliveryNetwork government hosting library military residential router school searchEngineSpider traveler
netSpeedCell
:
String
Velocidade da internet provedora do IP informado. Possible values broadband ultrabb dialup cable/DSL corporate cellular
corporateProxy
:
String
Indica se o IP informado é corporativo. Exemplo Yes No null
continentCode
:
String
O continente associado ao IP informado. Por exemplo: North America South America.
country
:
String
Nome do país associado ao IP informado.
countryCode
:
String
Código de 2 digitos ISO 3166-1 do país associado com o IP informado. Por exemplo: A1 - an anonymous proxy. A2 - a satellite provider. EU - an IP in a block used by multiple European countries. AP - an IP in a block used by multiple Asia/Pacific region countries.
city
:
String
Cidade aonde está alocado o IP informado.
callingcode
:
String
Código de área do IP informado.
metroCode
:
String
Código válido apenas para IPs do Estados Unidos.
map
:
String
URL do mapa mostrando a localização do IP.
countrymatch
:
String
Indica se o pais do IP informado combinado com o endereço de cobrança (billing address) informado. Por exemplo: Yes No null
latitude
:
Float
Latitude associada ao IP informado.
longitude
:
Float
Longitude associada ao IP informado.
Campos:
score
:
Int
Código númerico da informação relevante.
statusId
:
Int
Identificador do status do email informado. Por exemplo 1 - Certified 2 - Verified 3 - EmailInexistent 4 - ValidDomain 5 - DomainInexistent 6 - Unknown
reasonId
:
Int
Código númerico da informação relevante.
adviceId
:
Int
Código da recomendação de decisão. 1 - Fraud Review 2 - Unclear Risk 3 - Lower Fraud Risk 4 - Moderate Fraud Risk 11 - Data Entry Review
riskBandId
:
Int
Informação da banda de risco. 1 - Fraud Score 0 to 100 2 - Fraud Score 101 to 300 3 - Fraud Score 301 to 600 4 - Fraud Score 601 to 799 5 - Fraud Score 800 to 899 6 - Fraud Score 900 to 999
status
:
String
Descrição do status Certified, Verified, emailinexistent, valid domain, unknown
reason
:
String
Informação relevante. Principal motivo que levou a Emailage a atribuir o Score de Risco.
advice
:
String
Fraud Review Unclear Risk Lower Fraud Risk Moderate Fraud Risk Data Entry Review
riskBand
:
String
Descrição da banda de risco.
Campos:
address
:
String
Email informado na requisição.
exists
:
String
Informa se o e-mail existe ou não. Possíveis respostas: Yes No Null
gender
:
String
O sexo da pessoa atrelada ao email informado.
location
:
String
Localização da pessoa atrelada ao email informado.
company
:
String
Empresa da pessoa atrelada ao email informado.
title
:
String
Título da pessoa atrelada ao email informado.
nameMatch
:
String
Indicação se o primeiro nome (firstname) e sobrenome (lastname) estão atrelados ao email informado. Possíveis valores são: Y Full Match P Partial Match N No Match U Owner Unknown Null If any required values not passed
countryMatch
:
String
Indica se o país do email informado está relacionado ao endereço de entrega informado. Se retornado "NO", indica um alto risco de fraude. Retornará null caso o endereço não seja encontrado. Possíveis valores Yes No Null
sourceIndustry
:
String
Caso o email seja marcado como fraude ou bom por outra empresa, este campo representa o segmento da empresa que o marcou.
dateOfBirth
:
String
Data de nascimento da pessoa atrelada ao email informado.
fraudRisk
:
String
Código composto pelo Score (número com 3 dígitos) + Descrição da banda de risco
fraudType
:
String
Tipo de fraude detectada para o email informado. Por exemplo: Card Not Present Fraud Customer Dispute (Chargeback) First Party Fraud First Payment Default Identify Theft (Fraud Application) Identify Theft (Account Take Over) Suspected Fraud (Not Confirmed) Synthetic ID Other System Auto Reject Null
billRiskCountry
:
String
Indica se o país endereço de entrega informado está relacionado ao país do email informado. Essa informação funciona somente para endereços dos Estados Unidos. Retornará null caso o endereço não seja encontrado. Possíveis valores Yes No Null
totalHits
:
String
Número de vezes que o email informado foi consultado na plataforma de verificação de email.
uniqueHits
:
String
Número de diferentes empresas que consultaram o email informado na plataforma de verificação de email.
firstVerification
:
String
Data em que o e-mail foi visto pela primeira vez na Web (usado para indicar a idade aproximada do e-mail e influenciar no Score de Risco).
lastVerification
:
String
Data da última consulta deste e-mail na Rede Emailage.
lastFlaggEdon
:
String
Caso o email seja marcado como fraude por outra empresa, este campo representa a data da última marcação.
socialMedia
:
socialMediaRiskScoreResponse
Retornará URLs de redes sociais atreladas ao email informado. Examplo: "smlinks": [ { "source": "GooglePlus", "link": "https //plus.google.com/1088601845" } ]
Campos:
number
:
String
Número de telefone informado na requisição.
status
:
String
Indica se o telefone informado é valido. Possiveis valores: Valid Invalid Null
countryCode
:
String
Número de 2 digitos que identica o código do pais.
carrier
:
String
Nome da operadora relacionada ao telefone informado.
carrierType
:
String
Tipo do telefone informado. Possiveis valores: landline fixed_line mobile prepaid toll_free voip pager payphone invalid restricted_premium personal voicemail other Null
ownerName
:
String
Nome da pessoa relacionado ao telefone informado. Se não encontrado retornará null.
ownerNameMatch
:
String
Comparação entre os campos firstname e lastname e o dono do telefone Informado. Esse atributo é valido para telefones dos Estados Unidos. Possiveis valores: Y Full Match P Partial Match N No Match U Owner Unknown Null
ownerType
:
String
Indica o tipo do dono do telefone informado.
Possible values
Business
Consumer
Null
Campos:
issuerBank
:
String
Detalhes do banco emissor relacionado ao BIN informado.
issuerBrand
:
String
Bandeira dona do BIN informado. Por exemplo: Elo Master Visa
issuerCountry
:
String
Código de 2 digitos do país do banco emissor. Por exemplo BR US
cardCategory
:
String
Produto relacionado ao BIN do cartão. Por exemplo Grafite Nanquim Business Platinum
cardType
:
String
Indica o tipo de cartão. Somente os ids são retornados. Por exemplo: 1 - Credit 2 - Debit 3 - Prepaid 4 - Charge Card 5 - Debit or Credit 6 - Unknown
Campos:
exists
:
Int
Email enviado na requisição.
ownerNameMatch
:
Int
Indica se o nome associado ao e-mail corresponde ao "nome" e Valores "lastName" que foram fornecidos. Valores possíveis: 1 - Partida completa 2 - Correspondência parcial 3 - Sem correspondência 4 - Proprietário desconhecido Nulo - se algum valor necessário não passado
totalHits
:
Int
Número de vezes que o email sofreu buscas na plataforma.
uniqueHits
:
Int
Número único de empresas que consultaram esse email na plataforma.
firstVerificationDate
:
String
O registro mais antigo encontrado que está associado ao email informado na requisição.
created
:
String
A data de criação do email informado na requisição no formato UTC.
dateOfBirth
:
String
Data de nascimento no formato ISO 8601.
lastFlaggedOn
:
String
A ultima data em que o email foi marcado como fraude ou como boa reputação na plataforma.
ownerName
:
String
O nome da pessoa associada ao email informado na requisição.
gender
:
String
O genero da pessoa associada ao email informado na requisição.
location
:
String
A localização associada ao email informado na requisição.
company
:
String
Nome da empresa associada a pessoa com o email informado na requisição.
title
:
String
O título da pessoa. Por exemplo: Sr. Sra.
lastFlaggedIndustry
:
String
Se o email foi marcado com boa reputação ou como fraude, esse campo retorna o tipo de industria que marcou o email. Por exemplo:
Airlines
Apparel / Jewelry
Banking / Finance
Computers / Electronics
Electronics
score
:
scoreRiskScoreResponse
A pontuação de informações relevantes para o tipo de resposta associado. Por favor, veja tabelas de ID de informações relevantes para possíveis valores
A razão do score estar associado ao email informado na requisição. Exemplo de score.reason: FRAUD_OWN EMAIL_CREATED_LAST_WEEK GOOD_LEVEL_6 MAILBOX_IS_INACTIVE
socialMedia
:
socialMediaRiskScoreResponse
Campos:
exists
:
Int
Indicação se o domínio do email informado existe ou não. Por exemplo: 1 - Yes 2 - No 3 - Not Anymore 4 - Not Sure
categoryCode
:
Int
Tipo de empresa da qual o dominio informado na requisição pertence.
corporate
:
Int
Indica se o domínio é corporativo. Por exemplo: 1 - Yes 2 - No 3 - Not Sure
created
:
String
A data e hora da criação do domínio no padrão ISO 8601.
name
:
String
Nome do domínio do email informado na requisição.
company
:
String
Nome da empresa dona do domínio informado.
country
:
String
País na qual o domínio do email informado na requisição pertence.
score
:
scoreRiskScoreResponse
A razão do score estar associado ao domínio informado na requisição.
Por exemplo de score.reason: FRAUD_OWN EMAIL_CREATED_LAST_WEEK GOOD_LEVEL_6 MAILBOX_IS_INACTIVE
Campos:
id
:
String
Este é um ID de registro definido pelo usuário. Este parâmetro pode ser usado quando você deseja adicionar um identificador para uma consulta. Este identificador irá ser retornado com os resultados.
cardType
:
Int
Indica o tipo de cartão. Somente os ids são retornados. Por exemplo: 1 - Credit 2 - Debit 3 - Prepaid 4 - Charge Card 5 - Debit or Credit 6 - Unknown
isPrepaid
:
Boolean
Indica se o cartão do BIN informado é um cartão pré pago.
issuerBank
:
String
Emissor do cartão. Por exemplo: Banco do Brasil Bradesco Caixa Economica
issuerBrand
:
String
Bandeira do cartão. Por exemplo: Elo
issuerCountry
:
String
O código do país do emissor do cartão. Por exemplo: BR
cardCategory
:
String
Indica o tipo do produto cartão: Por exemplo: Nanquim Grafite Elo Mais Empresarial Grafite
score
:
scoreRiskScoreResponse
A razão do score estar associado a transação informada na requisição.
Por exemplo score.reason: VERY_HIGH_RISK_CUSTOMERID_FOR_COMPANY HIGH_RISK_CUSTOMERID_FOR_COMPANY MODERATE_RISK_TRANSACTION
Campos:
source
:
Int
Código do fabricante do dispositivo.
id
:
String
Identificador o dispositivo informado no request.
score
:
scoreRiskScoreResponse
A razão do score estar associado a transação informada na requisição.
Por exemplo score.reason: VERY_HIGH_RISK_CUSTOMERID_FOR_COMPANY HIGH_RISK_CUSTOMERID_FOR_COMPANY MODERATE_RISK_TRANSACTION
Campos:
address
:
String
Endereço IP enviado na requisição.
isCorporateProxy
:
Boolean
Indica se o proxy é corporativo Por exemplo: True False Not returned if not avaliable
isRiskCountry
:
Boolean
Indica se o proxy está associado a um alto risco de fraude. Por exemplo: True False Not returned if not avaliable
isCountryMatch
:
Boolean
Indica se o país do IP informado na requisição corresponde com o endereço de entrega. Por exemplo: True False Not returned if not avaliable
isAnonymous
:
Boolean
Indica se o IP informado na requisição é um IP anonimo. Por exemplo: True False Not returned if not avaliable
reputation
:
Int
É reputação do proxy. Indica a probabilidade do usuário do IP de ser um proxy aberto. Somente os números são retornados.
Por exemplo: 0 - Unknown 1 - Good 2 - Moderate 3 - High Risk 4 - Very High Risk
proxyType
:
Int
Por exemplo: 1 - Anonymous 2 - Transparent 3 - Hosting 4 - Corporate 5 - Public 6 - Education (EDU) 7 - AOL 8 - Blackberry Null
proxyIdentification
:
Int
Método do proxy. Somente números são retornados. Por exemplo: 1 - Tor Exit 2 - Tor Relay 3 - Cloud 4 - VPN 5 - DNS 6 - Web-Browser 7 - Cloud-Security Null
billingAddressDistance
:
Float
A distância do endereço IP local para o local de cobrança em quilômetros inteiros. Uma distância maior indica um risco maior de fraude
registration
:
registrationRiskScoreResponse
location
:
locationRiskScoreResponse
score
:
scoreRiskScoreResponse
Campos:
existingCustomer
:
Boolean
CPF em SHA256 do usuário que pertence ao IP informado.
location
:
String
A localização do serviço que está sendo usado na transação. Por exemplo:
Traveling - Flight route
Hospitality - Hotel location
Ticketing - Event location
Technology/Finance/eCommerce
The location of the final service/ channel/profile
detail
:
String
Detalhes e outras informações sobre o serviço.
category
:
String
Catergoria geral do serviço utilizado na transação. Por exemplo:
Traveling: Ticket class (e.g Business, First, etc.)
Hospitality - Room type
Ticketing - Event category
Technology/Finance/eCommerce -
Product category
deliveryType
:
String
Tipo da entrega do serviço. Por exemplo:
Digital download
Shipped
Store pickup
date
:
String
Data e hora do serviço em formato ISO 8601 UTC.
score
:
scoreRiskScoreResponse
A razão do score estar associado ao tipo do serviço. Por exemplo score.reason: VERY_HIGH_RISK_SERVICE_LOCATION_FOR_COMPANY HIGH_RISK_SERVICE_LOCATION_FOR_COMPANY MODERATE_RISK_SERVICE_DETAILS
Campos:
isBillingLocation
:
Boolean
Indica se o telefone informado na requisição está no endereço de cobrança informado na requisição. Por exemplo: True False Null Definitions: True: The customer’s phone number is in the billing address location. False: Indicates that the phone number may be in a different area, or it is not in our database. Null: Indicates that the phone number prefix is not in our database.
number
:
String
Número de telefone informado na requisição.
ownerNameMatch
:
Int
Comparação entre os resultados do nome (name) e sobrenome (lastname) informados na requisição e os nomes encontrados na base relacionados ao telefone. 1 - Full Match 2 - Partial Match 3 - No Match 4 - Owner Unknown Null-When owner name is not provided
countryCode
:
String
Número de 3 digitos que identica o código do pais (https://en.wikipedia.org/wiki/Mobile_country_code)
carrier
:
String
Nome da companhia telefonica.
ownerName
:
String
Nome da pessoa que é dona do telefone celular informado.
ownerType
:
String
Indica o tipo de dono que está associado ao telefone. Por exemplo:
Business
Consumer
Unavailable
score
:
scoreRiskScoreResponse
A razão do score estar associado ao telefone informado na requisição. Por exemplo score.reason: VERY_HIGH_RISK_PHONE_FOR_COMPANY INVALID_PHONE HIGH_RISK_PHONE_FOR_INDUSTRY
Campos:
isShipForward
:
Boolean
Indica se o endereço de entrega do email informado tem alto risco de fraude. Por exemplo:
True
False
Null
isShipCityPostalMatch
:
Boolean
Indica se o endereço de entrega do email informado está associado corretamente ao código postal. Por exemplo:
True
False
Null
isBillCityPostalMatch
:
Boolean
Indica se a cidade do endereço de cobrança e o estado combinam. Por exemplo:
True
False
Null
addressCheck
:
Int
Indica se o endereço de entrega é real. Por exemplo: 1 - Real 2 - Active 3 - Vacant 4 - Unknown
street1
:
String
Endereço de cobrança.
street2
:
String
Endereço de cobrança.
city
:
String
Cidade do endereço de cobrança.
regionCode
:
String
A estado ou região do endereço de cobrança.
postalCode
:
String
O código postal do endereço de entrega.
countryCode
:
String
O país do endereço de entrega. Formato de 2 digitos do país. Por exemplo: BR US
company
:
String
Empresa do usuário fornecida nas informações de endereço.
type
:
String
obrigatórioTipo do endereço Exemplo: Billing Shipping
score
:
scoreRiskScoreResponse
A razão do score estar associado ao endereço de cobrança informado na requisição. Por exemplo score.reason: VERY_HIGH_RISK_BILLADDRESS_FOR_INDUSTRY HIGH_RISK_BILLADDRESS_FOR_NETWORK MODERATE_RISK_BILLADDRESS
Campos:
correlationId
:
String
Id interno da emailage.
version
:
String
Versão da API.
created
:
String
Data e hora da criação do registro da consulta.
trackingId
:
String
Identificador para rastrear a requesição. Usado pelo cliente.
score
:
Int
Valor calculado por um algoritmo. Representa o risco de fraude associado ao itens informados na requisição. Retorna um valor entre 0-1000. Por exemplo: 0-1000.
reason
:
String
Retorna a razão mais relevante que influência o risco de fraude retornado no campo score.
riskBand
:
Int
Retorna o Identificador (id) do range de fraude calculado. Por exemplo: 1 - Fraud Score 0 to 100 2 - Fraud Score 101 to 300 3 - Fraud Score 301 to 600 4 - Fraud Score 601 to 799 5 - Fraud Score 800 to 899 6 - Fraud Score 900 to 999