SSN Name Match:Request

From Melissa Data Wiki
(Redirected from SSN Verification:Request)
Jump to navigation Jump to search

← SSN Name Match

SSN Name Match Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST XML
Batch JSON
Result Codes
Result Code Use
SSN Name Match Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and at least one input SSN. Though not required, an input full name will greatly increase the chances of recognizing and verifying the SSN in question.

SSN Name Match supports REST and JSON protocols.


URL

Use URL
Secure https://namessn.melissadata.net/v4/WEB/SSN/doLookup


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST JSON
Transmission Reference Request t TransmissionReference
License Key id UserID
Record ID Record RecordID
Social Security Number ssn SSN
First Name first FirstName
Last Name last LastName
Full Name full FullName
Format format


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"
REST ?t = string


License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa Data for the web service.
If this element is absent, the web service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "UserID":"string"
REST &id = string


Request Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each phone number will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.


Record ID

Optional.
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax
JSON "RecordID":"string"


Social Security Number

Required.
This is a string value containing the Social Security Number. All hyphens are ignored when submitting the SSN. We recommended using only numbers when submitting the SSN.
Protocol Syntax
JSON "SSN":"string"
REST &ssn = string


First Name

Optional.
The given (first) name.
Protocol Syntax
JSON "FirstName":"string"
REST &first = string


Last Name

Optional.
The family (last) name.
Protocol Syntax
JSON "LastName":"string"
REST &last = string


Full Name

Recommended.
This field can contain a full name. We will parse and check Names only if the First Name and Last Name fields are left blank.
Protocol Syntax
JSON "FullName":"string"
REST &full = string


Format

Optional.
Sets the format of the response.
Protocol Syntax
REST &format = string