Entity API Introductory Guide and Response Fields
The Entity endpoints allow you to retrieve structured records relating to four tokenized values identified in our data collection—emails, IP addresses, cryptocurrency, or credit cards.
- There are four (4) Entity endpoints that allow you to look up and return records related to an individual or singular credit card number, cryptocurrency address, email address, or IP address.
- There are two (2) Entity endpoints that allow you to look up and return records related to a set of email addresses (belonging to one email domain) or a set of credit cards (belonging to one bank identification number (BIN)).
Supported Entity Inputs
Entity |
Inputs |
|
Cryptocurrency Address |
Bitcoin, Dash, Ethereum, Litecoin, Monero, ZCash |
|
IP Address |
IPv4 addresses, IPv6 addresses |
|
Bank Identification Number |
6- or 8-digit Bank Information Numbers |
Entity Request Options
Entity types have several common request options, including sort and date range (from/to) options. Certain Entity types may also have unique request parameters, as shown below.
Entity |
Unique Request Parameter |
Description |
|
Email Domain |
leak |
Use this parameter to only return content from one specific data leak. |
Entity Response Fields
All Entity types have common response options, including id, crawlDate, location, fragment, and network. Certain Entity types may also return unique options, as shown in the table below. If these fields are not returned, it means that field was not detected with the Entity.
Entity |
Unique Response |
Description |
|
Email Address |
password |
An associated password that Vision detected with the email address. |
|
Email Address |
type |
The type of password that Vision detected with the email address (plain, hashed). |
|
Email Domain |
password |
An associated password that Vision detected with the email address. |
|
Email Domain |
type |
The type of password that Vision detected with the email address (plain, hashed). |
|
Email Domain |
leak |
The name of the data leak in which the result was found (if from data leak). |
|
Credit Card Number |
cvv |
An associated cvv that Vision detected with the credit card number. |
|
Credit Card Number |
expDate |
An associated expiration date that Vision detected with the credit card number. |
|
Bank Identification Number |
cvv |
An associated cvv that Vision detected with the credit card number. |
|
Bank Identification Number |
expDate |
An associated expiration date that Vision detected with the credit card number. |