SwsimV135 Web Service

SwsimV135

Click here for a complete list of operations.

RegisterAccount

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/swsimv135.asmx HTTP/1.1
Host: swsim.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2023/07/swsim/SwsimV135/RegisterAccount"

<?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>
    <RegisterAccount xmlns="http://stamps.com/xml/namespace/2023/07/swsim/SwsimV135">
      <IntegrationID>guid</IntegrationID>
      <UserName>string</UserName>
      <Password>string</Password>
      <Codeword1Type>Undefined or MothersMaidenName or PetsName or BirthCity or HighSchoolMascot or FathersBirthplace or StreetName or FirstSchoolsName or FirstCarsMakeModel or Last4SocialSecurityNumber or Last4DriversLicense</Codeword1Type>
      <Codeword1>string</Codeword1>
      <Codeword2Type>Undefined or MothersMaidenName or PetsName or BirthCity or HighSchoolMascot or FathersBirthplace or StreetName or FirstSchoolsName or FirstCarsMakeModel or Last4SocialSecurityNumber or Last4DriversLicense</Codeword2Type>
      <Codeword2>string</Codeword2>
      <PhysicalAddress>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </PhysicalAddress>
      <MailingAddress>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </MailingAddress>
      <MachineInfo>
        <IPAddress>string</IPAddress>
        <MacAddress>string</MacAddress>
        <FP>
          <FP1>base64Binary</FP1>
          <FP2>base64Binary</FP2>
          <FP3>base64Binary</FP3>
          <FP4>base64Binary</FP4>
          <FP5>base64Binary</FP5>
        </FP>
      </MachineInfo>
      <Email>string</Email>
      <AccountType>Individual or HomeOffice or HomeBasedBusiness or OfficeBasedBusiness</AccountType>
      <PromoCode>string</PromoCode>
      <SendEmail>boolean</SendEmail>
      <ResetPasswordAfterRegistration>boolean</ResetPasswordAfterRegistration>
      <UserCurrency>string</UserCurrency>
      <IovationBlackBox>string</IovationBlackBox>
    </RegisterAccount>
  </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>
    <RegisterAccountResponse xmlns="http://stamps.com/xml/namespace/2023/07/swsim/SwsimV135">
      <RegistrationStatus>Success or Fail</RegistrationStatus>
      <SuggestedUserName>string</SuggestedUserName>
      <UserId>int</UserId>
      <PromoUrl>string</PromoUrl>
      <UserName>string</UserName>
    </RegisterAccountResponse>
  </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/swsimv135.asmx HTTP/1.1
Host: swsim.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>
    <RegisterAccount xmlns="http://stamps.com/xml/namespace/2023/07/swsim/SwsimV135">
      <IntegrationID>guid</IntegrationID>
      <UserName>string</UserName>
      <Password>string</Password>
      <Codeword1Type>Undefined or MothersMaidenName or PetsName or BirthCity or HighSchoolMascot or FathersBirthplace or StreetName or FirstSchoolsName or FirstCarsMakeModel or Last4SocialSecurityNumber or Last4DriversLicense</Codeword1Type>
      <Codeword1>string</Codeword1>
      <Codeword2Type>Undefined or MothersMaidenName or PetsName or BirthCity or HighSchoolMascot or FathersBirthplace or StreetName or FirstSchoolsName or FirstCarsMakeModel or Last4SocialSecurityNumber or Last4DriversLicense</Codeword2Type>
      <Codeword2>string</Codeword2>
      <PhysicalAddress>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </PhysicalAddress>
      <MailingAddress>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </MailingAddress>
      <MachineInfo>
        <IPAddress>string</IPAddress>
        <MacAddress>string</MacAddress>
        <FP>
          <FP1>base64Binary</FP1>
          <FP2>base64Binary</FP2>
          <FP3>base64Binary</FP3>
          <FP4>base64Binary</FP4>
          <FP5>base64Binary</FP5>
        </FP>
      </MachineInfo>
      <Email>string</Email>
      <AccountType>Individual or HomeOffice or HomeBasedBusiness or OfficeBasedBusiness</AccountType>
      <PromoCode>string</PromoCode>
      <SendEmail>boolean</SendEmail>
      <ResetPasswordAfterRegistration>boolean</ResetPasswordAfterRegistration>
      <UserCurrency>string</UserCurrency>
      <IovationBlackBox>string</IovationBlackBox>
    </RegisterAccount>
  </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>
    <RegisterAccountResponse xmlns="http://stamps.com/xml/namespace/2023/07/swsim/SwsimV135">
      <RegistrationStatus>Success or Fail</RegistrationStatus>
      <SuggestedUserName>string</SuggestedUserName>
      <UserId>int</UserId>
      <PromoUrl>string</PromoUrl>
      <UserName>string</UserName>
    </RegisterAccountResponse>
  </soap12:Body>
</soap12:Envelope>