Method GetPartnerInfo

The GetPartnerInfo method is used by LGPC to retrieve partner and agreement information in order to automate the current CAIVRS process. The API looks up partners and generates a variety of information, especially related to the active agreements.

API Documentation
SOAP Component: https://catweb.sba.gov/pims/ws/pims2.wsdl.
SOAP Method: GetPartnerInfo, only input is structure Inputs. (No JSON-string equivalent method.)
REST Component: /rest/pims/legacy/
REST Method: /rest/pims/legacy/GetPartnerInfo
Keys of the Input Structure:
  • CLSUsername
    		•  Mandatory. CLS user's username.
  • CLSPassword
    		•  Mandatory. CLS user's password.
  • CLSPIN
    		•  Mandatory. PIN generated by Generate_PIN using the same login.
  • softwareVendorName
    		•  Mandatory. The name for designated vendors allowed to access this API.
  • softwareVendorcode
    		•  Mandatory. The code for designated vendors allowed to access this API.
  • versionNumber
    		•  Optional. If absent, the current default version will be used.
    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).
  • ResultCode
    		•  0 for success, -9 for incorrect authorizations (CLS Authentication, Required Roles, Approved Vendor), -98 for wrong Version Number, -99 for missing mandatory fields.
  • RecordCount
    		•  Number of partner records returned in the Response array.
  • Response
    		•  Array of partner objects, each containing:
    • Partner ID - Unique identifier for the partner
    • Partner Name - Name of the partner organization
    • Location ID - Location identifier
    • FIRS Number - FIRS identification number
    • Primary Category - Partner's primary business category
    • Established Date - Date the partner was established
    • Partner Type - Type of partner (e.g., "Banking institution", "Funds")
    • Status- Current status (e.g., "Open")
    • Charter - Charter type (e.g., "National")
    • Open Locations - Number of open locations
    • SBA Office - Associated SBA office information
    • Number of Subsidiaries - Count of subsidiaries
    • Legal Type - Legal structure type (e.g., "Stock", "Not classified")
    • Tax Identification Number - Tax ID number
    • Physical Address - Physical address of the partner
    • Mailing Address - Mailing address (if different)
    • OWNING PARTNERS - Array of owner objects, each containing:
      • Owner ID - Owner's unique identifier
      • Owner Name - Name of the owning entity
      • Owner Type- Type of ownership
      • Subsidiary Type- Type of subsidiary relationship
    • ACTIVE AGREEMENTS - Array of strings listing active agreement names

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