OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

UpdateCustomerPassword

Use this API for storing the new password set by a customer. In order to validate the customer request of updating his password we will request the Customer # and the PasswordResetKey recently generated by the customer. Deprecation Note: This API has been deprecated in favor of our REST API: ~/api/users/customer/createPassword/{customerDID}/{passwordResetKey}/{newPassword}.

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/UpdateCustomerPassword"

<?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>
    <UpdateCustomerPassword xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <CustomerDID>string</CustomerDID>
        <PasswordResetKey>string</PasswordResetKey>
        <NewPassword>string</NewPassword>
      </Request>
    </UpdateCustomerPassword>
  </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>
    <UpdateCustomerPasswordResponse xmlns="http://www.securefreedom.com/">
      <UpdateCustomerPasswordResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </UpdateCustomerPasswordResult>
    </UpdateCustomerPasswordResponse>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.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>
    <UpdateCustomerPassword xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <CustomerDID>string</CustomerDID>
        <PasswordResetKey>string</PasswordResetKey>
        <NewPassword>string</NewPassword>
      </Request>
    </UpdateCustomerPassword>
  </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>
    <UpdateCustomerPasswordResponse xmlns="http://www.securefreedom.com/">
      <UpdateCustomerPasswordResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </UpdateCustomerPasswordResult>
    </UpdateCustomerPasswordResponse>
  </soap12:Body>
</soap12:Envelope>