POST api/AddressValidation

Verify validity of an Address

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Description	Additional information
Carrier	ShipCarrierTypeV4
Address	AddressV4
FullAddressValidation	boolean
Options	Dictionary of string [key] and string [value]

Request Formats

application/json, text/json

Sample:

{
  "Carrier": 0,
  "Address": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "FullAddressValidation": true,
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:

<AddressValidationRequestV4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InvectioApi.Models.PackageHub.v4">
  <Address>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <City>sample string 10</City>
    <Country>sample string 13</Country>
    <Description>sample string 5</Description>
    <Id>sample string 6</Id>
    <IsResidential>true</IsResidential>
    <Option>None</Option>
    <PostalCode>sample string 12</PostalCode>
    <StateProvince>sample string 11</StateProvince>
    <Company>sample string 2</Company>
    <Email>sample string 4</Email>
    <Name>sample string 1</Name>
    <Phone>sample string 3</Phone>
  </Address>
  <Carrier>None</Carrier>
  <FullAddressValidation>true</FullAddressValidation>
  <Options xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Options>
</AddressValidationRequestV4>

Response Information

Resource Description

AddressValidationResponseV4

Name	Type	Description	Additional information
OriginalAddress	AddressV4
ValidatedAddress	AddressV4
Corrected	boolean
Valid	boolean
CityStatePostalCodeMatch	boolean
ResultCode	string
ResultMessage	string
ExecutionTimeInMS	integer
MetaData	Dictionary of string [key] and string [value]

Response Formats

application/json, text/json

Sample:

{
  "OriginalAddress": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "ValidatedAddress": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "Corrected": true,
  "Valid": true,
  "CityStatePostalCodeMatch": true,
  "ResultCode": "sample string 1",
  "ResultMessage": "sample string 2",
  "ExecutionTimeInMS": 3,
  "MetaData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<AddressValidationResponseV4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InvectioApi.Models.PackageHub.v4">
  <CityStatePostalCodeMatch>true</CityStatePostalCodeMatch>
  <Corrected>true</Corrected>
  <ExecutionTimeInMS>3</ExecutionTimeInMS>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MetaData>
  <OriginalAddress>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <City>sample string 10</City>
    <Country>sample string 13</Country>
    <Description>sample string 5</Description>
    <Id>sample string 6</Id>
    <IsResidential>true</IsResidential>
    <Option>None</Option>
    <PostalCode>sample string 12</PostalCode>
    <StateProvince>sample string 11</StateProvince>
    <Company>sample string 2</Company>
    <Email>sample string 4</Email>
    <Name>sample string 1</Name>
    <Phone>sample string 3</Phone>
  </OriginalAddress>
  <ResultCode>sample string 1</ResultCode>
  <ResultMessage>sample string 2</ResultMessage>
  <Valid>true</Valid>
  <ValidatedAddress>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <City>sample string 10</City>
    <Country>sample string 13</Country>
    <Description>sample string 5</Description>
    <Id>sample string 6</Id>
    <IsResidential>true</IsResidential>
    <Option>None</Option>
    <PostalCode>sample string 12</PostalCode>
    <StateProvince>sample string 11</StateProvince>
    <Company>sample string 2</Company>
    <Email>sample string 4</Email>
    <Name>sample string 1</Name>
    <Phone>sample string 3</Phone>
  </ValidatedAddress>
</AddressValidationResponseV4>