POST AddressValidation

Request Information

URI Parameters

None.

Body Parameters

PacejetAPI.AddressValidation.AddressVerify
NameDescriptionType
ValidationMethod click for description string
LicenseID click for description string
Address1 click for description string
Address2 click for description string
City click for description string
State click for description string
Zip click for description string
Country click for description string

Request Formats

application/json, text/json

Sample: 
{
  "validationMethod": "sample string 1",
  "licenseID": "sample string 2",
  "address1": "sample string 3",
  "address2": "sample string 4",
  "city": "sample string 5",
  "state": "sample string 6",
  "zip": "sample string 7",
  "country": "sample string 8"
}

application/xml, text/xml

Sample: 
<AddressVerify xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ValidationMethod>sample string 1</ValidationMethod>
  <LicenseID>sample string 2</LicenseID>
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <City>sample string 5</City>
  <State>sample string 6</State>
  <Zip>sample string 7</Zip>
  <Country>sample string 8</Country>
</AddressVerify>

Response Information

Resource Description

PacejetAPI.AddressValidation.AddressVerifyResponse
NameDescriptionType
AddressRequest PacejetAPI.AddressValidation.AddressVerify
SuggestedAddress PacejetAPI.AddressValidation.Address
IsVerified boolean
IsVerifiedText click for description string
Error PacejetAPI.Models.CommonModels+Error

Response Formats

application/json, text/json

Sample: 
{
  "addressRequest": {
    "validationMethod": "sample string 1",
    "licenseID": "sample string 2",
    "address1": "sample string 3",
    "address2": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zip": "sample string 7",
    "country": "sample string 8"
  },
  "suggestedAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zip": "sample string 5",
    "country": "sample string 6",
    "type": "sample string 7",
    "addressAttributes": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ]
  },
  "isVerified": true,
  "isVerifiedText": "sample string 2",
  "error": {
    "code": "sample string 1",
    "message": "sample string 2",
    "severity": "sample string 3",
    "source": "sample string 4",
    "moreInfo": {
      "link": "sample string 1",
      "exception": {
        "message": "sample string 1",
        "stack": "sample string 2"
      }
    }
  }
}

application/xml, text/xml

Sample: 
<AddressVerifyResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AddressRequest>
    <ValidationMethod>sample string 1</ValidationMethod>
    <LicenseID>sample string 2</LicenseID>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
    <Country>sample string 8</Country>
  </AddressRequest>
  <SuggestedAddress>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <City>sample string 3</City>
    <State>sample string 4</State>
    <Zip>sample string 5</Zip>
    <Country>sample string 6</Country>
    <Type>sample string 7</Type>
    <AddressAttributes>
      <AddressAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </AddressAttribute>
      <AddressAttribute>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </AddressAttribute>
    </AddressAttributes>
  </SuggestedAddress>
  <IsVerified>true</IsVerified>
  <IsVerifiedText>sample string 2</IsVerifiedText>
  <Error>
    <Code>sample string 1</Code>
    <Message>sample string 2</Message>
    <Severity>sample string 3</Severity>
    <Source>sample string 4</Source>
    <MoreInfo>
      <Link>sample string 1</Link>
      <Exception>
        <Message>sample string 1</Message>
        <Stack>sample string 2</Stack>
      </Exception>
    </MoreInfo>
  </Error>
</AddressVerifyResponse>