SSN Name Match:Response - Revision history

Admin: Admin moved page SSN Verification:Response to SSN Name Match:Response: Name Change

2023-04-15T00:43:09Z

Admin moved page SSN Verification:Response to SSN Name Match:Response: Name Change

← Older revision	Revision as of 00:43, 15 April 2023
(No difference)

Admin at 00:42, 15 April 2023

2023-04-15T00:42:56Z

← Older revision		Revision as of 00:42, 15 April 2023
Line 7:		Line 7:
	A response is the result of a request. This consists of returned results codes, Social Security Numbers, and appended geographic information.		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 ~~Verification~~ supports JSON and REST protocols.		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.


Line 66:		Line 66:

	<h3 style="background-color:rgb(240,240,240);">Version</h3>		<h3 style="background-color:rgb(240,240,240);">Version</h3>
	:This is a string value that is the current revision number of the SSN ~~Verification~~ service.		:This is a string value that is the current revision number of the SSN Name Match service.

	:{\| class="alternate01"		:{\| class="alternate01"
Line 140:		Line 140:
	:This is a string value with comma delimited status, error codes, and change codes for the record.		:This is a string value with comma delimited status, error codes, and change codes for the record.

	:For a complete list of codes, see [[Result Code Details#SSN ~~Verification~~\|SSN ~~Verification~~ Result Codes]].		:For a complete list of codes, see [[Result Code Details#SSN Name Match\|SSN Name Match Result Codes]].

	:{\| class="alternate01"		:{\| class="alternate01"
Line 163:		Line 163:


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

Admin at 00:57, 11 March 2023

2023-03-11T00:57:46Z

← Older revision		Revision as of 00:57, 11 March 2023
Line 7:		Line 7:
	A response is the result of a request. This consists of returned results codes, Social Security Numbers, and appended geographic information.		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 ~~Web Service~~ supports JSON and REST protocols.		Depending on the protocol used to make the request, the response will be in a certain protocol. SSN Verification supports JSON and REST protocols.


Line 66:		Line 66:

	<h3 style="background-color:rgb(240,240,240);">Version</h3>		<h3 style="background-color:rgb(240,240,240);">Version</h3>
	:This is a string value that is the current revision number of the SSN ~~Web Service~~.		:This is a string value that is the current revision number of the SSN Verification service.

	:{\| class="alternate01"		:{\| class="alternate01"
Line 140:		Line 140:
	:This is a string value with comma delimited status, error codes, and change codes for the record.		:This is a string value with comma delimited status, error codes, and change codes for the record.

	:For a complete list of codes, see [[Result Code Details#SSN ~~Web Service~~\|SSN ~~Web Service~~ Result Codes]].		:For a complete list of codes, see [[Result Code Details#SSN Verification\|SSN Verification Result Codes]].

	:{\| class="alternate01"		:{\| class="alternate01"
Line 163:		Line 163:


	[[Category:SSN ~~Web Service~~]]		[[Category:SSN Verification]]
	[[Category:Reference]]		[[Category:Reference]]

Admin: Admin moved page SSN Web Service:Response to SSN Verification:Response: Service Renamed

2023-03-11T00:57:03Z

Admin moved page SSN Web Service:Response to SSN Verification:Response: Service Renamed

← Older revision	Revision as of 00:57, 11 March 2023
(No difference)

Admin at 00:25, 25 February 2023

2023-02-25T00:25:10Z

← Older revision		Revision as of 00:25, 25 February 2023
Line 49:		Line 49:
	\|JSON\|\|<code>"TransmissionResults":"'''''string'''''"</code>		\|JSON\|\|<code>"TransmissionResults":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><TransmissionResults>string</TransmissionResults></code>		\|XML\|\|<code><TransmissionResults>'''''string'''''</TransmissionResults></code>
	\|}		\|}

Line 61:		Line 61:
	\|JSON\|\|<code>"TransmissionReference":"'''''string'''''"</code>		\|JSON\|\|<code>"TransmissionReference":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><TransmissionReference>string</TransmissionReference></code>		\|XML\|\|<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
	\|}		\|}

Line 73:		Line 73:
	\|JSON\|\|<code>"Version":"'''''string'''''"</code>		\|JSON\|\|<code>"Version":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><Version>string</Version></code>		\|XML\|\|<code><Version>'''''string'''''</Version></code>
	\|}		\|}

Line 85:		Line 85:
	\|JSON\|\|<code>"TotalRecords":"'''''string'''''"</code>		\|JSON\|\|<code>"TotalRecords":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><TotalRecords>string</TotalRecords></code>		\|XML\|\|<code><TotalRecords>'''''string'''''</TotalRecords></code>
	\|}		\|}

Line 109:		Line 109:
	\|JSON\|\|<code>"RecordID":"'''''string'''''"</code>		\|JSON\|\|<code>"RecordID":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><RecordID>string</RecordID></code>		\|XML\|\|<code><RecordID>'''''string'''''</RecordID></code>
	\|}		\|}

Line 121:		Line 121:
	\|JSON\|\|<code>"SSN":"'''''string'''''"</code>		\|JSON\|\|<code>"SSN":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><SSN>string</SSN></code>		\|XML\|\|<code><SSN>'''''string'''''</SSN></code>
	\|}		\|}

Line 133:		Line 133:
	\|JSON\|\|<code>"IssuingState":"'''''string'''''"</code>		\|JSON\|\|<code>"IssuingState":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><IssuingState>string</IssuingState></code>		\|XML\|\|<code><IssuingState>'''''string'''''</IssuingState></code>
	\|}		\|}

Line 147:		Line 147:
	\|JSON\|\|<code>"Results":"'''''string'''''"</code>		\|JSON\|\|<code>"Results":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><Results>string</Results></code>		\|XML\|\|<code><Results>'''''string'''''</Results></code>
	\|}		\|}

Line 159:		Line 159:
	\|JSON\|\|<code>"ResultsFromDataSource":"'''''string'''''"</code>		\|JSON\|\|<code>"ResultsFromDataSource":"'''''string'''''"</code>
	\|-		\|-
	\|XML\|\|<code><ResultsFromDataSource>string</ResultsFromDataSource></code>		\|XML\|\|<code><ResultsFromDataSource>'''''string'''''</ResultsFromDataSource></code>
	\|}		\|}

Admin at 00:19, 25 February 2023

2023-02-25T00:19:26Z

← Older revision		Revision as of 00:19, 25 February 2023
Line 48:		Line 48:
	\|-		\|-
	\|JSON\|\|<code>"TransmissionResults":"'''''string'''''"</code>		\|JSON\|\|<code>"TransmissionResults":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><TransmissionResults>string</TransmissionResults></code>
	\|}		\|}

Line 58:		Line 60:
	\|-		\|-
	\|JSON\|\|<code>"TransmissionReference":"'''''string'''''"</code>		\|JSON\|\|<code>"TransmissionReference":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><TransmissionReference>string</TransmissionReference></code>
	\|}		\|}

Line 68:		Line 72:
	\|-		\|-
	\|JSON\|\|<code>"Version":"'''''string'''''"</code>		\|JSON\|\|<code>"Version":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><Version>string</Version></code>
	\|}		\|}

Line 78:		Line 84:
	\|-		\|-
	\|JSON\|\|<code>"TotalRecords":"'''''string'''''"</code>		\|JSON\|\|<code>"TotalRecords":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><TotalRecords>string</TotalRecords></code>
	\|}		\|}

Line 100:		Line 108:
	\|-		\|-
	\|JSON\|\|<code>"RecordID":"'''''string'''''"</code>		\|JSON\|\|<code>"RecordID":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><RecordID>string</RecordID></code>
	\|}		\|}

Line 110:		Line 120:
	\|-		\|-
	\|JSON\|\|<code>"SSN":"'''''string'''''"</code>		\|JSON\|\|<code>"SSN":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><SSN>string</SSN></code>
	\|}		\|}

Line 120:		Line 132:
	\|-		\|-
	\|JSON\|\|<code>"IssuingState":"'''''string'''''"</code>		\|JSON\|\|<code>"IssuingState":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><IssuingState>string</IssuingState></code>
	\|}		\|}

Line 132:		Line 146:
	\|-		\|-
	\|JSON\|\|<code>"Results":"'''''string'''''"</code>		\|JSON\|\|<code>"Results":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><Results>string</Results></code>
	\|}		\|}

Line 142:		Line 158:
	\|-		\|-
	\|JSON\|\|<code>"ResultsFromDataSource":"'''''string'''''"</code>		\|JSON\|\|<code>"ResultsFromDataSource":"'''''string'''''"</code>
			\|-
			\|XML\|\|<code><ResultsFromDataSource>string</ResultsFromDataSource></code>
	\|}		\|}

Admin: Created page with "{{ SSNWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} 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 Web Service supports JSON and REST protocols. ==Field Names== This is a list of the response field names and their protocol naming conventions. {| class="alternate01 so..."

2023-01-28T01:15:20Z

Created page with "{{ SSNWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} 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 Web Service supports JSON and REST protocols. ==Field Names== This is a list of the response field names and their protocol naming conventions. {| class="alternate01 so..."

New page

{{ SSNWebServiceNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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 Web Service supports JSON and REST protocols.

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

{| class="alternate01 sortable"
!Field Name !! Level !! JSON
|-
|[[#Transmission Results|Transmission Results]]||rowspan="4" valign="center"|Response (Base)||TransmissionResults
|-
|[[#Transmission Reference|Transmission Reference]]||TransmissionReference
|-
|[[#Version|Version]]||Version
|-
|[[#Total Records|Total Records]]||TotalRecords
|-
|[[#Record ID|Record ID]]||rowspan="5" valign="center"|Record||RecordID
|-
|[[#Social Security Number|Social Security Number]]||SSN
|-
|[[#Issuing State|Issuing State]]||IssuingState
|-
|[[#Results|Results]]||Results
|-
|[[#Results From Data Source|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.

<h3 style="background-color:rgb(240,240,240);">Transmission Results</h3>
: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 Code Details|Result Codes]].

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

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

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

<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value that is the current revision number of the SSN Web Service.

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

<h3 style="background-color:rgb(240,240,240);">Total Records</h3>
:Displays the total number of records returned.

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

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

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

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

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

<h3 style="background-color:rgb(240,240,240);">Social Security Number</h3>
:This is the returned string value of the Social Security Number submitted for validation.

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

<h3 style="background-color:rgb(240,240,240);">Issuing State</h3>
:This is a string value of the issued state calculated by using the SSN Area Number (first 3 digits of the SSN).

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

<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.

:For a complete list of codes, see [[Result Code Details#SSN Web Service|SSN Web Service Result Codes]].

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

<h3 style="background-color:rgb(240,240,240);">Results From Data Source</h3>
:This is a string value with comma delimited status, error codes, and change codes from the Data Source.

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

[[Category:SSN Web Service]]
[[Category:Reference]]