W2 Data Credit Check Uk 007 Service

A credit check service for the UK

 

Query Data    

The following QueryData elements pertain to this service.     

Property Name Type Length Optional/Mandatory Notes
Forename
String
15 Mandatory  
MiddleNames
String
15 Optional  
Surname
String
30 Mandatory  
DayOfBirth
Integer
2 Optional  
MonthOfBirth
Integer
2 Optional  
YearOfBirth
Integer
4 Optional  
HouseName
String
26 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber
String
26 Mandatory if no HouseNameNumber or HouseName given  
HouseNameNumber 
String
26 Mandatory if no HouseNumberor HouseName given  
City
String
100 Optional  
Postcode
String
8 Mandatory Must be a valid UK postcode

 

Request

The following is an example request:   

<QueryData>
<City>Crawley</City>
<DayOfBirth>31</DayOfBirth>
<Forename>Billy</Forename>
<HouseNameNumber>68</HouseNameNumber>
<MonthOfBirth>12</MonthOfBirth>
<Postcode>RH13 3HE</Postcode>
<Surname>Jones</Surname>
<YearOfBirth>1944</YearOfBirth>
</QueryData>

Response

The following shows the basic schema for the <CreditCheckResult> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object.   

<CreditCheckResult>
<Characteristics>
{
<Characteristic>
{
<Code>
{ A characteristic code }
</Code>
<Value>
{ A characteristic value }
</Value>
}
</Characteristic>
}
</Characteristics>
<InterpretResult>
{
NotPerformed | Pass | Fail | Refer |
NotApplicable | NoInterpretPerformed
}

</InterpretResult>
<Message>
{ A message containing additional information about the call }
</Message>
<Scores>
{
<Score>
{
<Positive>
{ Whether the score value is a positive or negative one }
</Positive>
<ScoreLabel>
{ A score name }
</ScoreLabel>
<Value>
{ A score value }
</Value>
}
</Score>
}
</Scores>
<TransactionResult>
{
None | Success | SuccessNoResults | SuccessIncompleteResults |
MultipleChoices | ClientErrorInformationFormatInvalid | ClientErrorInsufficientInformation |
NotExecutedDueToPreviousHalt | ServerErrorGeneralError | ServiceFailureError
}

</TransactionResult>
<CreditCheckResult/>

Example Response:

The below example shows a case where we have found one NameAndAddress match.

<CreditCheckResult>
<Characteristics>
<Characteristic>
<Code>QSC042</Code>
<Value>H</Value>
</Characteristic>
<Characteristic>
<Code>QSP042</Code>
<Value>H</Value>
</Characteristic>
<Characteristic>
<Code>QSC068</Code>
<Value>M</Value>
</Characteristic>
<Characteristic>
<Code>QSE070</Code>
<Value>T</Value>
</Characteristic>
</Characteristics>
<InterpretResult>NoInterpretPerformed</InterpretResult>
<Message>Matches not checked</Message>
<Scores>
<EquifaxScore>
<Positive>true</Positive>
<ScoreLabel>RNILF04</ScoreLabel>
<Value>302</Value>
</EquifaxScore>
<EquifaxScore>
<Positive>true</Positive>
<ScoreLabel>PDILF04</ScoreLabel>
<Value>155</Value>
</EquifaxScore>
<EquifaxScore>
<Positive>true</Positive>
<ScoreLabel>FTILF04</ScoreLabel>
<Value>276</Value>
</EquifaxScore>
</Scores>
<TransactionResult>Success</TransactionResult>
</CreditCheckResult>

Transaction Result

HaltTriggered Usually false, but can be true if this service is used within a bundle that can trigger a halt condition.
ServiceTransactionResult
  • Success
  • SuccessIncompleteResults Too many matches on the search criteria and the results have been truncated
  • SuccessNoResults No matches found
  • ServerErrorGeneralError An error occurred
  • ServiceFailureError- Unable to contact third party service
  • ClientErrorInsufficientInformation Required field not supplied or insufficient/invalid information
ServiceInterpretResult
  • Pass
  • Fail
  • Refer
  • NoInterpretPerformed
  • NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult
  • Pass
  • NotPerformed - No search occurred to match against
  • Fail MissingMandatoryField or PatternNotMatched

Sandbox mode can be used to test the service. By setting the following query option and sending some the below query data we will return a pre-configured response without actually calling our suppliers.

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

If the Sandbox query option is set to "true" then the following queries will return results. The result of the verification will depend on the configuration of the matching set up during the on-boarding process.  

Forename Surname Day Of Birth Month Of Birth Year Of Birth House Number Postcode Result
JAYMIE WOOD 18 4 1980 1814 CB6 1AU No Matches Found
MW FORREST 12 9 1968 68 CB6 1AS Full characteristic set