--- title: "Verify an identity" method: GET path: "/doContactVerify" tags: ["Identity Verification"] --- # Verify an identity `GET /doContactVerify` Send GET request to verify an identity. ## Query parameters - `act` 'check' | 'screen' | 'verify' - `id` string, required - `t` string - `addrOpt` string - `emailOpt` string - `nameOpt` string - `opt` string - `phoneOpt` string - `privacy` string - `accountNumber` string - `a1` string, required - `a2` string - `a3` string - `a4` string - `a5` string - `a6` string - `a7` string - `a8` string - `admarea` string, required - `comp` string - `ctry` string, required - `ctryorg` string - `dob` string - `email` string - `first` string - `full` string, required - `last` string - `loc` string, required - `nat` string - `phone` string - `postal` string, required ## Headers - `Accept` 'application/json' | '*/*', required - `Content-Type` 'application/json', required ## Response `200` Successful response - ContactVerifyResponse - `Results` string — Lists error codes from any errors caused by the most recent request as a whole. - `TransactionID` string — A unique string identifier for this record. A unique transaction ID is generated for every record handled by Personator Identity. - `TransmissionReference` string — Serves as a unique request identifier. - `Version` string — The current service version number. - `Address` object - `AddressLine1` string — These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code. - `AddressLine2` string — Standardized or corrected contents of the input address line 2. - `AddressLine3` string — Standardized or corrected contents of the input address line 3. - `AddressLine4` string — Standardized or corrected contents of the input address line 4. - `AddressLine5` string — Standardized or corrected contents of the input address line 5. - `AddressLine6` string — Standardized or corrected contents of the input address line 6. - `AddressLine7` string — Standardized or corrected contents of the input address line 7. - `AddressLine8` string — Standardized or corrected contents of the input address line 8. - `AdministrativeArea` string — State, Province. The standardized contents of the AdministrativeArea element. This is a common geographic area unit for larger countries. - `DependentLocality` string — Urbanization. The standardized contents of the DependentLocality element. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico. - `DoubleDependentLocality` string — The standardized contents of the DoubleDependentLocality element. A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality. - `FormattedAddress` string — The address in the correct format for mailing from the country specified in the CountryOfOrigin element. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). - `Locality` string — City. The standardized contents of the Locality element. This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, or Postal Town. - `Organization` string — Business, Company. String value that matches the Organization request element. It is not modified or populated by the service. - `PostalCode` string — ZIP Code. The standardized contents of the PostalCode element. Most countries have some form of a postal code system. - `Results` string — Comma delimited status, error codes, and change codes for the record. For a list of these codes, see the [Result Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html) list. Separate lines will be delimited by what is specified in the [LineSeparator](https://docs.melissa.com/cloud-api/personator-identity/personator-identity-reference-guide.html#personatoridentity-referenceguide-addressoptions-lineseparator) option. - `SubAdministrativeArea` string — County. The standardized contents of the SubAdministrativeArea element. This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address. - `SubPremises` string — Suite, Apartment. The parsed SubPremises from the AddressLine elements. A subpremise are individual units with their own addresses inside a building. - `AddressKey` string — This is a country dependent field: - US: This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address (link to something about non-usps addresses). - GB: This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is an 8 character code that is assigned and maintained by Royal Mail to each delivery point address. - AU: This returns the DPID (Delivery Point ID). This is a 8 digit number that identifies a mailbox according to Australia Post. The AddressKey can be used by other Melissa services, such as Geocoder or RBDI. - `AddressType` string — A one-character code for the type of address coded. See the [Product Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-referenceguide-resultcodes-productcodes) for a list of Address Type Codes. - `Building` string — The parsed descriptive name identifying an individual location. - `CountryCode` string — The 2 letter ISO 3166 country code value. For example: US for United States or CA for Canada. - `CountryISO3` string — The 3 letter ISO 3166 country code value. For example: USA for United States or CAN for Canada. - `CountryName` string — The standardized contents of the CountryName element. - `CountryNumber` string — The ISO 3166 country number value. For example: 840 for United States or 124 for Canada. - `CountrySubdivisionCode` string — The ISO3166-2 code for country subdivisions, usually tied to the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. For example: US-CA, CN-16, or AU-VIC. This field is only populated for the following countries: AE, AR, AT, AU, BB, BE, BH, BR,BS, CA, CH, CL, CN, CO, CR, DE, DK, DM, DO, ES, FI, FJ, FR, GB, GH, GT, GY, HN, ID, IE, IL, IN, IS, IT, JP, KR, KW, LT, LU, LV, MX, MY, NC, NG, NI, NL, NO, NZ, PE, PH, PK, PL, PR, PT, RS, SA, SG, SI, SV, TH, TR, UA, US, UY, VN. - `DependentThoroughfare` string — Dependent Street. The parsed block data element. The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used. - `DependentThoroughfareLeadingType` string — The parsed leading thoroughfare type indicator within the DependentThoroughfare field. - `DependentThoroughfareName` string — The parsed name indicator within the DependentThoroughfare field. - `DependentThoroughfarePostDirection` string — The parsed postfix directional indicator within the DependentThoroughfare field. - `DependentThoroughfarePreDirection` string — The parsed prefix directional within the DependentThoroughfare field. - `DependentThoroughfareTrailingType` string — The parsed trailing thoroughfare type indicator within the DependentThoroughfare field. - `Latitude` string — The parsed geographic coordinate for a particular delivery point. - `Longitude` string — The parsed geographic coordinate for a particular delivery point. - `PostBox` string — The parsed post box information for a particular delivery point. - `PremisesNumber` string — House Number. The parsed alphanumeric indicator within the premises field. - `PremisesType` string — The parsed leading premise type indicator within the premises field. - `SubNationalArea` string — The standardized arbitrary administrative region below that of the sovereign state. A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used. - `SubPremisesNumber` string — Suite Number. The parsed sub premises number indicator within the premises field. - `SubPremisesType` string — Suite Name. The parsed sub premises type indicator within the premises field. - `Thoroughfare` string — Street. The most common street or block data element. This value is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc. - `ThoroughfareLeadingType` string — The parsed leading thoroughfare type indicator within the Thoroughfare field. A leading type is a thoroughfare type that is placed before the thoroughfare. For example, the thoroughfare type of Rue in Canada and France is placed before the thoroughfare, making it a leading type. - `ThoroughfareName` string — Street Name. The parsed name indicator within the Thoroughfare field. - `ThoroughfarePostDirection` string — Post Direction. The parsed postfix directional within the Thoroughfare field. - `ThoroughfarePreDirection` string — Street PreDirection. The parsed prefix directional within the Thoroughfare field. - `ThoroughfareTrailingType` string — Street Suffix. The parsed trailing thoroughfare type indicator within the Thoroughfare field. A trailing type is a thoroughfare type that is placed after the thoroughfare. For example, the thoroughfare type of Avenue in the US is placed after the thoroughfare, making it a trailing type. - `Email` object - `BreachCount` string — The known number of breaches that this email account has been involved in. - `DateChecked` string — The date the email was validated. It returns UTC, Unix Time (Epoch Time) in the MM/DD/YYYY H:MM:SS format. - `DeliverabilityConfidenceScore` string — The probability [0-100]% of an email sent to this mailbox will be successfully delivered. - `DomainAddress1` string — The address of the DomainOrganization. - `DomainAdministrativeArea` string — The state of the DomainOrganization. - `DomainAgeEstimated` string — The estimated age of the domain in days. - `DomainAvailability` string — Check to see if domain is available for purchase. - `DomainCountry` string — The country of the DomainOrganization. - `DomainCountryCode` string — The country code of the DomainCountry. - `DomainCreatedDate` string — The date the domain was created in the YYYY-MM-DDTHH:MM:SS format. - `DomainEmail` string — The email associated with the domain owner. - `DomainExpirationDate` string — The date the domain expires/expired in the YYYY-MM-DDTHH:MM:SS format. This is When the domain will be renewed or available to buy. - `DomainLocality` string — The city of the DomainOrganization. - `DomainName` string — The domain name portion of the email address. (All characters between the “@” and “.” characters.). - `DomainOrganization` string — The company associated with the domain owner. - `DomainPostalCode` string — The postal code of the DomainOrganization. - `DomainPrivateProxy` string — Check if domain is behind a private proxy. - `DomainUpdatedDate` string — The date the domain was last updated in the YYYY-MM-DDTHH:MM:SS format. - `EmailAddress` string — The email address or domain, including any correcctions or updates made by the service. - `EmailAgeEstimated` string — The estimated minimum age of the email in days based on historical data. The value is zero when we lack historical data on a given email. - `MailboxName` string — The mailbox or user name portion of the email address (Everything before the “@” in the email address). - `MXServer` string — Premium only. The Mail Exchange (MX) Server used to validate the email. - `PrivacyFlag` string — Is this email affected by additional privacy regulations, such as GDPR. Returns Y for yes and N for no. - `Results` string — Comma delimited status, error codes, and change codes for the record. See the [Result Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-resultcodesfull) for a full list. - `TopLevelDomain` string — The description associated with the top-level domain name of the email address (e.g. com is Commercial). - `TopLevelDomainName` string — The top level domain name portion of the email address (All characters after the “.”, e.g. com). - `Identity` object - `AccountNumber` object — An object that returns one field for account number status. Example: "AccountNumber": { "Validated":"Y" } - `Validated` string — Returns a string containing either Y or N. - `BusinessInformation` object — An object that returns the following Business Information - `Name` string — Name of the business that matched - `ID` string — Business ID. Uses the official business ID specific to the country: - US: EIN - SG: Unique Entity Number - CA: Corporations Number or Business Number - DE: German Trade Register or Handelsregister (HRB) - `Status` string — The current status of the business. e.g. Active. - `Type` string — Business Type, e.g. Corporation, Limited Liability Company. - `RegistrationDate` string — Registration Date of the business, in the YYYY-MM-DD format. - `Confidence` string — This indicates how reliable the record is after performing ID verification. The 3 possible values returned: - High: Passing or high quality score - Medium: Possible pass with multiple matching elements - Low: None or minimal match rate - `DateOfBirth` string — The input date of birth returned as is. - `Datasources` object[] — Contains an array of data sources where a match is found against the input. This field is only available when the Verify action is specified. Otherwise a null value is returned. Example: "Datasources": [ "DatasourceName":"", "Results":"", "Messages": [{ "ResultCode":"", "Description":"" }] ] - `DatasourceName` string — A string value indicating the name/type of data source. - `Results` string — A string value containing the KV* result codes, indicating how the input matched against this particular data source. - `Messages` object[] — An array object, listing the meaning of each KV* result code for this data source. - `ResultCode` string — The particular KV* result code. - `Description` string — A string value containing the description/meaning of the KV* result code. - `NationalID` string — The input national ID returned as is. - `Results` string — Comma delimited status, error codes, and change codes for the record. See the [Result Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-resultcodesfull) for a full list. - `Watchlists` object — An object with three fields. For a list of used watchlists, see Personator Identity Watchlists. Example: "Watchlists": { "Hit":"Yes", "Sources": [{ "Name":"Specially Designated Nationals OFAC", "Code":"", "Type":"sanction", "Date":"" }, { "Name":"United Kingdom HM Treasury", "Code": "PR", "Type": "sanction", "Date": "2005-12-07" }], "Articles": [{ "Title":"SampleTitleName", "Link":"http://samplereportlink.com", "Date":"2017-09-30T00:00:00Z" }], } - `Hit` string — Returns a string containing either Yes or No. - `Sources` object[] — Returns an array of the names of watchlists the individual was found on. - `Name` string — A string value containing the name of the Watchlist source that was matched. - `Code` string — A two letter string representing the code attributed to the watchlist source. Premium Watchlist matches will always return PR. - `Type` string — A string value containing the type or category of Watchlist that was matched against. - `Date` string — A string value containing the date (YYYY-MM-DD) of when the Watchlist source was created. An empty string will be returned if the source does not have this information. - `Articles` object[] — Returns the title, link and date of the article. - `Title` string - `Link` string - `Date` string - `ReportLink` string - `WatchlistsPersons` string — Blank (Currently reserved for future) - A string value listing the potential names that were found matched on a watchlist. - `Name` object - `Company` string — The standardized company name. - `Gender` string — A one-character string value indicating the gender of the first name from the input. For a list of these codes, see the [Product Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-referenceguide-resultcodes-productcodes) list. - `Gender2` string — A one-character string value indicating the gender of the inputted full name. For a list of these codes, see the [Product Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-referenceguide-resultcodes-productcodes) list. If the FullName input property contained multiple names, the gender of the second name will be returned here. - `NameFirst` string — The first name from an inputted full name. If the FullName input property contained a single name, the first name, if any, will be returned here. If two names were passed, the first of the two first names will be returned by this property. - `NameFirst2` string — The second first name from an inputted full name. If the FullName input property contained multiple names, the second first name will be returned here. - `NameLast` string — The last name from an inputted full name. If the FullName input property contained a single name, the last name, if any, will be returned here. If two names were passed, the first of the two last names will be returned by this property. - `NameLast2` string — The second last name from an inputted full name. If the FullName input property contained multiple names, the second last name, if any, will be returned here. - `NameMiddle` string — The middle name from an inputted full name. If the FullName input property contained a single name, the middle name, if any, will be returned here. If two names were passed, the first of the two middle names will be returned by this property. - `NameMiddle2` string — The second middle name from an inputted full name. If the FullName input property contained multiple names, the second middle name, if any, will be returned here. - `NamePrefix` string — The first prefix (such as Mr. or Dr.) from an inputted full name. If the FullName input property contained a single name, the prefix, if any, will be returned here. If two names were passed, the first of the two prefixes will be returned by this property. - `NamePrefix2` string — The second prefix (such as Mr. or Dr.) from an inputted full name. If the FullName input property contained multiple names, the second prefix will be returned here. - `NameSuffix` string — The first suffix (such as Jr. or III) from an inputted full name. If the FullName input property contained a single name, the suffix, if any, will be returned here. If two names were passed, the first of the two suffixes will be returned by this property. - `NameSuffix2` string — The second suffix (such as Jr. or III) from an inputted full name. If the FullName input property contained multiple names, the second suffix, if any, will be returned here. - `Results` string — Comma delimited status, error codes, and change codes for the record. For a list of these codes, see the [Result Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html) list. - `Phone` object - `AdministrativeArea` string — State. The administrative area (state) associated with the phone number. - `CallerID` string — The user name associated with the phone number, provided by our Caller ID service. - `Carrier` string — The phone number's carrier name. - `CountryAbbreviation` string — The abbreviation of the country. - `PhoneCountryDialingCode` string — The digit(s) required to reach the target country. These are dialed after the international prefix. - `CountryName` string — The country name associated with the phone number. - `DST` string — Indicates if the phone number region observes daylight savings time. Y for yes or N for no. - `InternationalPhoneNumber` string — The number you dial to successfully send an international call. This number can change depending on the Country of Origin field. - `PhoneInternationalPrefix` string — The international exit code needed to call a number outside of the dialing country. This depends on the Country of Origin and Country input fields. - `Language` string — The predominant language of the phone number's geographical location. - `Latitude` string — The latitude of the phone number's service area. Latitude is measured in degrees north or south of the equator. - `Locality` string — The locality (city) associated with the phone number. - `Longitude` string — The latitude of the phone number's service area. Latitude is measured in degrees east or west of the Greenwich Meridian. - `PhoneNationPrefix` string — The digit(s) dialed before an area (city) code when calling a number within the same country but outside the numbering area. - `PhoneNationalDestinationCode` string — The national destination code, the numbering area within a country (or group of countries) and/or network/services. - `PhoneNumber` string — The standardized phone number. This will return in varying formats depending on the inputs. For more detailed information, see [Phone Number Format](https://docs.melissa.com/cloud-api/global-phone/global-phone-reference-guide.html#globalphone-referenceguide-phonenumberformat). - `PostalCode` string — US Only. The zip code associated with the phone number. - `Results` string — Comma delimited status, error codes, and change codes for the record. See the [Result Codes](https://docs.melissa.com/cloud-api/personator-identity/result-codes.html#personatoridentity-resultcodesfull) for a full list. - `PhoneSubscriberNumber` string — The significant leading digits that further define the local exchange area and/or service. - `Suggestions` string — An array of Response Record Elements. This is for single-record requests only. - `UTC` string — The phone number's time zone in the format: +/- hh:mm. - `TimeZoneCode` string - `TimeZoneName` string ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/melissa/apis/personator-identity.md) · [All operations](https://skmtc.net/melissa/apis/personator-identity/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/melissa/personator-identity/versions/96f386dbafe1/schema)