View source for SSN Name Match:Request

{{ SSNWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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==
{{URL-SSNWebService}}


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

{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|[[#Transmission Reference|Transmission Reference]]||rowspan="2" valign="center"|Request||t||TransmissionReference
|-
|[[#License Key|License Key]]||id||UserID
|-
|[[#Record ID|Record ID]]||rowspan="6" valign="center"|Record|| ||RecordID
|-
|[[#Social Security Number|Social Security Number]]||ssn||SSN
|-
|[[#First Name|First Name]]||first||FirstName
|-
|[[#Last Name|Last Name]]||last||LastName
|-
|[[#Full Name|Full Name]]||full||FullName
|-
|[[#Format|Format]]||format|| 
|}


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

<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|REST||<code>?t = '''''string'''''</code>
|}


<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"UserID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|}


==Request Record Elements==
JSON will only contain the Records element.

{| class="alternate01"
!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.
|}


<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}


<h3 style="background-color:rgb(240,240,240);">Social Security Number</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SSN":"'''''string'''''"</code>
|-
|REST||<code>&ssn = '''''string'''''</code>
|}


<h3 style="background-color:rgb(240,240,240);">First Name</h3>
:''Optional.''

:The given (first) name.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"FirstName":"'''''string'''''"</code>
|-
|REST||<code>&first = '''''string'''''</code>
|}


<h3 style="background-color:rgb(240,240,240);">Last Name</h3>
:''Optional.''

:The family (last) name.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"LastName":"'''''string'''''"</code>
|-
|REST||<code>&last = '''''string'''''</code>
|}


<h3 style="background-color:rgb(240,240,240);">Full Name</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"FullName":"'''''string'''''"</code>
|-
|REST||<code>&full = '''''string'''''</code>
|}


<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''

:Sets the format of the response.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&format = '''''string'''''</code>
|}


[[Category:SSN Name Match]]
[[Category:Reference]]