SSN Name Match:Response

← SSN Name Match

A response is the result of a request. This consists of returned results codes, Social Security Numbers, and appended geographic information.

Depending on the protocol used to make the request, the response will be in a certain protocol. SSN Name Match supports JSON and REST protocols.

Field Names

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

Field Name	Level	JSON
Transmission Results	Response (Base)	TransmissionResults
Transmission Reference		TransmissionReference
Version		Version
Total Records		TotalRecords
Record ID	Record	RecordID
Social Security Number		SSN
Issuing State		IssuingState
Results		Results
Results From Data Source		ResultsFromDataSource

Response Elements

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

Transmission Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.

For a complete list of error codes, see Result Codes.

Protocol	Syntax
JSON	"TransmissionResults":"string"
XML	<TransmissionResults>string</TransmissionResults>

Transmission Reference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.

Protocol	Syntax
JSON	"TransmissionReference":"string"
XML	<TransmissionReference>string</TransmissionReference>

Version

This is a string value that is the current revision number of the SSN Name Match service.

Protocol	Syntax
JSON	"Version":"string"
XML	<Version>string</Version>

Total Records

Displays the total number of records returned.

Protocol	Syntax
JSON	"TotalRecords":"string"
XML	<TotalRecords>string</TotalRecords>

Response Record Elements

JSON will only contain the Records element.

Protocol	Definition
JSON	Each SSN record will be contained within [{}] under the Records element.

Each of the following elements are returned for each record in the Response Array.

Record ID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.

Protocol	Syntax
JSON	"RecordID":"string"
XML	<RecordID>string</RecordID>

Social Security Number

This is the returned string value of the Social Security Number submitted for validation.

Protocol	Syntax
JSON	"SSN":"string"
XML	<SSN>string</SSN>

Issuing State

This is a string value of the issued state calculated by using the SSN Area Number (first 3 digits of the SSN).

Protocol	Syntax
JSON	"IssuingState":"string"
XML	<IssuingState>string</IssuingState>

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see SSN Name Match Result Codes.

Protocol	Syntax
JSON	"Results":"string"
XML	<Results>string</Results>

Results From Data Source

This is a string value with comma delimited status, error codes, and change codes from the Data Source.

Protocol	Syntax
JSON	"ResultsFromDataSource":"string"
XML	<ResultsFromDataSource>string</ResultsFromDataSource>