SwsimV45 Web Service

SwsimV45

Click here for a complete list of operations.

CleanseAddress

Cleanse an address.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /swsim/SwsimV45.asmx HTTP/1.1
Host: swsim.testing.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2015/05/swsim/swsimv45/CleanseAddress"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CleanseAddress xmlns="http://stamps.com/xml/namespace/2015/05/swsim/swsimv45">
      <Address>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </Address>
      <FromZIPCode>string</FromZIPCode>
    </CleanseAddress>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CleanseAddressResponse xmlns="http://stamps.com/xml/namespace/2015/05/swsim/swsimv45">
      <Authenticator>string</Authenticator>
      <Address>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </Address>
      <AddressMatch>boolean</AddressMatch>
      <CityStateZipOK>boolean</CityStateZipOK>
      <ResidentialDeliveryIndicator>Yes or No or Unknown or Unsupported</ResidentialDeliveryIndicator>
      <IsPOBox>boolean</IsPOBox>
      <CandidateAddresses>
        <Address>
          <FullName>string</FullName>
          <NamePrefix>string</NamePrefix>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <NameSuffix>string</NameSuffix>
          <Title>string</Title>
          <Department>string</Department>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <ZIPCode>string</ZIPCode>
          <ZIPCodeAddOn>string</ZIPCodeAddOn>
          <DPB>string</DPB>
          <CheckDigit>string</CheckDigit>
          <Province>string</Province>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Urbanization>string</Urbanization>
          <PhoneNumber>string</PhoneNumber>
          <Extension>string</Extension>
          <CleanseHash>string</CleanseHash>
          <OverrideHash>string</OverrideHash>
        </Address>
        <Address>
          <FullName>string</FullName>
          <NamePrefix>string</NamePrefix>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <NameSuffix>string</NameSuffix>
          <Title>string</Title>
          <Department>string</Department>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <ZIPCode>string</ZIPCode>
          <ZIPCodeAddOn>string</ZIPCodeAddOn>
          <DPB>string</DPB>
          <CheckDigit>string</CheckDigit>
          <Province>string</Province>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Urbanization>string</Urbanization>
          <PhoneNumber>string</PhoneNumber>
          <Extension>string</Extension>
          <CleanseHash>string</CleanseHash>
          <OverrideHash>string</OverrideHash>
        </Address>
      </CandidateAddresses>
      <StatusCodes>
        <ReturnCode>int</ReturnCode>
        <Footnotes>
          <Footnote>
            <Value>string</Value>
          </Footnote>
          <Footnote>
            <Value>string</Value>
          </Footnote>
        </Footnotes>
        <DpvFootnotes>
          <DpvFootnote>
            <Value>string</Value>
          </DpvFootnote>
          <DpvFootnote>
            <Value>string</Value>
          </DpvFootnote>
        </DpvFootnotes>
        <SdcFootnotes>
          <int>int</int>
          <int>int</int>
        </SdcFootnotes>
      </StatusCodes>
      <Rates>
        <Rate>
          <FromZIPCode>string</FromZIPCode>
          <ToZIPCode>string</ToZIPCode>
          <ToCountry>string</ToCountry>
          <Amount>decimal</Amount>
          <MaxAmount>decimal</MaxAmount>
          <ServiceType>Unknown or US-FC or US-PM or US-XM or US-MM or US-BP or US-LM or US-EMI or US-PMI or US-FCI or US-CM or US-PS or DHL-PE or DHL-PG or DHL-PPE or DHL-PPG or DHL-BPME or DHL-BPMG or DHL-MPE or DHL-MPG or AS-IPA or AS-ISAL or AS-EPKT or DHL-PIPA or DHL-PISAL or GG-IPA or GG-ISAL or GG-EPKT or IBC-IPA or IBC-ISAL or IBC-EPKT or RRD-IPA or RRD-ISAL or RRD-EPKT or AS-GNRC or GG-GNRC</ServiceType>
          <PrintLayout>string</PrintLayout>
          <DeliverDays>string</DeliverDays>
          <WeightLb>double</WeightLb>
          <WeightOz>double</WeightOz>
          <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
          <RequiresAllOf>
            <RequiresOneOf xsi:nil="true" />
            <RequiresOneOf xsi:nil="true" />
          </RequiresAllOf>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <ShipDate>date</ShipDate>
          <DeliveryDate>date</DeliveryDate>
          <InsuredValue>decimal</InsuredValue>
          <RegisteredValue>decimal</RegisteredValue>
          <CODValue>decimal</CODValue>
          <DeclaredValue>decimal</DeclaredValue>
          <NonMachinable>boolean</NonMachinable>
          <RectangularShaped>boolean</RectangularShaped>
          <Prohibitions>string</Prohibitions>
          <Restrictions>string</Restrictions>
          <Observations>string</Observations>
          <Regulations>string</Regulations>
          <GEMNotes>string</GEMNotes>
          <MaxDimensions>string</MaxDimensions>
          <DimWeighting>string</DimWeighting>
          <AddOns>
            <AddOnV7 xsi:nil="true" />
            <AddOnV7 xsi:nil="true" />
          </AddOns>
          <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
          <IsIntraBMC>boolean</IsIntraBMC>
          <Zone>int</Zone>
          <RateCategory>int</RateCategory>
          <ToState>string</ToState>
          <CubicPricing>boolean</CubicPricing>
        </Rate>
        <Rate>
          <FromZIPCode>string</FromZIPCode>
          <ToZIPCode>string</ToZIPCode>
          <ToCountry>string</ToCountry>
          <Amount>decimal</Amount>
          <MaxAmount>decimal</MaxAmount>
          <ServiceType>Unknown or US-FC or US-PM or US-XM or US-MM or US-BP or US-LM or US-EMI or US-PMI or US-FCI or US-CM or US-PS or DHL-PE or DHL-PG or DHL-PPE or DHL-PPG or DHL-BPME or DHL-BPMG or DHL-MPE or DHL-MPG or AS-IPA or AS-ISAL or AS-EPKT or DHL-PIPA or DHL-PISAL or GG-IPA or GG-ISAL or GG-EPKT or IBC-IPA or IBC-ISAL or IBC-EPKT or RRD-IPA or RRD-ISAL or RRD-EPKT or AS-GNRC or GG-GNRC</ServiceType>
          <PrintLayout>string</PrintLayout>
          <DeliverDays>string</DeliverDays>
          <WeightLb>double</WeightLb>
          <WeightOz>double</WeightOz>
          <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
          <RequiresAllOf>
            <RequiresOneOf xsi:nil="true" />
            <RequiresOneOf xsi:nil="true" />
          </RequiresAllOf>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <ShipDate>date</ShipDate>
          <DeliveryDate>date</DeliveryDate>
          <InsuredValue>decimal</InsuredValue>
          <RegisteredValue>decimal</RegisteredValue>
          <CODValue>decimal</CODValue>
          <DeclaredValue>decimal</DeclaredValue>
          <NonMachinable>boolean</NonMachinable>
          <RectangularShaped>boolean</RectangularShaped>
          <Prohibitions>string</Prohibitions>
          <Restrictions>string</Restrictions>
          <Observations>string</Observations>
          <Regulations>string</Regulations>
          <GEMNotes>string</GEMNotes>
          <MaxDimensions>string</MaxDimensions>
          <DimWeighting>string</DimWeighting>
          <AddOns>
            <AddOnV7 xsi:nil="true" />
            <AddOnV7 xsi:nil="true" />
          </AddOns>
          <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
          <IsIntraBMC>boolean</IsIntraBMC>
          <Zone>int</Zone>
          <RateCategory>int</RateCategory>
          <ToState>string</ToState>
          <CubicPricing>boolean</CubicPricing>
        </Rate>
      </Rates>
    </CleanseAddressResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /swsim/SwsimV45.asmx HTTP/1.1
Host: swsim.testing.stamps.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CleanseAddress xmlns="http://stamps.com/xml/namespace/2015/05/swsim/swsimv45">
      <Address>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </Address>
      <FromZIPCode>string</FromZIPCode>
    </CleanseAddress>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CleanseAddressResponse xmlns="http://stamps.com/xml/namespace/2015/05/swsim/swsimv45">
      <Authenticator>string</Authenticator>
      <Address>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </Address>
      <AddressMatch>boolean</AddressMatch>
      <CityStateZipOK>boolean</CityStateZipOK>
      <ResidentialDeliveryIndicator>Yes or No or Unknown or Unsupported</ResidentialDeliveryIndicator>
      <IsPOBox>boolean</IsPOBox>
      <CandidateAddresses>
        <Address>
          <FullName>string</FullName>
          <NamePrefix>string</NamePrefix>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <NameSuffix>string</NameSuffix>
          <Title>string</Title>
          <Department>string</Department>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <ZIPCode>string</ZIPCode>
          <ZIPCodeAddOn>string</ZIPCodeAddOn>
          <DPB>string</DPB>
          <CheckDigit>string</CheckDigit>
          <Province>string</Province>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Urbanization>string</Urbanization>
          <PhoneNumber>string</PhoneNumber>
          <Extension>string</Extension>
          <CleanseHash>string</CleanseHash>
          <OverrideHash>string</OverrideHash>
        </Address>
        <Address>
          <FullName>string</FullName>
          <NamePrefix>string</NamePrefix>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <NameSuffix>string</NameSuffix>
          <Title>string</Title>
          <Department>string</Department>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <State>string</State>
          <ZIPCode>string</ZIPCode>
          <ZIPCodeAddOn>string</ZIPCodeAddOn>
          <DPB>string</DPB>
          <CheckDigit>string</CheckDigit>
          <Province>string</Province>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Urbanization>string</Urbanization>
          <PhoneNumber>string</PhoneNumber>
          <Extension>string</Extension>
          <CleanseHash>string</CleanseHash>
          <OverrideHash>string</OverrideHash>
        </Address>
      </CandidateAddresses>
      <StatusCodes>
        <ReturnCode>int</ReturnCode>
        <Footnotes>
          <Footnote>
            <Value>string</Value>
          </Footnote>
          <Footnote>
            <Value>string</Value>
          </Footnote>
        </Footnotes>
        <DpvFootnotes>
          <DpvFootnote>
            <Value>string</Value>
          </DpvFootnote>
          <DpvFootnote>
            <Value>string</Value>
          </DpvFootnote>
        </DpvFootnotes>
        <SdcFootnotes>
          <int>int</int>
          <int>int</int>
        </SdcFootnotes>
      </StatusCodes>
      <Rates>
        <Rate>
          <FromZIPCode>string</FromZIPCode>
          <ToZIPCode>string</ToZIPCode>
          <ToCountry>string</ToCountry>
          <Amount>decimal</Amount>
          <MaxAmount>decimal</MaxAmount>
          <ServiceType>Unknown or US-FC or US-PM or US-XM or US-MM or US-BP or US-LM or US-EMI or US-PMI or US-FCI or US-CM or US-PS or DHL-PE or DHL-PG or DHL-PPE or DHL-PPG or DHL-BPME or DHL-BPMG or DHL-MPE or DHL-MPG or AS-IPA or AS-ISAL or AS-EPKT or DHL-PIPA or DHL-PISAL or GG-IPA or GG-ISAL or GG-EPKT or IBC-IPA or IBC-ISAL or IBC-EPKT or RRD-IPA or RRD-ISAL or RRD-EPKT or AS-GNRC or GG-GNRC</ServiceType>
          <PrintLayout>string</PrintLayout>
          <DeliverDays>string</DeliverDays>
          <WeightLb>double</WeightLb>
          <WeightOz>double</WeightOz>
          <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
          <RequiresAllOf>
            <RequiresOneOf xsi:nil="true" />
            <RequiresOneOf xsi:nil="true" />
          </RequiresAllOf>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <ShipDate>date</ShipDate>
          <DeliveryDate>date</DeliveryDate>
          <InsuredValue>decimal</InsuredValue>
          <RegisteredValue>decimal</RegisteredValue>
          <CODValue>decimal</CODValue>
          <DeclaredValue>decimal</DeclaredValue>
          <NonMachinable>boolean</NonMachinable>
          <RectangularShaped>boolean</RectangularShaped>
          <Prohibitions>string</Prohibitions>
          <Restrictions>string</Restrictions>
          <Observations>string</Observations>
          <Regulations>string</Regulations>
          <GEMNotes>string</GEMNotes>
          <MaxDimensions>string</MaxDimensions>
          <DimWeighting>string</DimWeighting>
          <AddOns>
            <AddOnV7 xsi:nil="true" />
            <AddOnV7 xsi:nil="true" />
          </AddOns>
          <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
          <IsIntraBMC>boolean</IsIntraBMC>
          <Zone>int</Zone>
          <RateCategory>int</RateCategory>
          <ToState>string</ToState>
          <CubicPricing>boolean</CubicPricing>
        </Rate>
        <Rate>
          <FromZIPCode>string</FromZIPCode>
          <ToZIPCode>string</ToZIPCode>
          <ToCountry>string</ToCountry>
          <Amount>decimal</Amount>
          <MaxAmount>decimal</MaxAmount>
          <ServiceType>Unknown or US-FC or US-PM or US-XM or US-MM or US-BP or US-LM or US-EMI or US-PMI or US-FCI or US-CM or US-PS or DHL-PE or DHL-PG or DHL-PPE or DHL-PPG or DHL-BPME or DHL-BPMG or DHL-MPE or DHL-MPG or AS-IPA or AS-ISAL or AS-EPKT or DHL-PIPA or DHL-PISAL or GG-IPA or GG-ISAL or GG-EPKT or IBC-IPA or IBC-ISAL or IBC-EPKT or RRD-IPA or RRD-ISAL or RRD-EPKT or AS-GNRC or GG-GNRC</ServiceType>
          <PrintLayout>string</PrintLayout>
          <DeliverDays>string</DeliverDays>
          <WeightLb>double</WeightLb>
          <WeightOz>double</WeightOz>
          <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
          <RequiresAllOf>
            <RequiresOneOf xsi:nil="true" />
            <RequiresOneOf xsi:nil="true" />
          </RequiresAllOf>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <ShipDate>date</ShipDate>
          <DeliveryDate>date</DeliveryDate>
          <InsuredValue>decimal</InsuredValue>
          <RegisteredValue>decimal</RegisteredValue>
          <CODValue>decimal</CODValue>
          <DeclaredValue>decimal</DeclaredValue>
          <NonMachinable>boolean</NonMachinable>
          <RectangularShaped>boolean</RectangularShaped>
          <Prohibitions>string</Prohibitions>
          <Restrictions>string</Restrictions>
          <Observations>string</Observations>
          <Regulations>string</Regulations>
          <GEMNotes>string</GEMNotes>
          <MaxDimensions>string</MaxDimensions>
          <DimWeighting>string</DimWeighting>
          <AddOns>
            <AddOnV7 xsi:nil="true" />
            <AddOnV7 xsi:nil="true" />
          </AddOns>
          <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
          <IsIntraBMC>boolean</IsIntraBMC>
          <Zone>int</Zone>
          <RateCategory>int</RateCategory>
          <ToState>string</ToState>
          <CubicPricing>boolean</CubicPricing>
        </Rate>
      </Rates>
    </CleanseAddressResponse>
  </soap12:Body>
</soap12:Envelope>