Personal Data Check API Documentation
Welcome to the documentation for Personal Data Check API. This API empowers you to perform in-depth validations on digital user profiles, using a combination of email analysis, social media activity, IP address scrutiny, and global phone number verification.
Overview
Personal Data Check is designed to provide you with comprehensive user validation capabilities. It allows you to assess user authenticity, detect potential risks, and prevent fraudulent activities. With a set of four powerful endpoints, this API equips you to perform a wide range of user validations efficiently.
Email Validation
Obtains a risk score associated with an email by analyzing its activity on social networks and other online profiles.
Endpoint: POST ~/api/PersonalDataCheck/EmailCheck
Headers:
Tag | Type | Required | Description |
---|---|---|---|
apikey | string | yes | Customer key. |
- ApiKey (string, required): Customer key for authentication.
Parameters FromForm:
Tag | Type | Required | Description |
---|---|---|---|
String | Yes | The email to validate. |
- email (string, required): the email to validate.
Response:
200 Success
Response: When a successful response is received
{
"success": true,
"error": null,
"data": {
"email": "string",
"score": 80,
"deliverable": false,
"domainDetails": {
"domain": "string",
"tld": "string",
"created": "string (formato ISO 8601)",
"updated": "string (formato ISO 8601)",
"expires": "string (formato ISO 8601)",
"registered": true, // is boolean but can be null,
"registrarName": "string",
"registeredTo": "string (o null)",
"disposable": true,
"free": false,
"custom": false,
"dmarcEnforced": false,
"spfStrict": true,
"validMx": false,
"acceptAll": false,
"suspiciousTld": false,
"websiteExists": true
},
"accountDetails": {
"facebook": {
"url": "string (URL)",
"name": "string",
"photo": "string (URL de la imagen) o null",
"registered": true // is boolean but can be null
},
"google": {
"photo": "string (URL de la imagen) o null",
"registered": false // is boolean but can be null
},
"apple": {
"registered": true // is boolean but can be null
},
"twitter": {
"registered": true // is boolean but can be null
},
"microsoft": {
"registered": true // is boolean but can be null
},
"yahoo": {
"registered": false // is boolean but can be null
},
"ebay": {
"registered": null // is boolean but can be null
},
"gravatar": {
"registered": true // is boolean but can be null
},
"instagram": {
"registered": false // is boolean but can be null
},
"spotify": {
"registered": true // is boolean but can be null
},
"tumblr": {
"registered": true // is boolean but can be null
},
"linkedin": {
"url": "string or null",
"name": "string or null",
"company": "string or null",
"title": "string or null",
"location": "string or null",
"website": "string or null",
"twitter": "string or null",
"photo": "string or null",
"registered": null // is boolean but can be null
},
"weibo": {
"registered": true // is boolean but can be null
},
"github": {
"registered": true // is boolean but can be null
},
"vimeo": {
"registered": true // is boolean but can be null
},
"flickr": {
"registered": true // is boolean but can be null
},
"foursquare": {
"registered": null // is boolean but can be null
},
"lastfm": {
"registered": null // is boolean but can be null
},
"myspace": {
"registered": true // is boolean but can be null
},
"pinterest": {
"registered": true // is boolean but can be null
},
"skype": {
"country": "string",
"city": "string",
"gender": "string o null",
"name": "string",
"id": "string",
"handle": "string",
"bio": "string o null",
"age": "number o null",
"language": "string o null",
"state": "string",
"photo": "string (URL de la imagen)",
"registered": true // is boolean but can be null
},
"discord": {
"registered": true // is boolean but can be null
},
"ok": {
"registered": false, // is boolean but can be null ,
"city": "string o null",
"age": "number o null",
"dateJoined": "string (formato ISO 8601) o null"
},
"kakao": {
"registered": null // is boolean but can be null
},
"booking": {
"registered": true // is boolean but can be null
},
"airbnb": {
"registered": null, // is boolean but can be null ,
"about": "string o null",
"createdAt": "string (formato ISO 8601) o null",
"firstName": "string o null",
"identityVerified": true, //or false or null,
"location": "string o null",
"image": "string (URL de la imagen) o null",
"revieweeCount": "number o null",
"trips": "number o null",
"work": "string o null"
},
"amazon": {
"registered": null // is boolean but can be null
},
"qzone": {
"registered": false // is boolean but can be null
}
},
"breachDetails": {
"brequaches": [
{
"name": "string",
"domain": "string (o null)",
"date": "string (formato ISO 8601) o null"
}
],
"haveibeenpwnedListed": true,
"numberOfBreaches": 80,
"firstBreach": "string (formato ISO 8601)"
},
"appliedRules": [
{
"id": "string",
"name": "string",
"operation": "+ o -",
"score": 80
}
]
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Indicates whether the operation was successful. |
error | Null or string | Error message in case an error occurs. |
data | Object | Contains the details of the query. |
String | E-mail address. | |
score | Number | A score from 0 to 100 indicates the probability that the email address is fraudulent. |
deliverable | Boolean | Indicates if the mail is deliverable. |
domainDetails | Object | Details related to the e-mail domain. |
domain | String | Domain name. |
tld | String | Top-level domain extension. |
created | String | Creation date (ISO 8601 format). |
updated | String | Update date (ISO 8601 format). |
expires | String | Expiration date (ISO 8601 format). |
registered | Boolean or Null | Indicates if the domain is registered. |
registrarName | String | Registrar's name. |
registeredTo | String or null | Name of the registered owner. |
disposable | Boolean | Indicates if the domain is disposable. |
free | Boolean | Indicates if the domain is free. |
custom | Boolean | Indicates if the domain is custom. |
dmarcEnforced | Boolean | Indicates if DMARC is enforced. |
spfStrict | Boolean | Indicates if SPF is strict. |
validMx | Boolean | Indicates if there are valid MX servers. |
acceptAll | Boolean | Indicates if all emails are accepted. |
suspiciousTld | Boolean | Indicates if the top-level domain is suspicious. |
websiteExists | Boolean | Indicates if the associated website exists. |
appliedRules | Array of Objects | Applied rules and their details. |
appliedRule | Object | Object for appliedRules |
id | String | Unique identifier of the rule. |
name | String | Name of the rule. |
operation | "+" or "-" | Operation performed by the rule. |
score | Number | Score assigned by the rule. |
breachDetails | Object | Details about security breaches related to the email. |
haveibeenpwnedListed | Boolean | Indicates if the account is listed in "Have I Been Pwned". |
numberOfBreaches | Number | Total number of security breaches. |
firstBreach | String | Date of the first security breach. |
brequaches | Array of Objects | Details of security breaches. |
breach | Object | Object of brequaches |
name | String | Name of the breach. |
domain | String or Null | Domain associated with the breach. |
date | String or Null | Date of the breach (ISO 8601 format). |
accountDetails | Object | Details of accounts associated with providers. |
Object | Details of the Facebook account. | |
url | String | URL of the Facebook profile. |
name | String | Name associated with the account. |
photo | String or Null | URL of the profile picture or null. |
registered | Boolean or Null | Indicates if the account is registered. |
Object | Details of the Google account. | |
photo | String | URL of the profile picture or null. |
registered | Boolean or Null | Indicates if the account is registered. |
Object | Details of the LinkedIn account. | |
url | String or Null | URL of the LinkedIn profile or null. |
name | String or NULL | Name associated with the account |
company | String or Null | Company name or null. |
title | String or Null | Job title or null. |
location | String or Null | Location or null. |
website | String or Null | Website URL or null. |
String or Null | Twitter handle or null. | |
photo | String or Null | URL of the profile picture or null. |
registered | Boolean or Null | Indicates if the account is registered. |
skype | Object | Details of the Skype account. |
country | String | Country associated with the account. |
city | String | City associated with the account. |
gender | String or Null | Gender or null. |
name | String | Name associated with the account. |
id | String | Unique identifier of the account. |
handle | String | Handle associated with the account. |
bio | String or Null | Biography or null. |
age | Number or Null | Age or null. |
language | String or Null | Language or null. |
state | String | State associated with the account. |
photo | String | URL of the profile picture. |
registered | Boolean or Null | Indicates if the account is registered. |
ok | Object | Details of the OK account. |
registered | Boolean or Null | Indicates if the account is registered or null. |
city | String or Null | City associated with the account or null. |
age | Number or Null | Age or null. |
dateJoined | String or Null | Date of joining (ISO 8601 format) or null. |
airbnb | Object | Details of the Airbnb account. |
registered | Boolean or Null | Indicates if the account is registered |
about | String or Null | Information about the account or null. |
createdAt | String or Null | Creation date (ISO 8601 format) or null. |
firstName | String or Null | First name or null. |
identityVerified | Boolean or Null | Indicates if identity is verified |
location | String or Null | Location or null. |
image | String or Null | URL of the profile picture or null. |
revieweeCount | Number or Null | Number of reviews received or null. |
trips | Number or Null | Number of trips or null. |
work | String or Null | Work information or null. |
SM | Object | Object for all other accounts |
registered | Boolean or Null | Indicates if the account is registered in SM |
apple | SM Object | Details of the Apple account. |
SM Object | Details of the Twitter account. | |
microsoft | SM Object | Details of the Microsoft account. |
yahoo | SM Object | Details of the Yahoo account. |
ebay | SM Object | Details of the eBay account. |
gravatar | SM Object | Details of the Gravatar account. |
SM Object | Details of the Instagram account. | |
spotify | SM Object | Details of the Spotify account. |
tumblr | SM Object | Details of the Tumblr account. |
SM Object | Details of the Weibo account. | |
github | SM Object | Details of the GitHub account. |
vimeo | SM Object | Details of the Vimeo account. |
flickr | SM Object | Details of the Flickr account. |
foursquare | SM Object | Details of the Foursquare account. |
lastfm | SM Object | Details of the Last.fm account. |
myspace | SM Object | Details of the Myspace account. |
SM Object | Details of the Pinterest account. | |
discord | SM Object | Details of the Discord account. |
kakao | SM Object | Details of the Kakao account. |
booking | SM Object | Details of the Booking account. |
amazon | SM Object | Details of the Amazon account. |
qzone | SM Object | Details of the Qzone account. |
204 NotFound
When the information was not found in the source of verification.
{}
400, 500, 501 Bad Request, Internal server Error & Error not Implemented
When the parameters do not have the correct format, internal error in our server or an uncontrolled error occurs.
{
"success": false,
"data": null, // Data, which can be of any type or null
"error": {
"request": "string",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 400
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
401, 504 Unauthorized, Not Found, Method Not Allowed & Timeout
When no authentication, Method not found or not allowed, or Timeouts errors occur.
{
"success": false,
"data": null, // Data, which can be of any type or null
"error": {
"request": "string",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 401
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
IP Validation
Identifies suspicious VPNs, TOR users and risky locations in real time by analyzing IP addresses.
Endpoint: POST ~/api/PersonalDataCheck/IPCheck
Headers:
Tag | Type | Required | Description |
---|---|---|---|
apikey | string | yes | Customer key. |
- ApiKey (string, required): Customer key for authentication.
Parameters FromForm:
Tag | Type | Required | Description |
---|---|---|---|
IP | String | Yes | The IP to validate. |
- IP (string, required): The IP to validate.
Response:
200 Success
Response: When a successful response is received
{
"success": true,
"data": {
"ip": "string",
"score": 9,
"country": "string",
"stateProv": "string",
"city": "string",
"timezoneOffset": "string",
"ispName": "string",
"latitude": 34.0522,
"longitude": -118.2437,
"type": "string",
"openPorts": [8080, 80],
"tor": true,
"vpn": false,
"webProxy": true,
"publicProxy": false,
"spamNumber": 1,
"spamUrls": ["string", ...],
"appliedRules": [
{
"id": "string",
"name": "string",
"operation": "+ or -",
"score": 8
},
]
},
"error": null
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
error | Object or Null | Object containing error details or null if no error. |
data | Object | Object containing IP information. |
ip | String | IP address as a string. |
score | Number | A score from 0 to 100 indicates the probability that the IP is fraudulent. |
country | String | Country code or name. |
stateProv | String | State or province name. |
city | String | City name. |
timezoneOffset | String | Timezone offset in the format ±HH:MM. |
ispName | String | ISP (Internet Service Provider) name. |
latitude | Number | Latitude coordinate. |
longitude | Number | Longitude coordinate. |
type | String | Type of IP address (e.g., "CDN"). |
openPorts | [Number] | An array of open port numbers. |
tor | Boolean | Indicates if it's a TOR exit node (true/false). |
vpn | Boolean | Indicates if it's a VPN IP (true/false). |
webProxy | Boolean | Indicates if it's a web proxy IP |
publicProxy | Boolean | Indicates if it's a public proxy IP |
spamNumber | Number | Number of spam blacklists the IP is listed in. |
spamUrls | [String] | An array of spam URLs. |
appliedRules | [Object] | An array of applied rules, each with properties: |
id | String | Rule ID. |
name | String | Rule name. |
operation | String | Operation applied (+ for addition, -for subtraction). |
score | Number | Score assigned by the rule. |
204 NotFound
When the information was not found in the source of verification. The legal entity name may not be correct.
{}
400, 500, 501 Bad Request, Internal server Error & Error not Implemented
When the parameters do not have the correct format, internal error in our server or an uncontrolled error occurs.
{
"success": false,
"data": null,
"error": {
"request": "string",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 400
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
401, 504 Unauthorized & Timeout Error
When no authentication or Timeouts errors occur.
{
"success": false,
"data": null,
"error": {
"request": "string or null",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 401
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
Phone Validation
Check the validity of international phone numbers and obtain information associated with them.
Endpoint: POST ~/api/PersonalDataCheck/PhoneCheck
Headers:
Tag | Type | Required | Description |
---|---|---|---|
apikey | string | yes | Customer key. |
- ApiKey (string, required): Customer key for authentication.
Parameters FromForm:
Tag | Type | Required | Description |
---|---|---|---|
phone | String | Yes | Telephone in international format E.164 |
- phone (string, required): Telephone in international format E.164 (e.g., 36301234567 or 0036301234567).
Response:
200 Success
Response: When a successful response is received
{
"success": true,
"error": null,
"data": {
"number": 36301234567,
"valid": true,
"disposable": true,
"type": "string",
"country": "string",
"carrier": "string",
"score": 0,
"accountDetails": {
"facebook": {
"registered": false
},
"google": {
"registered": false
},
"twitter": {
"registered": false
},
"instagram": {
"registered": true
},
"yahoo": {
"registered": false
},
"microsoft": {
"registered": false
},
"snapchat": {
"registered": false
},
"skype": {
"country": "string",
"city": "string",
"gender": "string or null",
"name": "string",
"id": "string",
"handle": "string",
"bio": "string",
"age": "string or 55",
"language": "string",
"state": "string",
"photo": "string",
"registered": true
},
"whatsapp": {
"registered": false,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"telegram": {
"registered": null,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"viber": {
"registered": null,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"kakao": {
"registered": false
},
"ok": {
"registered": false
},
"zalo": {
"registered": false
},
"line": {
"registered": false,
"name": "string",
"photo": "string"
}
},
"appliedRules": [
{
"id": "string",
"name": "string",
"operation": "+ or -",
"score": 0
}
]
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Indicates if the request was successful (true/false). |
error | Object or Null | Details of the error, or null if there is no error. |
data | Object | Contains detailed information about the phone number. |
number | Number | Phone number as a number. |
valid | Boolean | Indicates if the phone number is valid (true/false). |
disposable | Boolean | Indicates if it's a disposable number (true/false). |
type | String | Type of phone number (e.g.,"string"). |
country | String | Country code or name. |
carrier | String | Name of the carrier. |
score | Number | A score from 0 to 100 indicates the probability that the phone number is fraudulent. |
accountDetails | Object | Contains details about different types of accounts. |
accountDetail | [Object] | objet Object for AccountDetails |
registered | Boolean | Indicates if the account is registered (true/false). |
Object | accountDetail Object | |
Object | accountDetail Object | |
Object | accountDetail Object | |
Object | accountDetail Object | |
yahoo | Object | accountDetail Object |
microsoft | Object | accountDetail Object |
snapchat | Object | accountDetail Object |
skype | Object | Details of the Skype account. |
country | String | Country of the Skype account. |
city | String | City of the Skype account. |
gender | String or Null | Gender of the Skype account. |
name | String | Name of the Skype account. |
id | String | ID of the Skype account. |
handle | String | Handle of the Skype account. |
bio | String | Bio of the Skype account. |
age | String or 55 | Age of the Skype account. |
language | String | Language of the Skype account. |
state | String | State of the Skype account. |
photo | String | Photo URL of the Skype account. |
registered | Boolean | Indicates if the account is registered (true/false). |
Object | Details of the WhatsApp account. | |
registered | Boolean | Indicates if the account is registered (true/false). |
photo | String | Photo URL of the WhatsApp account. |
lastSeen | String | Last seen status of the WhatsApp account. |
name | String | Name of the WhatsApp account. |
about | String | About information of the WhatsApp account. |
telegram | Object | Details of the Telegram account. |
registered | Boolean | Indicates if the account is registered (true/false). |
photo | String | Photo URL of the Telegram account. |
lastSeen | String | Last seen status of the Telegram account. |
name | String | Name of the Telegram account. |
about | String | About information of the Telegram account. |
viber | Object | Details of the Viber account. |
registered | Boolean | Indicates if the account is registered (true/false). |
photo | String | Photo URL of the Viber account. |
lastSeen | String | Last seen status of the Viber account. |
name | String | Name of the Viber account. |
about | String | About information of the Viber account. |
kakao | Object | accountDetail Object |
ok | Object | accountDetail Object |
zalo | Object | accountDetail Object |
line | Object | accountDetail Object |
appliedRules | Array[Object] | List of applied rules with their details. |
id | String | ID of the applied rule. |
name | String | Name of the applied rule. |
operation | String | Operation (e.g., "+" or "-") for the rule. |
score | Number | Score associated with the rule. |
204 NotFound
When the information was not found in the source of verification. The legal entity name may not be correct.
{}
400, 500, 501 Bad Request, Internal server Error & Error not Implemented
When the parameters do not have the correct format, internal error in our server or an uncontrolled error occurs.
{
"success": false,
"data": null,
"error": {
"request": "string",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 400
}
}
}
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
401, 404, 405, 504 Unauthorized, Not Found, Method Not Allowed & Timeout
When no authentication, Method not found or not allowed, or Timeouts errors occur.
{
"success": false,
"data": null,
"error": {
"request": "string or null",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 401
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
Fraud Validation
Combines email, IP address and phone number validation in a single API call.
Endpoint: POST ~/api/PersonalDataCheck/FullCheck
Headers:
Tag | Type | Required | Description |
---|---|---|---|
apikey | string | yes | Customer key. |
- ApiKey (string, required): Customer key for authentication.
Tag | Type | Required | Description |
---|---|---|---|
String | Yes | The email to validate. | |
Phone | string | No | The phone to validate |
IP | string | No | The IP to validate |
- Email (string, required): The Email to validate.
- Phone (string): The phone to validate.
- IP (string): The IP to validate.
Response:
200 Success
Response: When a successful response is received
{
"success": true,
"error": null,
"data": {
"id": "string",
"state": "string",
"fraudScore": 0,
"binDetails": {},
"version": "string",
"appliedRules": [
{
"id": "string",
"name": "string",
"operation": "+ or -",
"score": 0
}
],
"deviceDetails": {},
"calculationTime": 0,
"seonId": 0,
"ipDetails": {
"ip": "string",
"score": 0,
"country": "string",
"stateProv": "string",
"city": "string",
"timezoneOffset": "string",
"ispName": "string",
"latitude": 0,
"longitude": 0,
"type": "string",
"openPorts": [80, 8080],
"tor": true,
"harmful": true,
"vpn": true,
"webProxy": true,
"publicProxy": true,
"spamNumber": 0,
"spamUrls": ["string", "string"],
"id": "string",
"history": {
"hits": 0,
"customerHits": 0,
"firstSeen": 0,
"lastSeen": 0
},
"flags": [
{
"note": "string",
"date": 0,
"industry": "string"
}
]
},
"emailDetails": {
"email": "string",
"score": 0,
"deliverable": true,
"domainDetails": {
"domain": "string",
"tld": "string",
"created": "string",
"updated": "string",
"expires": "string",
"registered": true,
"registrarName": "string",
"registeredTo": true,
"disposable": true,
"free": true,
"custom": true,
"dmarcEnforced": true,
"spfStrict": true,
"validMx": true,
"acceptAll": true,
"suspiciousTld": true,
"websiteExists": true
},
"accountDetails": {
"apple": {
"registered": true
},
"ebay": {
"registered": true
},
"facebook": {
"url": "string",
"name": "string",
"photo": "string",
"registered": true
},
"flickr": {
"registered": true
},
"foursquare": {
"registered": true
},
"github": {
"registered": true
},
"google": {
"photo": true,
"registered": true
},
"gravatar": {
"registered": true
},
"instagram": {
"registered": true
},
"lastfm": {
"registered": true
},
"linkedin": {
"url": "string",
"name": "string",
"company": "string",
"title": "string",
"location": "string",
"website": "string",
"twitter": "string",
"photo": "string",
"registered": true
},
"microsoft": {
"registered": true
},
"myspace": {
"registered": true
},
"pinterest": {
"registered": true
},
"skype": {
"country": "string",
"city": "string",
"gender": "string or null",
"name": "string",
"id": "string",
"handle": "string",
"bio": "string",
"age": "string or 55",
"language": "string",
"state": "string",
"photo": "string",
"registered": true
},
"spotify": {
"registered": true
},
"tumblr": {
"registered": true
},
"twitter": {
"registered": true
},
"vimeo": {
"registered": true
},
"weibo": {
"registered": true
},
"yahoo": {
"registered": true
},
"discord": {
"registered": true
},
"ok": {
"registered": true,
"city": "string",
"age": "string",
"dateJoined": "string"
},
"kakao": {
"registered": true
},
"booking": {
"registered": true
},
"airbnb": {
"registered": true,
"about": "string",
"createdAt": "string",
"firstName": "string",
"identityVerified": true,
"location": "string or null",
"image": "string",
"revieweeCount": 0,
"trips": 0,
"work": "string"
},
"amazon": {
"registered": true
},
"qzone": {
"registered": true
}
},
"breachDetails": {
"brequaches": [
{
"name": "string",
"domain": "string",
"date": "string"
}
],
"haveibeenpwnedListed": true,
"numberOfBreaches": 0,
"firstBreach": "string"
},
"id": "string",
"history": {
"hits": 0,
"customerHits": 0,
"firstSeen": 0,
"lastSeen": 0
},
"flags": [
{
"note": "string",
"date": 0,
"industry": "string"
}
]
},
"phoneDetails": {
"number": 0,
"valid": true,
"disposable": true,
"type": "string",
"country": "string",
"carrier": "string",
"score": 0,
"accountDetails": {
"facebook": {
"registered": true
},
"google": {
"registered": true
},
"twitter": {
"registered": true
},
"instagram": {
"registered": true
},
"yahoo": {
"registered": true
},
"microsoft": {
"registered": true
},
"snapchat": {
"registered": true
},
"skype": {
"country": "string",
"city": "string",
"gender": "string or null",
"name": "string",
"id": "string",
"handle": "string",
"bio": "string",
"age": "string or 55",
"language": "string",
"state": "string",
"photo": "string",
"registered": true
},
"whatsapp": {
"registered": true,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"telegram": {
"registered": true,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"viber": {
"registered": true,
"photo": "string",
"lastSeen": "string",
"name": "string",
"about": "string"
},
"kakao": {
"registered": true
},
"ok": {
"registered": true
},
"zalo": {
"registered": true
},
"line": {
"url": "string",
"name": "string",
"photo": "string",
"registered": true
}
},
"id": "string",
"history": {
"hits": 0,
"customerHits": 0,
"firstSeen": 0,
"lastSeen": 0
},
"flags": [
{
"note": "string",
"date": 0,
"industry": "string"
}
]
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Indicates if the request was successful (true/false). |
error | Object or Null | Details of the error, or null if there is no error. |
data | Object | Contains detailed information about the result. |
id | string | Result ID. |
state | string | Result state. |
fraudScore | number | A score from 0 to 100 indicating the likelihood probability that a transaction is fraudulent. |
binDetails | object | Details about the BIN (Bank Identification Number). |
version | string | Version information. |
appliedRules | array of objects | List of applied rules with their details. |
appliedRule | object | applied rule object |
id | string | ID of the applied rule. |
name | string | Name of the applied rule. |
operation | string | Operation associated with the rule (+ for positive, - for negative). |
score | number | Score associated with the rule. |
deviceDetails | object | Details about the device. |
calculationTime | number | Calculation time (in milliseconds). |
seonId | number | SEON ID associated with the result. |
ipDetails | object | Details about the IP address. |
ip | string | IP address. |
score | number | A score from 0 to 100 indicates the probability that the IP is fraudulent. |
country | string | Country of the IP. |
stateProv | string | State or Province of the IP. |
city | string | City of the IP. |
timezoneOffset | string | Timezone offset of the IP. |
ispName | string | Name of the ISP associated with the IP. |
latitude | number | Latitude coordinate of the IP. |
longitude | number | Longitude coordinate of the IP. |
type | string | Type of the IP. |
openPorts | array[number] | List of open ports associated with the IP. |
tor | boolean | Indicates if the IP is associated with Tor network. |
harmful | boolean | Indicates if the IP is flagged as harmful. |
vpn | boolean | Indicates if the IP is associated with a VPN. |
webProxy | boolean | Indicates if the IP is a web proxy. |
publicProxy | boolean | Indicates if the IP is a public proxy. |
spamNumber | number | Number of spam incidents associated with the IP. |
spamUrls | array[string] | List of URLs flagged as spam associated with the IP. |
id | string | ID associated with the IP details. |
history | object | history Contains historical data about the IP. |
flags | array [flags] | List of flags associated with the IP. |
emailDetails | object | Details about the email. |
string | Email address. | |
score | number | A score from 0 to 100 indicates the probability that the email address is fraudulent |
deliverable | boolean | Indicates if the email is deliverable. |
domainDetails | object | Contains details about the email domain. |
domain | string | Email domain. |
tld | string | Top-level domain. |
created | string | Date the domain was created. |
updated | string | Date the domain was last updated. |
expires | string | Date the domain expires. |
registered | boolean | Indicates if the domain is registered. |
registrarName | string | Name of the domain registrar. |
registeredTo | boolean | Indicates if the domain is registered to someone. |
disposable | boolean | Indicates if the domain is disposable. |
free | boolean | Indicates if the domain is free. |
custom | boolean | Indicates if the domain is custom. |
dmarcEnforced | boolean | Indicates if DMARC enforcement is in place. |
spfStrict | boolean | Indicates if SPF policy is strict. |
validMx | boolean | Indicates if the MX records are valid. |
acceptAll | boolean | Indicates if the domain accepts all emails. |
suspiciousTld | boolean | Indicates if the TLD is suspicious. |
websiteExists | boolean | Indicates if a website associated with the domain exists. |
accountDetails | object | Contains details about various accounts associated with the email. |
apple | Object | AccountDetail object |
ebay | Object | AccountDetail object |
Object | AccountDetail object | |
url | string | URL associated with the Facebook account. |
name | string | Name associated with the Facebook account. |
photo | string | URL of the photo associated with the Facebook account. |
registered | Boolean | Indicates if the account is registered (true/false). |
flirck | Object | AccountDetail object |
yahoo | Object | AccountDetail object |
microsoft | Object | AccountDetail object |
foursquare | Object | AccountDetail object |
github | Object | AccountDetail object |
Object | AccountDetail object | |
registered | Boolean | Indicates if the account is registered. |
photo | string | URL of the photo associated with the Google account. |
gravatar | Object | AccountDetail object |
Object | AccountDetail object | |
lastfm | Object | AccountDetail object |
Object | AccountDetail object | |
url | string | URL associated with the LinkedIn account. |
name | string | Name associated with the LinkedIn account. |
company | string | Company associated with the LinkedIn account. |
title | string | Job title associated with the LinkedIn account. |
location | string | Location associated with the LinkedIn account. |
website | string | Website associated with the LinkedIn account. |
string | Twitter handle associated with the LinkedIn account. | |
photo | string | URL of the photo associated with the LinkedIn account. |
registered | Boolean | Indicates if the account is registered (true/false). |
microsoft | Object | AccountDetail object |
myspace | Object | AccountDetail object |
Object | AccountDetail object | |
skype | Object | AccountDetail object |
country | string | Country associated with the Skype account. |
city | string | City associated with the Skype account. |
gender | string or null | Gender associated with the Skype account. |
name | string | Name associated with the Skype account. |
id | string | ID associated with the Skype account. |
handle | string | Handle associated with the Skype account. |
bio | string | Biography associated with the Skype account. |
age | string or 55 | Age associated with the Skype account. |
language | string | Language associated with the Skype account. |
state | string | State associated with the Skype account. |
photo | string | URL of the photo associated with the Skype account. |
registered | Boolean | Indicates if the account is registered. |
spotify | Object | AccountDetail object |
tumblr | Object | AccountDetail object |
Object | AccountDetail object | |
vimeo | Object | AccountDetail object |
Object | AccountDetail object | |
yahoo | Object | AccountDetail object |
discord | Object | AccountDetail object |
ok | Object | AccountDetail object |
registered | Boolean | Indicates if the account is registered. |
city | string | City associated with the OK account. |
age | string | Age associated with the OK account. |
dateJoined | string | Date the account joined. |
kakao | Object | AccountDetail object |
booking | Object | AccountDetail object |
airbnb | Object | AccountDetail object |
registered | boolean | Indicates if the Airbnb account is registered (true/false). |
about | string | Information about the user's Airbnb profile. |
createdAt | string | Date when the Airbnb account was created. |
firstName | string | First name of the user associated with the Airbnb account. |
identityVerified | boolean | Indicates if the user's identity is verified (true/false). |
location | string | Location associated with the Airbnb account (or null if not specified). |
image | string | URL of the image associated with the Airbnb account. |
revieweeCount | number | Number of reviews received by the user. |
trips | number | Number of trips taken by the user. |
work | string | Information about the user's work (if provided). |
amazon | Object | AccountDetail object |
qzone | Object | AccountDetail object |
breachDetails | Object | Contains details about any breaches associated with the email |
brequaches | array[breach] | An array of breached websites, each containing: |
breach | Object | Object of brequaches |
name | string | Name of the breached website. |
domain | string | Domain associated with the breached website. |
date | string | Date of the breach. |
haveibeenpwnedListed | boolean | Indicates if the email is listed on Have I Been Pwned (true/false). |
numberOfBreaches | number | Total number of breaches associated with the email address. |
firstBreach | string | Date of the first recorded breach for the email address. |
id | string | Unique identifier for the email. |
history | object | Contains historical data about the email. |
flags | array | Contains flags associated with the email. |
phoneDetails | object | Details about the phone number. |
number | number | Phone number as a number. |
valid | boolean | Indicates if the phone number is valid (true/false). |
disposable | boolean | Indicates if the phone number is disposable (true/false). |
type | string | Type of the phone number. |
country | string | Country associated with the phone number. |
carrier | string | Carrier information for the phone number. |
score | number | A score from 0 to 100 indicates the probability that the phone number is fraudulent. |
accountDetails | object | Contains details about various accounts associated with the email. |
Object | AccountDetail object | |
Object | AccountDetail object | |
Object | AccountDetail object | |
Object | AccountDetail object | |
yahoo | Object | AccountDetail object |
microsoft | Object | AccountDetail object |
snapchat | Object | AccountDetail object |
skype | Object | AccountDetail object |
country | string | Country associated with the Skype account. |
city | string | City associated with the Skype account. |
gender | string or null | Gender associated with the Skype account. |
name | string | Name associated with the Skype account. |
id | string | ID associated with the Skype account. |
handle | string | Handle associated with the Skype account. |
bio | string | Biography associated with the Skype account. |
age | string or 55 | Age associated with the Skype account. |
language | string | Language associated with the Skype account. |
state | string | State associated with the Skype account. |
photo | string | URL of the photo associated with the Skype account. |
registered | Boolean | Indicates if the account is registered. |
Object | IM object | |
telegram | Object | IM object |
viber | Object | IM object |
kakao | Object | AccountDetail object |
ok | Object | AccountDetail object |
zalo | Object | AccountDetail object |
line | Object | IM object |
id | string | Identifier for the phone details. |
history | object | Contains historical information about the phone number. |
flags | array [flag] | Contains flags associated with the phone number. |
flag | objec | flag object |
note | string | observations |
date | string or number | date of the flag |
industry | string | industry of the flag |
204 NotFound
When the information was not found in the source of verification. The legal entity name may not be correct.
{}
400, 500, 501 Bad Request, Internal server Error & Error not Implemented
When the parameters do not have the correct format, internal error in our server or an uncontrolled error occurs.
{
"success": false,
"data": null,
"error": {
"request": "string",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 400
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
401, 504 Unauthorized & Timeout
When no authentication or Timeouts errors occur.
{
"success": false,
"data": null,
"error": {
"request": "string or null",
"apiException": "string or null",
"errorMessage": {
"code": "string",
"message": "string",
"statusCode": 401
}
}
}
Table whit the properties in the response json
Name | Type | Description |
---|---|---|
success | Boolean | Boolean value indicating the success status. |
data | Any or Null | Data, which can be of any type or null. |
error | Object | Object containing error details. |
request | String | A string representing the request. |
apiException | String or Null | An exception message or null. |
errorMessage | Object | |
code | String | Error code. |
message | String | Error message. |
statusCode | Number | HTTP status code. |
Service messages
Message Code | Message | Description |
---|---|---|
Success | Endpoint Response | This is the successful response of the endpont, it is not an error so it will return the expected result, in this case a json with the query information. |
ISS001 | Internal Server Error | An internal server error has occurred |
ISS002 | Authentication Error | The API key is missing or invalid. |
ISS003 | Data is not available | Data is not available yet, please try again later |
ISS004 | Error with Data | The data is corrupted. |
ISS005 | Bad Request | Invalid input parameter. |
ISS006 | Authentication Error | API key not found. |
ISS007 | TimeOut Error | TimeOut Server connection error |
ISS008 | Response Info Error | Information could not be obtained |
ISS009 | Bad Request | Invalid input parameter |
ISS010 | No Content | This user's information is restricted. |
ISS011 | TimeOut Error | TimeOut Server connection error |