POST api/VPOS/SSNCheck

Request Information

URI Parameters

None.

Body Parameters

SSNCheckRequest
NameDescriptionTypeAdditional information
ClientID

string

None.

Username

string

None.

Password

string

None.

PaymentID

string

None.

SSN

string

None.

IdentifierType

IdentifierType

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "PaymentID": "sample string 4",
  "SSN": "sample string 5",
  "IdentifierType": 1
}

application/xml, text/xml

Sample:
<SSNCheckRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>sample string 1</ClientID>
  <Username>sample string 2</Username>
  <Password>sample string 3</Password>
  <PaymentID>sample string 4</PaymentID>
  <SSN>sample string 5</SSN>
  <IdentifierType>SSN</IdentifierType>
</SSNCheckRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SSNCheckRequest'.

Response Information

Resource Description

SSNCheckResponse
NameDescriptionTypeAdditional information
Status

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<SSNCheckResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>sample string 1</Status>
  <Message>sample string 2</Message>
</SSNCheckResponse>