> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eftsureinsided365fo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Registering API Keys for Eftsure Inside D365 F&O

> How to register and configure API keys for government code and maps providers — VIES, HMRC, ABN, NZBN, UEN, TIN, Google Maps, Mapbox, and Azure Maps.

Eftsure inside D365 connects to a range of external services to support government code lookups, address autocomplete, and map visualisation. Before any of these features work, you need to obtain an API key from the relevant provider and paste it into your Eftsure parameters. This page walks you through registering a key for each supported provider.

You can configure three independent service categories in Eftsure parameters: **Gov Codes**, **Maps**, and **Places autocomplete**. You may use any combination of providers across these categories, though it is practical to choose a single provider for all map-related services.

<Note>
  This guide covers the minimum steps to obtain and configure an API key. For advanced key management, restrictions, and security settings, refer to each provider's own documentation.
</Note>

***

## Government code APIs

### VIES (Europe)

<Steps>
  <Step title="Create an account">
    Sign up or sign in at [https://viesapi.eu/sign-in/](https://viesapi.eu/sign-in/).
  </Step>

  <Step title="Purchase a plan">
    Go to **Plan details** and select the appropriate subscription plan.
  </Step>

  <Step title="Generate an API key">
    Go to **API Keys** and click **Generate new key**.
  </Step>

  <Step title="Configure in D365">
    Copy the identifier and key, then paste them into **Eftsure parameters → GovCode → Europe → VIES**.
  </Step>
</Steps>

***

### HMRC (United Kingdom)

<Steps>
  <Step title="Create a developer account">
    Register at the [HMRC Developer Hub](https://developer.service.hmrc.gov.uk/api-documentation/docs/using-the-hub).
  </Step>

  <Step title="Create a new application">
    In the developer hub, create a new application to hold your credentials.
  </Step>

  <Step title="Generate a client ID and secret">
    Create a client ID and secret, then subscribe the application to **Check a UK VAT Number**.
  </Step>

  <Step title="Configure in D365">
    Paste the client ID and secret into the HMRC configuration field in **Eftsure parameters → GovCode → United Kingdom**.
  </Step>
</Steps>

***

### ABN (Australia)

<Steps>
  <Step title="Accept the web services agreement">
    Go to [https://abr.business.gov.au/Tools/WebServicesAgreement](https://abr.business.gov.au/Tools/WebServicesAgreement) and accept the terms and conditions.
  </Step>

  <Step title="Complete your registration">
    Fill in your organisation's registration details and submit.
  </Step>

  <Step title="Wait for validation">
    Your registration will be validated within 24–48 hours. The ABR will send a notification email with your registration GUID once approved.
  </Step>

  <Step title="Configure in D365">
    Enter the GUID in **Eftsure parameters → GovCode → Australia → ABR**. Also set your preferred **ABN formatting** style (with or without spaces).
  </Step>
</Steps>

<Note>
  ABN Registry API access is free after registration and is one of the easiest providers to set up.
</Note>

***

### NZBN (New Zealand)

<Steps>
  <Step title="Log in to the portal">
    Go to [https://portal.api.business.govt.nz/](https://portal.api.business.govt.nz/) and log in.
  </Step>

  <Step title="Subscribe to the NZBN product">
    Navigate to [https://portal.api.business.govt.nz/product#product=nzbn](https://portal.api.business.govt.nz/product#product=nzbn) and click the **Subscribe** button.
  </Step>

  <Step title="Sign and return the access agreement">
    Go to [Terms and Conditions](https://support.api.business.govt.nz/s/article/terms-and-conditions), download the MBIE API Access Agreement, sign it, and return the signed copy by email as instructed.
  </Step>

  <Step title="Retrieve your API key">
    Once your subscription is approved, your API keys will be available in your subscriptions list on the portal.
  </Step>

  <Step title="Configure in D365">
    Paste the key into **Eftsure parameters → GovCode → New Zealand → NZBN**.
  </Step>
</Steps>

***

### UEN (Singapore)

The UEN service is provided by ACRA ([www.acra.gov.sg](https://www.acra.gov.sg)) and uses OAuth 2.0 with token generation. You must purchase a query package before using the service.

<Steps>
  <Step title="Subscribe to the Entity Information Query APIs">
    Go to [https://www.bizfile.gov.sg/apimarketplace](https://www.bizfile.gov.sg/apimarketplace) and subscribe to the Entity Information Query APIs.
  </Step>

  <Step title="Purchase a query package">
    Select and purchase the appropriate query package for your usage volume.
  </Step>

  <Step title="Create a production application">
    Return to bizfile and configure a new application for the production environment. Click **Create app**.
  </Step>

  <Step title="Generate OAuth credentials">
    Generate a new OAuth client ID and secret for the application.
  </Step>

  <Step title="Configure in D365">
    Enter the client ID and secret in **Eftsure parameters → GovCode → Singapore → UEN**. You can also monitor your remaining query credits from this screen.
  </Step>
</Steps>

***

### TIN (United States)

The TIN service is provided by EINSearch ([einsearch.com](https://einsearch.com)).

<Steps>
  <Step title="Purchase a token">
    Purchase a token from [https://einsearch.com/pricing/](https://einsearch.com/pricing/).
  </Step>

  <Step title="Configure in D365">
    Enter your token on the dedicated TIN configuration page in **Eftsure parameters → GovCode → United States of America → TIN**.
  </Step>
</Steps>

***

## Maps APIs

Eftsure supports three maps providers: **Google Maps**, **Mapbox**, and **Azure Maps**. These services power address autocomplete and map visualisation features across the product.

<Warning>
  Bing Maps is deprecated and has been removed as of release 5.45.47.1837. It has been replaced by **Azure Maps**. If you are currently using Bing Maps, migrate to Azure Maps or another supported provider.
</Warning>

You can mix providers across the three map service types — **Maps display**, **Places autocomplete**, and **Geocoding** — though using a single provider for all three simplifies configuration and billing.

***

### Google Maps

Google Maps uses three separately enabled APIs that can be activated independently:

| API                     | Purpose                                              |
| ----------------------- | ---------------------------------------------------- |
| **Maps JavaScript API** | Displays interactive maps in the D365 user interface |
| **Places API**          | Powers international address autocomplete            |
| **Geocoding API**       | Converts addresses into geographic coordinates       |

<Steps>
  <Step title="Open Google Cloud Console">
    Go to [https://console.cloud.google.com/](https://console.cloud.google.com/) and log in with a Google account.
  </Step>

  <Step title="Create or select a project">
    Create a new project or select an existing one to hold the API key.
  </Step>

  <Step title="Enable the required APIs">
    Navigate to **API & Services → Enable APIs and services** and enable whichever of the three APIs you need: **Maps JavaScript API**, **Places API**, and/or **Geocoding API**.
  </Step>

  <Step title="Create credentials">
    Go to **Credentials** and select **Create Credentials → API Key**.
  </Step>

  <Step title="Configure in D365">
    Copy the generated key and paste it into **Eftsure parameters** under the relevant Maps or Places section.
  </Step>
</Steps>

For billing details, see [Google Maps billing documentation](https://developers.google.com/maps/billing-and-pricing/billing#dynamic-maps).

***

### Mapbox

Mapbox is an American online map provider and is currently permitted in China, making it a useful option for organisations operating in that region.

<Steps>
  <Step title="Log in to Mapbox">
    Go to [https://account.mapbox.com/](https://account.mapbox.com/) and sign in.
  </Step>

  <Step title="Create a token">
    Click **Create a token**, enter a name for the token, and leave all other settings at their defaults. Click **Create token**.
  </Step>

  <Step title="Configure in D365">
    Copy the token and paste it into **Eftsure parameters** under the Mapbox configuration field.
  </Step>
</Steps>

***

### Azure Maps

Azure Maps uses **Shared Key Authentication** (also called a subscription key). Microsoft recommends rotating your keys regularly — two keys are provided so you can keep one active while regenerating the other.

<Steps>
  <Step title="Create an Azure Maps account">
    Log in to [https://portal.azure.com](https://portal.azure.com) and create an Azure Maps account.
  </Step>

  <Step title="Copy the shared key">
    Navigate to **Settings → Authentication** on the Azure Maps account and copy the **Primary Key** (or Secondary Key) from the **Shared Key Authentication** section.
  </Step>

  <Step title="Configure in D365">
    Paste the key into **Eftsure parameters** under the Azure Maps configuration field.
  </Step>
</Steps>

<Tip>
  When you regenerate an Azure Maps key, update the matching key in Eftsure parameters promptly to avoid service interruptions.
</Tip>


## Related topics

- [Release Notes — Eftsure inside D365 FO (2024–2025)](/help/release-notes.md)
- [Frequently Asked Questions — Eftsure inside D365 FO](/help/faq.md)
- [Supplier Communication Tools in Eftsure Inside D365 FO](/user/supplier-communication.md)
- [Eftsure Users, Roles, and Duties Setup for D365 F&O](/admin/users-and-roles.md)
- [Eftsure inside Dynamics 365 FO: Payment Fraud Prevention](/introduction.md)