Skip to main content

Capture Integration Wizard

Getting started

Experian Data Quality Capture Integration Wizard is a simple tool that lets you integrate email and address validation into your website in a few easy steps.

Create an integration in minutes

Login to the Self Service Portal and select Capture Integration Wizard under Products. You can follow the simple step-by-step tool to create your custom integration code in minutes. All you need is the source code from your webform* and you're good to get started!

Find out more about what happens to your webform after installation

* the final output HTML from your web page as rendered by a web browser, not any kind of programming framework code (eg. ASP.NET Razor, CSHTML, PHP)

Activate the integration by embedding JavaScript into your website

Once you have finished the integration wizard you will be given one-line of JavaScript code. Copy-paste this code into the source code of the webpage that contains your form, save your page, and you're all done. It might take a few minutes for the integration to activate on your page.

Read developer notes for the best practice webform setup.

Test your integration

Once your integration is all set up, we recommend that you test the integration to ensure that your product is working as expected.

Use our test examples to verify that your product(s) are working correctly.

Style your integration

Once you are confident that the integration is working as expected, you can apply styling to the lightbox that pops up.

Get accurate data into your webform

Your Experian Data Quality integration will guide your customers through the address entry process, ensuring that a postally correct address or a valid email is entered into your webform. This allows you to gather clean, accurate contact data and avoids returned parcels and bouncing emails.

Your webform will validate or verify your customers’ contact data, prompting them to correct their entry if it’s not correct. See Validation responses for detailed information on the messages and validation workflows for each type of data.

What happens after integration?

The way that your website responds to the integration depends on the product(s) that you are using.

Address validation

Once your Address Validation integration is activated, a lightbox will pop up on your website when the customer enters an address field.

The specific workflow and look and feel of the lightbox varies depending on the country of the address that is entered. Select your country below to view the details.

If you're only validating addresses from a single country (UK or USA, for example), you don't need to design your webform in any particular way to make the most of our product capability. Just integrate address/email validation into your webform, and your license will determine which country's address validation to use.

USA and Canada only

The customer fills in their whole address in the address fields and clicks the submit button. If the address is verified as correct nothing happens and the customer continues their workflow as per usual. However, if the address requires user interaction, the Experian Data Quality address verification lightbox opens:

Depending on the elements that they have entered, the user may need to select the valid address from the lightbox. Once this is done, the postally correct address is returned to your webform.

Find out more about the validation responses.

United Kingdom only

As the customer enters the first address field, an address search popup window opens.

All address validation happens in this lightbox. Once the correct address has been retrieved, the postally-correct address is pasted back into the form. The customer can then enter the necessary information for their address, and the postally correct address is pasted back into your webform. The fields into which the address elements are returned depends on how you have set up your field mappings in the integration wizard.

Learn more about the validation responses.

Multi-country

If your customers tend to complete your webform in with addresses from multiple countries, and you have purchased more than one Experian Data Quality country datasets, your customers will get the best experience from our products if you follow these guidelines.

Design your webform in a way that the user specify the country first

If you have your customers specify their country before they enter the address, this optimises the address entry process for them.

Take a closer look

The expected way in which customers enter address details onto a webform largely depends on their country, or the country of the address being entered.

  • For example, it is standard practise on UK webforms for customers to only enter a house number and a postcode and to then perform some validation steps (such as selecting their specific address from a list of returned results, or entering sub-premise information manually) to retrieve their full address.
  • By contrast, US webforms usually require the full address, or at least several elements of their full address, to be entered before the customer submits the address for validation.

We recommend that you design your webform in such a way that the customer specifies their country before they enter in their address details. This means that Capture can optimize the workflow to adapt to standard validation practises for the specified country.

How does this affect the customer's workflow?

  • USA and Canada
    Address validation workflow is the same whether the country is selected before or after the address entry.
  • United Kingdom
    Address validation workflow depends on whether the country is selected before or after address entry, and whether a single country or a multi-country license is used.

Email validation

After the customer has filled in the email address field and leaves the field, the validation response is given as a pop-up dialog.

Find out more about the validation responses.

Testing your integration

Once your integration is all set up, we recommend you test it to ensure that it works as expected.

United Kingdom only

To activate address validation for United Kingdom addresses,

  1. If your webform contains a country selection list, select United Kingdom.
  2. Click on the first address field.
  3. Address validation lightbox will pop up.

The following table shows example addresses and the validation results they return:

Example addressValidation levelFinal address
35, de238lh Matched to a single address

35 Douglas Street
DERBY
DE23 8LH

18, eh105ly

Matched to multiple addresses

18/2 Morningside Drive
EDINBURGH
EH10 5LY

LA9 7ED Matched to multiple addresses

12 Garden Road
KENDAL
Cumbria
LA9 7ED

1 Fairfield Street

LEEDS

Matched to a single address

1 Fairfield Street
LEEDS
LS13 3DX

18 Morningside Drive

EDINBURGH

Matched to multiple addresses

18/2 Morningside Drive
EDINBURGH
EH10 5LY

 

Address validation

USA and Canada only

To activate address validation for USA and/or Canadian addresses,

  1. If your webform contains a country selection list, select United States or Canada.
  2. Enter your address into the webform.
  3. Click Submit.
  4. Address validation lightbox will pop up.
  5. The following table shows example addresses and the validation results they return:
Example address Validation level Final address
12 Dakota Drive
Zebulon
NC 27597
Verified address found 12 Dakota Dr
Zebulon
NC 27597-6670

200 Rodeo Drive
Beverly Hills
CA

 Match to multiple results found  200 N Rodeo Dr
Beverly Hills
CA 90210-5104
Rodeo Drive
CA
 Not enough information provided -
Rosemont Road
North Jackson
OH 44451-9631
 Property number not provided 350 Rosemont Rd
North Jackson
OH 44451-9631 
1825 South Main Street
Walnut Creek
CA 94595 
More than one apartment exists at provided address   1825 S Main St Apt A
Walnut Creek
CA 94595 
1664 Fyler Rd
Lot 1
NY
No city or ZIP information provided 1664 Fyler Rd Lot 1
Chittenango
NY 13037-9437

Email validation

To activate email validation:

  1. Enter the email address into your webform's email field.
  2. A validation response will display.

For data protection reasons we cannot provide real example email addresses for you to test with your integration. However, the table below contains some example email formats that you may be able to modify in order to return the expected verification levels. Simply replace name or surname and domain name with real examples.

Example email format  Validation level  Final address
name.surname@domain.com Verified   
name.surname@domain.co Undeliverable   
my.name@company.or Unreachable   
my.name@gmail.con Unreachable (corrected)  my.name@gmail.com
surname@gmail.org Illegitimate   
name.surname@gmail.co Illegitimate (corrected) name.surname@gmail.com
123@guerillamail.com  Disposable  

Applying custom styles

Once you have tested and are happy that your integration works as expected, you can modify the styling of the elements that Experian Data Quality products have added to your webpage by using Cascading Style Sheets (CSS).

What can I style?

CSS classes for Experian Data Quality HTML elements

The CSS classes that are needed to get you started are shown in this example CSS file. This is not an exhaustive list of all of the elements and their properties, but it includes the main elements to style your lightbox's look-and-feel to match your website.

You can copy the contents of the CSS file and paste them directly into your website's CSS file, or you can create a new style sheet, copy the contents into the new file, and import the CSS file into your main website's CSS file.

You must ensure that your custom CSS files are loaded after the Experian Data Quality CSS file, otherwise the dynamically loaded styles will override your own

The following table illustrates the interface elements the CSS classes correspond to.

Address validation

Element nameCSS classInterface element
Main dialog

edq-address-dialog

edq-address-dialog table

 
Title bar

edq-address-dialog-title-bar

edq-address-dialog-title-text

 
Prompt field edq-address-dialog-prompt-text  
Prompt field header text edq-address-dialog-header  
Prompt field link text

edq-address-dialog-link

edq-address-dialog-link:hover

 
Buttons edq-address-dialog .ui-button  
Input text edq-address-dialog-prompt-text table  
Input fields edq-address-dialog-prompt-text input  
Progress bar edq-address-dialog-wait-progress-bar  

Email validation

Element nameCSS classInterface element
Success icon edq-email-success  
Warning icon edq-email-warning  
Failure icon edq-email-failure  

If you want to make major changes to the lightbox behavior, you can use your browser's "inspect element" functionality to see all of the classes and use these to style the lightbox further.

Example CSS file

/* Experian Data Quality elements */
 
/* Address Validation lightbox classes. */
 
      /* Main dialog */
      .edq-address-dialog {
         border: 1px solid #000000;
         color: #595959;
         font-family: "OpenSansRegular",Arial,serif;
         font-size: 14px;
         line-height: 20px;
      }
 
      /* If you change the color for the above class, you must also change the color for this element. */
      .edq-address-dialog table {
         color: #595959;
      }
 
      /* Title bar */
      .edq-address-dialog-title-bar {
         background-color: #207cc6;
         background-image: linear-gradient(to bottom,#2898e7,#135395);
      }
 
      /* Title bar font color */
 
         .edq-address-dialog-title-text {
            color: #fff;
         }
 
      /* Prompt field */
      .edq-address-dialog-prompt-text {
         font-size: 14px;
      }
 
      /* Prompt field header text */
      .edq-address-dialog-header {
         background-color: #f5f5f5;
         border: 1px solid #e3e3e3;
      }
 
      /* Prompt field link text */
      .edq-address-dialog-link {
         color: #428bca;
      }
 
      /* Prompt field link text hover style */
      .edq-address-dialog-link:hover {
         color: #2a6496;
         text-decoration: underline;
      }
 
      /* Buttons */
      .edq-address-dialog .ui-button {
         background-color: #1370bd;
         background-image: linear-gradient(to bottom,#147ed6,#115b98);
         border: 1px solid #bbb;
         border-color: #4286c3;
         color: white;
      }
 
      /* Input text */
      .edq-address-dialog-prompt-text table {
         font-size: 14px;
         margin: 0;
         border: 0 none;
      }
 
      /* Input field */
      .edq-address-dialog-prompt-text input
      {
         border: 1px solid gray!important;
      }
 
      /* Address Validation progress bar */
      .edq-address-dialog-wait-progress-bar {
         background-image: url('images/progress-bar.gif');
         background-position: center;
         background-repeat: no-repeat;
         display: inline;
         height: 19px;
         padding-left: 25px;
         position: absolute;
         width: 85%;
      }
 
/* Email validation classes */
 
      /* If you wish to customize the icons used for Email Validate, add a background-image override to any of the following classes for which you wish to change the icon displayed to users when validation occurs. */
 
      .edq-email-success {
      }
 
      .edq-email-warning {
      }
 
      .edq-email-failure {
      }

Validation responses

The responses you can expect from the JavaScript code vary depending on the product you have integrated.

Address validation

USA and Canada only

The customer fills in their whole address in the address fields. When they click the submit button, the verification popup window opens. Depending on the elements that they have entered, they may need to select the valid address, and the postally correct address is returned.

The following diagram shows the responses that your customer can expect on your website once the integration has been activated.

United Kingdom only

As the customer enters the first address field, an address search popup window opens. The customer can then enter the necessary information for their address, and the postally correct address is pasted back into your webform. The fields into which the address elements are returned depends on how you have set up your field mappings in the integration wizard.

The following diagram shows the responses that your customer can expect on your website once the integration has been activated.

Email validation

After the customer has filled in the email address field and leaves the field, the validation response is given as a pop-up dialog.

The following diagram shows the responses that your customer can expect on your website once the integration has been activated. Click the image to enlarge it (opens in new window or tab).

The validation levels are:

Validation responseDescription
Verified  Mailbox exists, is reachable, and not known to be illegitimate or disposable
Undeliverable  Mailbox does not exist, or mailbox is full, suspended or disabled.
Unreachable  Domain does not exist or has no reachable mail exchangers.
Illegitimate  Seed, spamtrap, black hole, technical role account or inactive domain
Disposable  Domain is administered by a disposable email provider (e.g. Mailinator)
Unknown  We were unable to conclusively verify or invalidate this address.

Notes for developers

These notes are intended to provide users with web developer experience some extra information on how the integrations created using Capture Integration Wizard work so that they are able to modify their webform in order to give the best customer experience possible.

On the wizard step 2 “Your Form” I get an error “We couldn't find any form fields in your HTML. Please verify this and try again.”
The code that you have pasted in should be the output HTML from your web page as rendered by a web browser, not any kind of programming framework code (eg. ASP.NET Razor, CSHTML, PHP). It should contain the full HTML form element that you wish to add data validation to.

Should I map all of the fields on my web form?
On the “Step 3 – Mapping” section of the wizard it is best to map every field that is relevant to address / email validation. Regarding fields that are not relevant (eg. name, user id, passport number) it is best to set them ‘do not validate’.

How do the field mappings work? Why isn’t the wizard automatically detecting my input fields?
After entering the HTML code of your form on step 2 of the wizard, step 3 begins by the wizard trying to automatically detect which input fields correspond to what pieces of information. It does this by first looking for keywords in the id attribute values of the input elements, and if that fails it uses the name attribute values.

For example, if you have a field with an id of “input-postcode” it will automatically be deemed to be a text box that customers should enter their postcode in. If you have a field with an id of “00101010” but a name of “input-postcode”, it will still be automatically deemed to be a postcode field.

Therefore it's a good idea to give your input fields sensible, unique ids or names that correspond to the data that is to be entered into them. These automatic assignments can always be overridden manually in the integration setup wizard.

I have more than one country field on my web form, will this cause a problem?
A webform with a multi-country Capture Integration Wizard integration needs to know which country the user is currently entering data for, so it's necessary to have mapped a required country field. If you have two country fields on a form then only one of them should be mapped, and the other should be left as ‘do not validate’. Be aware that only information entered into the mapped field will be used to determine what country dataset to validate the data against.

Does it matter what types of values are in my country select list?
It's necessary to detect what country a user’s data pertains to in order to validate it correctly, and we have attempted to make Capture Integration Wizard flexible in terms of country detection. However, to guarantee that country detection happens smoothly, it's best if the value attributes of your "country select" list are valid ISO 3166-1 alpha 3 codes (eg. “GBR”, “USA”, “CAN”). These codes are easily obtainable on the Internet via a web search.

So I don’t need to handle country selection in any way?
No, you won't need to load anything extra, or redirect to a specific page or form based on what country is selected by the user. This is all handled for you as part of the integration.

Are there any circumstances in which no behavior will be observed by the user?
If, when entering data on your webform, the user selects a country that is not part of your integration (the countries that are part of your integration are detailed on the Capture Integration Wizard page that lists all of your integrations) then they will not encounter any change in behaviour from your web site’s normal workflow.

If your licence has expired or has run out of credits, then any validation that occurs will fail, but will do this gracefully without affecting the user’s experience. This does not apply to integrations whose only address validation country is the United Kingdom, because this workflow involves displaying a lightbox before any validation occurs.

What happens if the user doesn’t select a country, or the country is not known when the data validation is triggered?
We have the following order of preference for the available countries: USA, United Kingdom, Australia, France. So if your integration includes USA, then USA will always be assumed if the country is not known.

Can I customize the appearance of the pop-up lightboxes using my own CSS files?
Yes, but you must ensure that your custom CSS files are loaded after the Experian Data Quality CSS file, otherwise the dynamically loaded styles will override your own.

Does it matter how long the page takes to load? Will this affect the integration?
Only if you have UK address validation as a part of your integration.

When your website is accessed all of the content necessary for data validation must be fetched and loaded from the Content Delivery Network on which it is stored. If this does not complete before the user clicks in an address field, then no address validation lightbox will appear (despite the fact that a lightbox should appear if you have a UK address validation integration). All of our files are minified to reduce the chances of this happening as much as possible, but it is also a good idea to minify your own CSS and JavaScript as well.