Prerequisites of using the API

📘
You can test the DigiTax Tanzania API before reaching out to us
We've designed the developer experience to be hands-off. You can get started with your first API call without engaging with our team. Should you need our support or want to onboard your business to LIVE, reach out to us.

Sandbox (testing)

The following steps create a sandbox business and generate an X-API-Key for testing:

Sign up on DigiTax
Create a profile.
Create a Tanzania profile.
Create a test/sandbox business.
Generate an API Key under the "Integrations" tab.
Use the copied API Key as X-API-Key in your header when making API calls.

LIVE (production)

Going LIVE requires TRA VFD registration. The steps are:

Complete TRA VFD registration with TRA directly (you will receive a TIN, VRN, REGID, and EFDSERIAL).
Sign up on DigiTax and create a Tanzania profile.
Create a LIVE business and supply your TRA registration credentials.
Reach out to [email protected] to finalise onboarding - DigiTax will configure your PKI certificate and initialize your VFD counters.
Generate a LIVE API Key under the "Integrations" tab.

👍
Once LIVE, your API Key interacts with TRA's EFDMS production environment.

Generate an API Key

In a test/sandbox or LIVE business:

Navigate to the Integrations menu tab.
Select Add API Key.
Enter a name and select API Key.

Please record the generated value immediately - it is not shown again after creation. Save it securely.

License Key

Under API Type, there are two options:

API Key - Use for standard integrations.
License Key - Use only if directed by the DigiTax support team. Restricted to specific systems.

Use the API Key

Pass the API Key in your request header:

X-API-Key: your-api-key-here

Once you have the API Key, you can use it via our interactive API reference, your local environment, or directly in your system integration.