Enrichment

By combining the output variables of our EDQ Address Validation component with Salesforce's HTTP Callout action it is possible to configure a Screen Flow which allows users to validate an address and then enrich that address with additional data by calling out to our Experian Enrichment API to help you gain additional insight.

Authenticating the HTTP Callout Action

Before you configure an HTTP Callout action within Flow Builder, you must set up a named credential to authenticate calls to the external system, in this case our Experian Enrichment API. Salesforce's documentation for Using API Keys with Named Credentials covers all the general details, but we've provided instructions specific to our API below:

Configure the HTTP Callout action

Let's assume you already have a Screen Flow configured with a Screen element containing our EDQ Address Validation component, as per the earlier instructions in this documentation. The next step is to configure the HTTP Callout action which will POST to the Experian Enrichment API.

1. Click the + icon after the Screen element of your Flow containing the EDQ Address Validation component and add an Action element.

   

2. Click the Create HTTP Callout button at the very bottom of the panel on the right.

3. Enter a name of your choice, select the Named Credential you created in the steps above and click Next.

   

4. Enter a Label of Get Enriched Data and select POST as the Method. URL Path should be left blank.

   

5. Click Next and on the next screen paste a sample JSON request. These can be obtained from the API specification for the Experian Enrichment API. Below is an example for the Global Geocodes dataset:

   {
       "country_iso": "USA",
       "keys": {
           "global_address_key": "aWQ9NDc1IEFudG9uIEJsdmQsIENvc3RhIE1lc2EgQ0EgOTI2MjYsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXw0NzUgQW50b24gQmx2ZHx8Q29zdGEgTWVzYSxDQSw5MjYyNi03MDM3fmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRpZD02YzJkN2RkNC05YzEzLTQ3YWUtYWZiYi0yZWMyYjEyNGE2NDVfVTQwXzI0XzBfMF8wPTQ3NX5xbD0yM35nZW89MA"
       },
       "attributes": {
           "geocodes": [
               "latitude",
               "longitude",
               "match_level"
           ]
       }
   }
   

6. Click the Review button and then the Next button.

7. On the Select Sample Response Method screen select Connect for Schema and then click Next.

   

8. On the Connect with Sample Response screen scroll down and click the Connect button. Review the Data Structure and then click Save.

   

9. Flow Builder creates the action and external service and displays the edit action panel.

10. Give the new Action element a Label and the API Name will be populated automatically.

    

11. Under Set Request Body, click into the body value field and select + New Resource.

12. Enter an API name for the new resource, e.g. Enrichment_Request_Body. The other mandatory fields are automatically populated for you.

    

13. Click Done.

14. The body value is populated for you and you can click Save in the header to save the HTTP Callout action.

Assign values to variables in the Enrichment API request

Having configured the HTTP Callout action with knowledge of the format of the request body, we now need to assign values to that request body from the output of the EDQ Address Validation component in the previous Screen element as well as specify which Enrichment attributes you want to request.

1. Click the + icon directly after the Screen element of your Flow containing the EDQ Address Validation component and before the HTTP Callout Action, and add an Assignment element.

2. The New Assignment panel will appear on the right of Flow Builder. Give the assignment a Label of Enrichment Request Body Assignment and the API Name will be populated automatically.

3. Set the variable values. There are two required variables and beyond that the variables needed will depend on the Enrichment dataset attributes required. In the case of Global Geocodes you could include latitude, longitude and match_level.

   

4. Set the first variable to be the ISO Country Code of the request which comes from the validated address. Under APEX-DEFINED VARIABLES select Enrichment_Request_Body > countryx5fiso. Leave Operator as Equals. For Value, under SCREEN COMPONENTS select EDQ_Address > countryCode3. Note that the screen component may be different depending on the API name for the component in your specific flow.

5. Click + Add Assignment and set the second variable to be the Global Address Key. Under APEX-DEFINED VARIABLES select Enrichment_Request_Body > keys > globalx5faddressx5fkey. Leave Operator as Equals. For Value, under SCREEN COMPONENTS select EDQ_Address > globalAddressKey.

6. Click + Add Assignment and set the third variable to be the first attribute you want to request from the Enrichment API. If we continue the example here for Global Geocodes, this could be the latitude. Under APEX-DEFINED VARIABLES select Enrichment_Request_Body > attributes > geocodes. Set Operator to Add as we're constructing an array. For Value, latitude.

7. Repeat the previous step as required for the attributes you need.

8. Click Save in the top right and close the New Assignment panel.

Display the Enrichment API response

This is very much an optional step, but is included to allow you to test the process by displaying the results that come back in the response from the Enrichment API.

1. Click the + icon after the Action element of your Flow that performs the HTTP Callout and add a Screen element.

2. Add Text components to the screen for each response attribute you want to see and set their Default Value to the Outputs of HTTP Callout, e.g. {!Enrichment_API_HTTP_Callout.2XX.result.geocodes.latitude}.

   

3. Click Done.

4. Debug your flow and test it works as expected.