Method LoanSearch
A variety of search criteria are allowed, and any loan matching them will be returned as XML. The CLS login must have read permissions on the loan(s) returned.
SOAP Component: | https://catweb.sba.gov/lana/ws/lana.wsdl. |
SOAP Method: | LoanSearch |
REST Component: | /rest/lana/flexible/ |
REST Method: | /rest/lana/flexible/LoanSearch |
Inputs in the WSDL: | |
Mandatory. CLS login’s username with read permissions in Servicing. | |
Mandatory. CLS login’s password with read permissions in Servicing. | |
Optional. SBA Loan number. 10-digit format preferred. | |
Optional. A 10-digit number that can represent either an EIN or an SSN. See below. | |
Optional. A comma-delimited list of TaxIds. See below. | |
Optional. | |
Optional. | |
Output in the WSDL: | |
XML in SBA_LANA_Response.xsd format. |
TaxIds are 10 digits: 0 followed all the digits of an EIN, or 1 followed by all of the digits of an SSN. No hyphens.
In case of errors, both the error number and text message will be returned for each error. Generally, the return of errors indicates that the loan number was not found in the SBA’s database. The exception is warning/error messages related to the user’s account and password are described below.
Except for message 00, the following are the login status messages that would be returned.
SLEVEL(Severity Level) | MSG(Message) | Criteria |
---|---|---|
00 | Login Successful | Login Successful |
11 | UserName is invalid. | If user name does not exist or the user has been suspended. |
12 | Password Expired | If the password has expired. |
13 | Invalid Password | If the password entered is not correct. |
21 | First Time Login. Please change the Password before continuing. | If the login is for the first time or password reset by Security. |
22 | Your password expires in "+iDays+" days. Please change the Password before continuing. | If number of days left till the password expiration is less than or equal to 15 days. |
31 | Your password expires in "+iDays+". | If number of days left for password expiration is equal to or less than 30 days. |
Note: |
- Here "iDays" is the number of days left for user password expiration.
- For the error codes starting with "1", that is 11, 12 and 13; the user is not allowed to log in.
- For error codes starting with "2", like 21 or 22, the user is not allowed to log in and must be redirected to change their password.
- For error codes starting with "3", like 31 or 32, the user is logged into the system, with a warning message.
- If the error code starts with "0", the login is successful.