Set up your Smarty API Keys

Smarty provides address autocomplete and address verification for the United States and for more than 240 other countries. Address Validation for Dataverse uses your own Smarty account: you enter your Smarty keys in Dataverse, and Smarty bills your account directly. This article explains which Smarty keys you need and how to enter them.

Before you start

• A Smarty account (smarty.com) with a subscription for each Smarty product you plan to use. Smarty sells US and international services separately:
  • US Address Autocomplete and/or International Address Autocomplete, for the autocomplete control on your forms.
  • US Address Verification and/or International Address Verification, for workflows and Power Automate.
  • Optionally, international geocoding if you want latitude and longitude for addresses outside the United States. US verification always includes coordinates.
• An Address Validation license that includes the Smarty add-on. Without it, the autocomplete control shows a license message.

You need two kinds of key

Smarty issues two kinds of key, and Address Validation uses both:

Each API Configuration record holds one key, so you create two API Configuration records if you use both autocomplete and verification.

Step 1: Get your keys from Smarty

1. Sign in to your Smarty account and open the API Keys page.
2. Under Embedded Keys, create a key or use an existing one, and add your Dataverse environment's host name to its authorized hosts, for example contoso.crm.dynamics.com (without https://).
   • Each environment has its own host name. Add every environment that uses the control, for example your development, test and production environments.
   • A wildcard such as *.crm.dynamics.com covers every environment in that region, but not the bare domain. The region part of the host name varies, for example crm3 for Canada and crm4 for Europe.
3. Copy the embedded key.
4. Under Secret Keys, copy the Auth ID and the Auth Token. Keep the Auth Token private: Smarty treats disclosing it as a breach of its terms.

[Screenshot placeholder: Smarty API Keys page showing an embedded key with its authorized hosts, and the Secret Keys section. Blur all key values.]

Step 2: Create the API Configuration records

1. In the Address Validation for Power Apps app, go to Settings > API Configuration.
2. Create a record for the autocomplete control:
   • API Config Name: a unique name, for example Smarty Autocomplete.
   • Validation Service Type: Smarty Api.
   • API Key: your embedded key.
3. Create a second record for verification:
   • API Config Name: for example Smarty Verify.
   • Validation Service Type: Smarty Api.
   • API Key: your Auth ID, a colon, then your Auth Token, with nothing else. For example: 8d497be5-e211-4949-a18f-0bfd1d9970d3:th4hargQiuyG7w7L7xfO (these are Smarty's documentation example values, not real keys). Do not type the words "AuthID" or "AuthToken".
4. Save each record. To log each Smarty call, set Save Transaction Logs to Yes; the details appear in Logs, under the Resources area.

[Screenshot placeholder: the "Smarty Verify" API Configuration record with Validation Service Type = Smarty Api. Blur the API Key.]

Address Validation protects the secret key: the autocomplete control will not load from a record that holds a secret key, and the verification steps will not use an embedded key. In both cases you get a message that says which key the record should hold.

Costs and limits

• Smarty bills per lookup, and each Smarty product has its own allowance.
• US Address Autocomplete counts every search request, including opening the list of units in a building. To keep this low, the control waits until the user has typed 3 characters and paused briefly before it searches.
• International Address Autocomplete counts one lookup when the user selects an address. Searching is not counted.
• Each verification uses one lookup. US verification includes latitude and longitude. International coordinates are returned only when you request them and your Smarty subscription includes international geocoding.
• Smarty limits how many autocomplete requests one user can send in a short time. For a busy team, add your office's public IP address to the embedded key in Smarty; requests from that IP address are not limited in the same way.
• Smarty also refuses the same address sent many times in a short period, to prevent runaway charges from a loop.

Your Smarty data

• You are Smarty's customer, under Smarty's own subscription agreement. Your keys stay in your Dataverse environment and are used only for your own records.
• Verified address data can be kept after your Smarty subscription ends. Some precise (rooftop) coordinates are licensed only for the term of your Smarty subscription; when such coordinates are returned, the verification details say so.
• US Address Autocomplete may only be used by people typing in a form, not by automated processes. For automated validation, use the verification steps in workflows or Power Automate.

Troubleshooting

Next steps

• Configure Smarty Autocomplete on Dataverse Forms
• Validate Addresses with Power Automate: Smarty (Unbound Action)
• Validate Addresses with Smarty in Dataverse Workflows