ExecuteRequest service

You use the ExecuteRequest service to run a process configuration. This returns an overall result and, if specified, the detailed information behind the result. The exact details returned are determined by which version of the WSDL you are using and the data sources you are licensed to use.

Inputs

To run a process configuration, you must supply:

• Process configuration reference - this is the name or the ID of the process configuration you want to run. You can use the FindProcessConfiguration service to find the process configuration you want to use.

• Response type - use this to specify what information you want returned, this must be Decision Only, Summary or Detail
• Consent - set this to Yes if you have consent to carry out this check or No if you do not have consent.

• basic personal details, which are the forename and surname.

The remaining details you need to supply are determined by your process configuration. Use the ListFieldOptionality service to determine the fields that are mandatory, optional and not used for your specific process configuration. Optional fields will be checked if you supply them.

Soap request message

This example request message runs a process configuration that checks whether the client is over 16 and that their bank details are valid.

<soapenv:Body> <ns:ExecuteRequest> <eih:EIHHeader> <eih:ClientUser>User</eih:ClientUser> <eih:ReferenceId>123</eih:ReferenceId> </eih:EIHHeader> <ns:ProcessConfigReference> <ns:ProcessConfigName>Over16</ns:ProcessConfigName> </ns:ProcessConfigReference> <ns:ResponseType>Detail</ns:ResponseType> <ns:Consent>Yes</ns:Consent> <ns:PersonalData> <ns:Name> <ns:Title>Miss</ns:Title> <ns:Forename>Heather</ns:Forename> <ns:MiddleName>M</ns:MiddleName> <ns:Surname>Long</ns:Surname> </ns:Name> <ns:Gender>Female</ns:Gender> <ns:BirthDate>1957-07-04</ns:BirthDate> </ns:PersonalData> <ns:Addresses> <ns:Address> <ns:AddressDetail> <ns:HouseNumber>1</ns:HouseNumber> <ns:Address1>Albert Terrace</ns:Address1> <ns:Address2>Drakewells</ns:Address2> <ns:Address3>Gunnislake</ns:Address3> <ns:Address4>Cornwall</ns:Address4> <ns:PostCode>PL18 9DU</ns:PostCode> <ns:Country>GB</ns:Country> </ns:AddressDetail> <ns:TypeOfAddress>UK</ns:TypeOfAddress> <ns:AddressStatus>Current</ns:AddressStatus> </ns:Address> </ns:Addresses> <ns:BankInformation> <ns:AccountReference> <ns:ReferenceIndex>1</ns:ReferenceIndex> <ns:Reference>070116</ns:Reference> <ns:TypeOfReference>Bank Branch Code</ns:TypeOfReference> </ns:AccountReference> <ns:AccountReference> <ns:ReferenceIndex>2</ns:ReferenceIndex> <ns:Reference>00105688</ns:Reference> <ns:TypeOfReference>Account Number</ns:TypeOfReference> </ns:AccountReference> <ns:AccountSetupDate>2003-06-05</ns:AccountSetupDate> <ns:CheckContext>Direct Debit</ns:CheckContext> <ns:OwnerType>Single</ns:OwnerType> </ns:BankInformation> </ns:ExecuteRequest> </soapenv:Body>

Outputs

The results from this service are returned in the ProcessConfigReponse structure and contain:

• DecisionHeader - this is always returned and shows the overall result. This includes:
• ID of the process configuration run
• unique reference number (used to access related audit log items and reports)
• identity check decision - this is one of Authenticated, Not authenticated and Refer
• authentication text
• rule triggered - this is the name of the rule that triggered the overall response, or Default return if the overall response is the default response. If you want to know the details of the rule, talk to your account manager.
• ProcessConfigResultBlock - this is only returned if you set the response type to Summary or Detail and includes the following (depending on the checks performed by the process configuration):
• EIVResultBlock - this includes identity check result messages and the HRP count and returned HRP policy rules
• EIVMessageBlock - the code and message for all of the messages returned by the EIV check
• EIAResultBlock - this includes the authentication index (0 - 99), the authentication results and messages

If you are using later versions of the WSDL, this can also include the age match results, verification and validation scores, telephone results, CIFAS results, PEP sanctions results and the EIAResults block.

If you are using a template configured in earlier version of Identity Hub (2.1 or earlier), authentication index descriptive text may also be returned.

The EIAResult block includes for each type of match (name and address, current address, previous address, name and date of birth)

• number of primary and secondary data item matches
• number of primary and secondary data source matches
• number of primary and secondary categories
• oldest match date for primary and secondary data
• if you are configured to receive granular data, this data is also broken down for each data category.
• EIAMessageBlock - the code and message for all of the messages returned by the EIA check
• BWAResultBlock - this is the account verification results
• BWAMessageBlock - the code and message for any conditions returned by the bank account check
• AVSCVVResultBlock - this includes the overall card result, the AVS address result, the AVS post code result, the CVV result and the condition returned by the AVS/CVV check.
• AVSCVVMessageBlock - the code and message for all of the messages returned by the AVS/CVV check
• PassportResultBlock - this returns the overall result (Pass or Fail), and the individual results of the following checks; length, nationality, document number, date of birth, gender and expiry date
• PassportMessageBlock - the code and message for all of the messages returned by the Passport check
• DrivingLicenceResultBlock - this returns the overall result (Pass or Fail), and the individual results of the following checks; length, surname, date of birth, and initials
• DrivingLicenceMessageBlock - the code and message for all of the messages returned by the Driving Licence check.

Soap response message

This example response returns a Refer result and includes the granular data.

<env:Body> <eih:ProcessConfigResponse> <header:EIHHeader> <header:ClientUser>User</header:ClientUser> <header:ReferenceId>123</header:ReferenceId> </header:EIHHeader> <eih:DecisionHeader> <eih:UniqueReferenceNo>1121596539</eih:UniqueReferenceNo> <eih:AuthenticationDecision>Refer</eih:AuthenticationDecision> <eih:AuthenticationText>Caution. One or more conditions have been returned that apply to this request based on the rules implemented in the selected query.</eih:AuthenticationText> <eih:RuleTriggered>ReferAuthenticationIndex</eih:RuleTriggered> </eih:DecisionHeader> <eih:ProcessConfigResultsBlock> <eih:EIAResultBlock> <eih:CaseReference>WLLNQAEV72</eih:CaseReference> <eih:AuthenticationIndex>20</eih:AuthenticationIndex> <eih:ValidationScore>+0000</eih:ValidationScore> <eih:VerificationScore>+0538</eih:VerificationScore> <eih:TelephoneResults> <eih:HomeTelephoneNumber>Tel:Not Found</eih:HomeTelephoneNumber> </eih:TelephoneResults> <eih:AgeResults> <eih:AgeDOBMatch>3</eih:AgeMatch> <eih:AgeRange>30-39</eih:AgeRange> </eih:AgeResults> <eih:EIAResults> <eih:IDandLocDataAtCL> <eih:NumPrimDataItems>0</eih:NumPrimDataItems> <eih:NumPrimDataSources>0</eih:NumPrimDataSources> <eih:StartDateOldestPrim>2012-3</eih:StartDateOldestPrim> <eih:NumPrimDataCategories>0</eih:NumPrimDataCategories> <eih:NumSecDataItems>0</eih:NumSecDataItems> <eih:NumSecDataSources>0</eih:NumSecDataSources> <eih:StartDateOldestSec>2014-10</eih:StartDateOldestSec> <eih:NumSecDataCategories>1</eih:NumSecDataCategories> <eih:CategoryData> <eih:CategoryType>Primary</eih:CategoryType> <eih:CategoryText>Unsecured Loan</eih:CategoryText> <eih:NumCatDataSources>1</eih:NumCatDataSources> <eih:NumCatDataItems>1</eih:NumCatDataItems> <eih:StartDateOldestCat>201410</eih:StartDateOldestCat> </eih:CategoryData> </eih:IDandLocDataAtCL> <eih:LocDataOnlyAtCLoc> ... </eih:LocDataOnlyAtCLoc>/eih:NumSecDataSources> <eih:IDandLocDataAtPL> ... </eih:IDandLocDataAtPL> <eih:LocDataOnlyAtPLoc> ... </eih:LocDataOnlyAtPLoc> <eih:DataMatchCounts> <eih:NumAgeMatchesToPrimSource>0</eih:NumAgeMatchesToPrimSource> <eih:NumAgeMatchToSecSource>0</eih:NumAgeMatchToSecSource> <eih:NumTimeAtCLMtchPrimSource>0</eih:NumTimeAtCLMtchPrimSource> <eih:NumTimeAtCLMatchSecSource>0</eih:NumTimeAtCLMatchSecSource> </eih:DataMatchCounts> <eih:ReturnedHRPCount>1</eih:ReturnedHRPCount> <eih:ReturnedHRP> <eih:HighRiskPolRuleID>U131</eih:HighRiskPolRuleID> <eih:HighRiskPolRuleText>Applicant name found on the Basic Sanctions File</eih:HighRiskPolRuleText> </eih:ReturnedHRP> <eih:Velocity/> <eih:NameAndDobData> <eih:PrimaryMatches> <eih:NumDataItems>20</eih:NumDataItems> <eih:NumDataSources>3</eih:NumDataSources> <eih:OldestDataItem>201203</eih:OldestDataItem> <eih:NumCategories>8</eih:NumCategories> </eih:PrimaryMatches> <eih:SecondaryMatches> <eih:NumDataItems>0</eih:NumDataItems> <eih:NumDataSources>0</eih:NumDataSources> <eih:OldestDataItem>0</eih:OldestDataItem> <eih:NumCategories>0</eih:NumCategories> </eih:SecondaryMatches> <eih:CategoryData> <eih:CategoryType>Primary</eih:CategoryType> <eih:CategoryText>Unsecured Loan</eih:CategoryText> <eih:NumCatDataSources>2</eih:NumCatDataSources> <eih:NumCatDataItems>3</eih:NumCatDataItems> <eih:StartDateOldestCat>201310</eih:StartDateOldestCat> </eih:CategoryData> <eih:CategoryData> ... </eih:CategoryData> </eih:NameAndDobResults> </eih:EIAResults> <eih:Cifas> <eih:CifasCount>0</eih:CifasCount> </eih:Cifas> <eih:PepSanctions> <eih:PepSanctionCount>2</eih:PepSanctionCount> <eih:PepSanctionsDetails> <eih:PepSanctionsTitle>MR</eih:PepSanctionsTitle> <eih:PepSanctionsFirstName>Name</eih:PepSanctionsFirstName> <eih:PepSanctionsMiddleName>D</eih:PepSanctionsMiddleName> <eih:PepSanctionsLastName>Surname</eih:PepSanctionsLastName> <eih:PepSanctionsNameType>INDIVIDUAL</eih:PepSanctionsNameType> <eih:PepSanctionsInitialDate>20121014</eih:PepSanctionsInitialDate> <eih:PepSanctionsUpdateDate>20130314</eih:PepSanctionsUpdateDate> <eih:PepSanctionsText>Central Intelligence Agency (CIA) - Heads of State/Government;</eih:PepSanctionsText> </eih:PepSanctionsDetails> ... </eih:PepSanctions> </eih:EIAResultBlock> <eih:BWAResultBlock> <eih:NameScore>7</eih:NameScore> <eih:AddressScore>9</eih:AddressScore> <eih:AccountOpenDateScore>9</eih:AccountOpenDateScore> <eih:OwnerTypeResult>Match</eih:OwnerTypeResult> <eih:AccountStatus>Match</eih:AccountStatus> </eih:BWAResultBlock> </eih:ProcessConfigResultsBlock> </eih:ProcessConfigResponse> </env:Body>

See also

• executeRequest message
• Account verification results
• Client error messages
• Identity check results
• Available services
• ExecuteRequest structures
• ProcessConfigResponse structures