Rosetta SOAP Credit Enquiry Module
Equifax methods are described for historical information only. Experian is the currently supported soft search provider.
equifax_credit_enquiry
Performs an Equifax soft search on an existing proposal, using details already present on the prop.
equifax_credit_enquiry_application
Performs an Equifax soft search on a new applicant and creates a proposal with the customer's details and the search result.
equifax_credit_enquiry_band
Returns the dealer-defined band associated with a proposal that has already had an Equifax search performed.
equifax_credit_enquiry_get_details
Returns the full details of a previous Equifax search associated with a proposal.
experian_credit_enquiry
Performs an Experian soft search on an existing proposal.
experian_credit_enquiry_application
Performs an Experian soft search on a new applicant and creates a proposal with the customer's details and the search result.
Example request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="https://www.dealtrak123.co.uk/rosetta/webservices/credit_enquiry">
<soap:Body>
<tns:experian_credit_enquiry_application>
<request>
<title>1</title>
<firstname>Joe</firstname>
<lastname>Bloggs</lastname>
<date_of_birth>1997-01-16</date_of_birth>
<flat/>
<house_number>111</house_number>
<house_name/>
<street>Main Street</street>
<district/>
<towncity>Whoville</towncity>
<county/>
<postcode>WO12 3VV</postcode>
<authentication>
<username>your_api_id</username>
<password>your_api_password</password>
<user_id>123473</user_id>
<dealer_id>123459</dealer_id>
</authentication>
</request>
</tns:experian_credit_enquiry_application>
</soap:Body>
</soap:Envelope>
Example response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://www.dealtrak123.co.uk/rosetta/webservices/credit_enquiry">
<SOAP-ENV:Body>
<ns1:experian_credit_enquiry_applicationResponse>
<experian_credit_enquiry_applicationResult>
<application_id>736336</application_id>
<credit_enquiry>
<band>Poor</band>
<success_flag>1</success_flag>
<error xsi:nil="true"/>
<affordability_min xsi:nil="true"/>
<affordability_max xsi:nil="true"/>
</credit_enquiry>
</experian_credit_enquiry_applicationResult>
</ns1:experian_credit_enquiry_applicationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
The application ID may subsequenly be used in conjunction with load application to proceed to a full application.
Required inputs
| Element | Required | Description |
|---|---|---|
| request → title | Y | Customer's title, using the ID from the title enumeration |
| request → forename | Y | Customer's forename |
| request → middlename | N | Customer's middle name |
| request → surname | Y | Customer's surname |
| request → date_of_birth | Y | Customer's birth date in YYYY-MM-DD format |
| request → flat request → house_number request → house_name |
Y | Customer's flat number, house number or house name (minimum of one required) |
| request → street | Y | Customer's street name |
| request → district | N | Customer's district |
| request -> towncity | Y | Customer's town or city |
| request → county | N | Customer's county |
| request → postcode | Y | Customer's postal code |
| request → application_id | N | Existing proposal ID to perform a search on, but using different details |
| request → authentication → username | Y | API username |
| request → authentication → password | Y | API password |
| request → authentication → user_id | Y | User ID to associate the newly created proposal with (typically a dedicated "web leads" user) |
| request → authentication → dealer_id | Y | Branch ID to associate the newly created proposal with |
Response format
| Element | Description |
|---|---|
| response → application_id | The newly created proposal ID, which will be in "New Proposals" |
| response → credit_enquiry → band | One of: Very Poor / Poor / Fair / Good / Excellent |
| response → credit_enquiry → success_flag | 0 for an unsuccessful search, 1 for a successful search |
| response → error → code | The alphanumeric error code, if applicable |
| response → error → message | A human-readable error message |