openapi: 3.0.0
info:
title: EmailSearch
description: >
This Email Search API allows businesses to append known email addresses that are associated with a submitted individual’s name and physical address. The email check API helps to identify any relevant email addresses linked to the individual, streamlining the process of contact verification and enhancing data accuracy.
With the email search API, users can easily access additional contact information that may be tied to the individual, supporting efforts in data enrichment, fraud prevention, marketing, and customer outreach. This tool ensures that businesses have the most accurate and comprehensive contact details available, helping to improve operational efficiency and decision-making.
version: 1.1.0.0
paths:
/:
post:
summary: ''
description: Get report associated with email
operationId: /
requestBody:
x-name: request
content:
application/json:
schema:
$ref: '#/components/schemas/EmailSearchRq_Type'
examples:
INVALID:
value: >-
{
"Name": {
"FirstName": "Kendra",
"MiddleName": "",
"LastName": "Williams"
},
"Address": {
"Addr1": "",
"Addr2": "",
"StreetNum": "404",
"StreetName": "CREEKSIDE CIR",
"Apt": "",
"City": "AUSTELL",
"State": "GA",
"Zip": "30168",
"County": "",
"Country": ""
},
"SSN": "57149756"
}
VALID1:
value: >-
{
"Name": {
"FirstName": "Kendra",
"MiddleName": "",
"LastName": "Williams"
},
"Address": {
"Addr1": "",
"Addr2": "",
"StreetName": "CREEKSIDE CIR",
"StreetNum": "404",
"Apt": "",
"City": "AUSTELL",
"State": "GA",
"Zip": "30168",
"County": "",
"Country": ""
},
"SSN": "571490756"
}
application/xml:
schema:
$ref: '#/components/schemas/EmailSearchRq_Type'
examples:
INVALID:
value: >-
Kendra
Williams
404
CREEKSIDE CIR
AUSTELL
GA
30168
57149076
VALID1:
value: >-
SHARON
SWANSON
377
N MINNESOTA AVE
30168
571490756
required: true
x-position: 1
responses:
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EmailSearchRs_Type'
application/xml:
schema:
$ref: '#/components/schemas/EmailSearchRs_Type'
security:
- oauth: []
components:
schemas:
EmailSearchRs_Type:
type: object
properties:
MsgRsHdr:
$ref: '#/components/schemas/MsgRsHdr_Type'
EmailInfo:
type: array
deprecated: true
x-deprecatedMessage: Use Subject.EmailInfo
items:
$ref: '#/components/schemas/EmailInfo_Type'
Subject:
type: array
items:
$ref: '#/components/schemas/MBEmailSearchRs_TypeSubject'
EmailStatus:
type: string
EmailRiskLevel:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
MsgRsHdr_Type:
type: object
properties:
RqUID:
type: string
Status:
$ref: '#/components/schemas/Status_Type'
Status_Type:
type: object
properties:
StatusCode:
type: integer
format: int64
ServerStatusCode:
type: string
Severity:
$ref: '#/components/schemas/Severity_Type'
StatusDesc:
type: string
AdditionalStatus:
type: array
items:
$ref: '#/components/schemas/AdditionalStatus_Type'
Severity_Type:
type: string
description: ''
x-enumNames:
- Error
- Warn
- Info
enum:
- Error
- Warn
- Info
AdditionalStatus_Type:
type: object
properties:
StatusCode:
type: integer
format: int64
StatusCodeSpecified:
type: boolean
ServerStatusCode:
type: string
Severity:
$ref: '#/components/schemas/Severity_Type'
StatusDesc:
type: string
EmailInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
EmailAddr:
type: string
IPAddress:
type: string
ReportedDt:
type: string
format: date-time
ReportedDtSpecified:
type: boolean
ValidationCd:
type: string
MatchCode:
$ref: '#/components/schemas/CodeDescription_Type'
CodeDescription_Type:
type: object
properties:
Code:
type: string
Description:
type: string
MBEmailSearchRs_TypeSubject:
type: object
properties:
PersonInfo:
$ref: '#/components/schemas/PersonInfo_Type'
EmailInfo:
type: array
items:
$ref: '#/components/schemas/EmailInfo_Type'
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
PersonInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
PersonName:
$ref: '#/components/schemas/PersonName_Type'
ContactInfo:
type: array
items:
$ref: '#/components/schemas/ContactInfo_Type'
TINInfo:
$ref: '#/components/schemas/TINInfo_Type'
BirthDt:
type: string
format: date-time
BirthDtSpecified:
type: boolean
BirthState:
type: string
BirthCountry:
type: string
DeathDt:
type: string
format: date-time
DeathDtSpecified:
type: boolean
DriversLicense:
$ref: '#/components/schemas/DriversLicense_Type'
MothersMaidenName:
type: string
SpouseInfo:
$ref: '#/components/schemas/SpouseInfo_Type'
EmploymentHistory:
type: array
items:
$ref: '#/components/schemas/EmploymentHistory_Type'
SchoolInfo:
type: array
items:
$ref: '#/components/schemas/SchoolInfo_Type'
PhysicalCharacteristics:
$ref: '#/components/schemas/PhysicalCharacteristics_Type'
Citizenship:
type: string
LanguageSpoken:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
Quality:
type: string
BirthCity:
type: string
Nationality:
type: string
Affiliation:
type: string
ValidationInfo:
$ref: '#/components/schemas/ValidationInfo_Type'
RecordID:
type: string
MilitaryIdInfo:
$ref: '#/components/schemas/MilitaryIdInfo_Type'
PassportInfo:
$ref: '#/components/schemas/PassportInfo_Type'
ChildrenInfo:
$ref: '#/components/schemas/ChildrenInfo_Type'
HometownArea:
type: string
RelationshipStatus:
type: string
Orientation:
type: string
AKAInfo:
type: array
items:
$ref: '#/components/schemas/AKAInfo_Type'
Zodiac:
type: string
BirthYear:
type: string
OwnershipPercentage:
type: number
format: decimal
OwnershipPercentageSpecified:
type: boolean
PersonName_Type:
type: object
properties:
FirstName:
type: string
FullName:
type: string
LastName:
type: string
MiddleName:
type: string
TitlePrefix:
type: string
NameSuffix:
type: string
Nickname:
type: string
LegalName:
type: string
MaidenName:
type: string
OfficialTitle:
type: string
Initials:
type: string
FirstSeenDt:
type: string
format: date-time
DtLastSeen:
type: string
format: date-time
ContactInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
ContactPref:
type: string
PhoneNum:
$ref: '#/components/schemas/PhoneNum_Type'
ContactName:
type: string
EmailAddr:
type: string
URL:
type: string
PostAddr:
$ref: '#/components/schemas/PostAddr_Type'
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
ContactType:
type: string
ValidationInfo:
$ref: '#/components/schemas/ValidationInfo_Type'
InstantMessagingInfo:
type: array
items:
$ref: '#/components/schemas/InstantMessagingInfo_Type'
PhoneNum_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
PhoneType:
type: string
Phone:
type: string
Published:
$ref: '#/components/schemas/Boolean'
PublishedSpecified:
type: boolean
Boolean:
type: string
description: ''
x-enumNames:
- Item0
- Item1
enum:
- Item0
- Item1
PostAddr_Type:
type: object
properties:
Addr1:
type: string
Addr2:
type: string
Addr3:
type: string
Addr4:
type: string
Apt:
type: string
PostDirection:
type: string
PreDirection:
type: string
StreetName:
type: string
StreetNum:
type: string
StreetType:
type: string
UnitType:
type: string
City:
type: string
StateProv:
type: string
PostalCode:
type: string
County:
type: string
Country:
type: string
AddrType:
type: string
StartDt:
type: string
format: date-time
EndDt:
type: string
format: date-time
OwnershipCode:
type: string
ReportedDt:
type: string
format: date-time
AddrSource:
type: string
GEOCode:
$ref: '#/components/schemas/GEOCode_Type'
AddrCreatedDt:
type: string
format: date-time
LengthOfResidence:
type: string
DropPointInd:
type: string
DwellingUnitSize:
type: string
Urbanization:
type: string
Building:
type: string
GEOCode_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
MSACode4:
type: string
MSACode5:
type: string
StateCode:
type: string
CountyCode:
type: string
CensusTrackCode:
type: string
BlockCode:
type: string
Latitude:
type: number
format: decimal
LatitudeSpecified:
type: boolean
Longitude:
type: number
format: decimal
LongitudeSpecified:
type: boolean
GEOCreatedDt:
type: string
format: date-time
GEOCreatedDtSpecified:
type: boolean
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
Full_Longitude:
type: string
Full_Latitude:
type: string
Message_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
MsgClass:
type: string
MsgCode:
type: string
Text:
type: string
ValidationInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
NameValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
SSNValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
DOBValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
DLValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
DeceasedValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
AddressValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
PhoneValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
OtherValidation:
type: array
items:
$ref: '#/components/schemas/Message_Type'
InstantMessagingInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
IMNetwork:
type: string
IMType:
type: string
UserName:
type: string
TINInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
TINType:
type: string
TaxId:
type: string
CertCode:
type: string
IssuedDt:
type: string
format: date-time
IssuedDtSpecified:
type: boolean
IssuedState:
type: string
DateRange:
$ref: '#/components/schemas/DateRange_Type'
Country:
type: string
OtherTaxId:
type: array
items:
$ref: '#/components/schemas/OtherTaxId_Type'
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
DateRange_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
StartDt:
type: string
format: date-time
EndDt:
type: string
format: date-time
OtherTaxId_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
TINType:
type: string
AltTaxId:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
DriversLicense_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
LicenseNum:
type: string
StateProv:
type: string
Country:
type: string
DriverOption:
$ref: '#/components/schemas/CodeDescription_Type'
DLClass:
type: string
DLType:
type: string
DLStatus:
type: string
CDLStatus:
type: string
Endorsements:
type: array
items:
$ref: '#/components/schemas/Option_Type'
Restrictions:
$ref: '#/components/schemas/Option_Type'
IssuedDt:
type: string
format: date-time
IssuedDtSpecified:
type: boolean
ExpirationDt:
type: string
format: date-time
ExpirationDtSpecified:
type: boolean
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
Option_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
OptionName:
type: string
OptionValue:
$ref: '#/components/schemas/Boolean'
SpouseInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
PersonName:
$ref: '#/components/schemas/PersonName_Type'
ContactInfo:
type: array
items:
$ref: '#/components/schemas/ContactInfo_Type'
TINInfo:
$ref: '#/components/schemas/TINInfo_Type'
BirthDt:
type: string
format: date-time
BirthDtSpecified:
type: boolean
DeathDt:
type: string
format: date-time
DeathDtSpecified:
type: boolean
DriversLicense:
$ref: '#/components/schemas/DriversLicense_Type'
MothersMaidenName:
type: string
EmploymentHistory:
type: array
items:
$ref: '#/components/schemas/EmploymentHistory_Type'
EmploymentHistory_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
EmploymentStatus:
type: string
OrgInfo:
$ref: '#/components/schemas/OrgInfo_Type'
Occupation:
type: string
Income:
$ref: '#/components/schemas/CurrencyAmount'
PmtFreq:
type: string
JobTitle:
type: string
StartDt:
type: string
format: date-time
StartDtSpecified:
type: boolean
EndDt:
type: string
format: date-time
EndDtSpecified:
type: boolean
VerifiedDt:
type: string
format: date-time
VerifiedDtSpecified:
type: boolean
VerificationCode:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
SourceType:
type: string
DisconnectInd:
type: string
FirstRptdDt:
type: string
format: date-time
FirstRptdDtSpecified:
type: boolean
LastRptdDt:
type: string
format: date-time
LastRptdDtSpecified:
type: boolean
LengthOfEmployment:
type: string
OrgInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
IndustId:
$ref: '#/components/schemas/IndustId_Type'
Name:
type: string
LegalName:
type: string
ContactInfo:
type: array
items:
$ref: '#/components/schemas/ContactInfo_Type'
DeptDivGrp:
type: string
TINInfo:
$ref: '#/components/schemas/TINInfo_Type'
EstablishDt:
type: string
format: date-time
EstablishDtSpecified:
type: boolean
NumEmployees:
type: integer
format: int64
NumEmployeesSpecified:
type: boolean
OrgId:
$ref: '#/components/schemas/OrgId_Type'
CorpType:
$ref: '#/components/schemas/CodeDescription_Type'
CorpStatus:
type: string
CorpStatusDt:
type: string
format: date-time
CorpStatusDtSpecified:
type: boolean
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
IncorporationDt:
type: string
format: date-time
IncorporationDtSpecified:
type: boolean
CharterInfo:
$ref: '#/components/schemas/CharterInfo_Type'
AgentInfo:
$ref: '#/components/schemas/PersonInfo_Type'
MergedName:
type: string
DBAName:
type: string
PriorName:
type: string
OrigDtFiled:
type: string
format: date-time
OrigDtFiledSpecified:
type: boolean
RecentFilingDt:
type: string
format: date-time
RecentFilingDtSpecified:
type: boolean
BusType:
type: string
ActiveStatusInd:
$ref: '#/components/schemas/Boolean'
ActiveStatusIndSpecified:
type: boolean
BusStatusDesc:
type: string
ForProfitInd:
$ref: '#/components/schemas/Boolean'
ForProfitIndSpecified:
type: boolean
OwnerRegistrantInfo:
$ref: '#/components/schemas/PersonInfo_Type'
OrgType:
type: string
RecordID:
type: string
PRInd:
$ref: '#/components/schemas/Boolean'
PRIndSpecified:
type: boolean
FileNumber:
type: string
BIN:
type: string
IncorporationState:
type: string
SignificantPRInd:
$ref: '#/components/schemas/Boolean'
SignificantPRIndSpecified:
type: boolean
BusLicense:
type: string
RegistrationDetails:
$ref: '#/components/schemas/RegistrationDetails_Type'
IndustId_Type:
type: object
properties:
Org:
type: string
IndustNum:
type: string
IndustType:
$ref: '#/components/schemas/CodeDescription_Type'
OrgId_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
KOB:
type: string
Description:
type: string
SubscriberNum:
type: string
BurMarket:
type: string
BurSubMarket:
type: string
CorpID:
type: string
CharterInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
CharterNum:
type: string
CharterTermYears:
type: integer
format: int64
CharterTermYearsSpecified:
type: boolean
CharterTermDt:
type: string
format: date-time
CharterTermDtSpecified:
type: boolean
RegistrationDetails_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
RegType:
type: string
RegDt:
type: string
format: date-time
RegDtSpecified:
type: boolean
DtType:
type: string
PostAddr:
$ref: '#/components/schemas/PostAddr_Type'
RegStatusCode:
$ref: '#/components/schemas/CodeDescription_Type'
RegistrationNum:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
CurrencyAmount:
type: object
properties:
Amt:
type: number
format: decimal
CurCode:
type: string
SchoolInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
OrgInfo:
$ref: '#/components/schemas/OrgInfo_Type'
StartDt:
type: string
format: date-time
StartDtSpecified:
type: boolean
EndDt:
type: string
format: date-time
EndDtSpecified:
type: boolean
GraduationDt:
type: string
format: date-time
GraduationDtSpecified:
type: boolean
Diploma:
type: string
DegreeMajor:
type: string
DegreeMinor:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
PhysicalCharacteristics_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
Age:
type: string
Race:
type: string
Ethnicity:
type: string
Gender:
type: string
HairColor:
type: string
EyeColor:
type: string
Height:
type: string
Weight:
type: string
SkinTone:
type: string
BuildType:
type: string
IdentifyingMarks:
type: string
ShoeSize:
type: string
CorrectiveLenses:
$ref: '#/components/schemas/Boolean'
CorrectiveLensesSpecified:
type: boolean
MilitaryIdInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
MilitaryIdNum:
type: string
IssuedDt:
type: string
format: date-time
IssuedDtSpecified:
type: boolean
ExpirationDt:
type: string
format: date-time
ExpirationDtSpecified:
type: boolean
MilitaryBranch:
type: string
MilitaryStatus:
type: string
PassportInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
Country:
type: string
PassportNum:
type: string
IssuedDt:
type: string
format: date-time
IssuedDtSpecified:
type: boolean
ExpirationDt:
type: string
format: date-time
ExpirationDtSpecified:
type: boolean
ChildrenInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
NumOfChildren:
type: integer
format: int64
NumOfChildrenSpecified:
type: boolean
PersonInfo:
type: array
items:
$ref: '#/components/schemas/PersonInfo_Type'
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
AKAInfo_Type:
type: object
properties:
EffDtSpecified:
type: boolean
Source:
type: string
EffDt:
type: string
format: date-time
PersonName:
$ref: '#/components/schemas/PersonName_Type'
RecordID:
type: string
Message:
type: array
items:
$ref: '#/components/schemas/Message_Type'
EmailSearchRq_Type:
type: object
properties:
MsgRqHdr:
$ref: '#/components/schemas/MsgRqHdr_Type'
Name:
deprecated: true
x-deprecatedMessage: Use PersonInfo.PersonName
oneOf:
- $ref: '#/components/schemas/Name'
Address:
deprecated: true
x-deprecatedMessage: Use PersonInfo.ContactInfo.PostAddr
oneOf:
- $ref: '#/components/schemas/Address'
SSN:
type: string
deprecated: true
x-deprecatedMessage: Use PersonInfo.TINInfo
PhoneNumber:
type: string
deprecated: true
x-deprecatedMessage: Use PersonInfo.ContactInfo.PhoneNum
PersonInfo:
$ref: '#/components/schemas/PersonInfo_Type'
MsgRqHdr_Type:
type: object
properties:
MemberId:
type: string
MemberPwd:
type: string
RequestType:
$ref: '#/components/schemas/MsgRqHdr_TypeRequestType'
RequestTypeSpecified:
type: boolean
ReasonCode:
type: string
GLBPurpose:
type: string
DLPurpose:
type: string
RefNum:
type: string
UserName:
type: string
Timeout:
type: integer
format: int64
TimeoutSpecified:
type: boolean
FrozenFilePIN:
type: string
OutputFormat:
type: string
ProductID:
type: string
MsgRqHdr_TypeRequestType:
type: string
description: ''
x-enumNames:
- I
- J
- N
- A
- W
- S
- P
- B
- R
enum:
- I
- J
- N
- A
- W
- S
- P
- B
- R
Name:
type: object
properties:
FirstName:
type: string
MiddleName:
type: string
LastName:
type: string
Address:
type: object
properties:
Addr1:
type: string
Addr2:
type: string
StreetPreDir:
type: string
StreetName:
type: string
StreetNum:
type: string
StreetType:
type: string
StreetSufix:
type: string
StreetPostDir:
type: string
Apt:
type: string
City:
type: string
State:
type: string
Zip:
type: string
County:
type: string
Country:
type: string
securitySchemes:
oauth:
type: oauth2
flows:
clientCredentials:
scopes: {}
tokenUrl: https://apitest.microbilt.com/OAuth/Token
servers:
- url: https://api.microbilt.com/EmailSearch
description: Production url
- url: https://apitest.microbilt.com/EmailSearch
description: Sandbox url
x-name: EmailSearch