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.
Government code APIs
VIES (Europe)
1
Create an account
Sign up or sign in at https://viesapi.eu/sign-in/.
2
Purchase a plan
Go to Plan details and select the appropriate subscription plan.
3
Generate an API key
Go to API Keys and click Generate new key.
4
Configure in D365
Copy the identifier and key, then paste them into Eftsure parameters → GovCode → Europe → VIES.
HMRC (United Kingdom)
1
Create a developer account
Register at the HMRC Developer Hub.
2
Create a new application
In the developer hub, create a new application to hold your credentials.
3
Generate a client ID and secret
Create a client ID and secret, then subscribe the application to Check a UK VAT Number.
4
Configure in D365
Paste the client ID and secret into the HMRC configuration field in Eftsure parameters → GovCode → United Kingdom.
ABN (Australia)
1
Accept the web services agreement
Go to https://abr.business.gov.au/Tools/WebServicesAgreement and accept the terms and conditions.
2
Complete your registration
Fill in your organisation’s registration details and submit.
3
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.
4
Configure in D365
Enter the GUID in Eftsure parameters → GovCode → Australia → ABR. Also set your preferred ABN formatting style (with or without spaces).
ABN Registry API access is free after registration and is one of the easiest providers to set up.
NZBN (New Zealand)
1
Log in to the portal
Go to https://portal.api.business.govt.nz/ and log in.
2
Subscribe to the NZBN product
Navigate to https://portal.api.business.govt.nz/product#product=nzbn and click the Subscribe button.
3
Sign and return the access agreement
Go to Terms and Conditions, download the MBIE API Access Agreement, sign it, and return the signed copy by email as instructed.
4
Retrieve your API key
Once your subscription is approved, your API keys will be available in your subscriptions list on the portal.
5
Configure in D365
Paste the key into Eftsure parameters → GovCode → New Zealand → NZBN.
UEN (Singapore)
The UEN service is provided by ACRA (www.acra.gov.sg) and uses OAuth 2.0 with token generation. You must purchase a query package before using the service.1
Subscribe to the Entity Information Query APIs
Go to https://www.bizfile.gov.sg/apimarketplace and subscribe to the Entity Information Query APIs.
2
Purchase a query package
Select and purchase the appropriate query package for your usage volume.
3
Create a production application
Return to bizfile and configure a new application for the production environment. Click Create app.
4
Generate OAuth credentials
Generate a new OAuth client ID and secret for the application.
5
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.
TIN (United States)
The TIN service is provided by EINSearch (einsearch.com).1
Purchase a token
Purchase a token from https://einsearch.com/pricing/.
2
Configure in D365
Enter your token on the dedicated TIN configuration page in Eftsure parameters → GovCode → United States of America → TIN.
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. 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:1
Open Google Cloud Console
Go to https://console.cloud.google.com/ and log in with a Google account.
2
Create or select a project
Create a new project or select an existing one to hold the API key.
3
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.
4
Create credentials
Go to Credentials and select Create Credentials → API Key.
5
Configure in D365
Copy the generated key and paste it into Eftsure parameters under the relevant Maps or Places section.
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.1
Log in to Mapbox
Go to https://account.mapbox.com/ and sign in.
2
Create a token
Click Create a token, enter a name for the token, and leave all other settings at their defaults. Click Create token.
3
Configure in D365
Copy the token and paste it into Eftsure parameters under the Mapbox configuration field.
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.1
Create an Azure Maps account
Log in to https://portal.azure.com and create an Azure Maps account.
2
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.
3
Configure in D365
Paste the key into Eftsure parameters under the Azure Maps configuration field.