SCS Get Lienholders API#
Get Lienholders#
Request Schema#
This web service returns a list of lienholders.GetLienholderRequest Object#
| | | | | |
|---|
| Tag | Format | Req/ Opt/ Cond | Attribute | Valid values | Description |
| TpaCode | X(4) | R | | | Third Party Administrator Code |
| UserId | X(30) | R | | | User ID issued to the requesting system |
| Password | X(255) | R | | | Password issued to the requesting system |
| LienNumber | X(18) | O | | | Lienholder number used for trim lookup. If lienholder number is not specified all lienholders will be returned. |
| Verified | Boolean | O | | True False | If ‘true’ then only lienholders marked as ‘Verified’ will be returned. If ’false’ then only lienholders that are not verified will be returned. (Note: to get all lienholders, do not include value for Verified). |
| DealerNumber | X(18) | O | | | If passed, the service will return only Lienholders that are associated to the dealer based upon the configuration settings in the system. |
| LienHolderGroupNum ber | X(18) | O | | | If Lienholder Group number is specified, the service will return the Lienholders in the specified Lienholder Group. |
To get all lienholders for a provider, the request just needs to contain UserID, Password, and TPA Code.Sample GetLienholders SOAP Request#
<soap:envelope>
<soap:Header/>
<soap:Body>
<GetLienholders>
<request>
<UserId>xxxx</UserId>
<Password>xxxx</Password>
<TpaCode>xxx</TpaCode>
<LienNumber>string</LienNumber>
<Verified>boolean</Verified>
<DealerNumber>string</DealerNumber>
<LienHolderGroupNumber>string</LienHolderGroupNumber>
</request>
</GetLienHolders>
</soap:Body>
</soap:Envelope>
Response Schema#
GetLienholderResponse Object#
| | | |
|---|
| Tag | Content Items | Format | Description |
| GetLienholdersResponse | | | |
| GetLienholderResult | | |
| ResponseCode | | 2 = Successful, GetLienholders passed with warning. 1 = Successful, GetLienholders passed. 0 = GetLienholders failed. see Message Object for Type |
| Messages | Message Object | Collection of Messages. |
| Lienholders | | |
Message Object#
| | | | |
|---|
| Tag | Format | Req/Opt/Cond | Valid values | Description |
| Type | Integer | R | 1 = Error, 2 = Info, 3 = Warning, 4 = Success | Message Type |
| Code | String, X(30) | R | | Returns the associated message code with each message text. |
| Text | String, X(2000) | R | | Message Text |
Lienholders Object#
| | | |
|---|
| Tag | Content Items | Format | Description |
| Lienholders/ | | | |
| Lienholder | | Collection (array 1..N) of Trims. |
Lienholder Object#
| | | | | |
|---|
| Tag | Format | Req/ Opt/ Cond | Attribut es | Valid values | Description |
| Number | X(18) | | | | Lienholder Number |
| Name | X(60) | | | | Lienholder Name |
| Address1 | X(30) | | | | Lienholder Address 1 |
| Address2 | X(30) | | | | Lienholder Address 2 |
| City | X(30) | | | | Lienholder City |
| State | X(2) | | | | Lienholder State |
| Zip | X(10) | | | | Lienholder ZIP Code |
| Verifed | Boolean | | | True False | |
| Preferred | Boolean | | | True False | |
| StatementType | X(2) | | | | Statement Type |
| LienTypeCode | X(4) | | | | Lienholder Type Code |
| LienHolderGroupN umber | X(18) | | | | Lienholder Group Number |
Sample GetLienholders SOAP Response#
<soap:Envelope>
<soap:Body>
<GetLienholdersResponse>
<GetLienholdersResult>
<ResponseCode>0</ResponseCode>
<Messages/>
<Lienholders>
<Lienholder>
<Name>string</Name>
<Number>string</Number>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Verified>boolean</Verified>
<Preferred>boolean</Preferred>
<StatementType>string</StatementType>
<LienTypeCode>string</LienTypeCode>
<LienHolderGroupNumber>string</LienHolderGroupNumber>
</Lienholder>
</ Lienholders>
</GetLienholdersResult>
</GetLienholdersResponse>
</soap:Body>
</soap:Envelope>
Error Messages#
| | |
|---|
| Message Type | Error code | Message Text |
| Error | rfvTPACode | TPA Code is required. |
| Error | VD0003 | TPA is invalid. |
| Error | VD0009 | Authentication Failed. You do not have necessary permission to execute this web method. |
| Error | | Lien Holder does not exist. |
| Error | | Invalid input in Verified. |
| Information | | Lien Holder not found |
| Information | NoRecordFound | No records found |
Modified at 2026-09-08 21:56:33
