Method PasswordUpdate

The PasswordUpdate method, as the name implies, is used to change the user’s SBA application password. In case of errors, both an error number and text message will be returned. Passwords must be a minimum of 8 characters long, containing at least 3 of the 4 character classes (uppercase letter, lowercase letter, numeric digits and special characters).

API Documentation
SOAP Component: https://catweb.sba.gov/pims/ws/pims2.wsdl.
SOAP Method: PasswordUpdate, only input is structure Inputs. (No JSON-string equivalent method.)
REST Component: /rest/pims/legacy/
REST Method: /rest/pims/legacy/PasswordUpdate
Keys of the Input Structure:
  • CLSUsername
    		•  Mandatory. CLS login’s username.
  • CLSPassword
    		•  Mandatory. CLS login’s password.
  • PIN
    		•  Mandatory. PIN generated by Generate_PIN using the same login.
  • NewPassword
    		•  Mandatory. New password for that CLS login.
    Keys of the Output Structure:
  • ErrorMessageEnglish
    		•  Should be nullstring. If not, a generally-worded error message.
  • ErrorMessageTechnical
    		•  Should be nullstring. If not, a more helpful error message, but scarier to some users.
  • PasswordUpdateRequired
    		•  “Yes”, “No”, number of days till expiration or “TBD” (prior to validating login).
  • Comment
    		•  If successful “Password changed.”
  • ResultCode
    		•  0 for success, some other value for failure. (The number returned is significant.)

    For examples of calling flexible, structured methods, see Flexible Structure of Inputs