Wafeq – Connection Guide

How to generate an API key for Wafeq

Wafeq is a cloud accounting platform used across the GCC and Egypt (Saudi Arabia, UAE, Egypt) with built-in ZATCA e-invoicing compliance. The Wafeq Public API lets you read and write invoices, bills, contacts, payments, ledger accounts, and more from your Wafeq workspace.

To connect Wafeq to Apideck Vault you'll need a Wafeq API key. The key is scoped to the workspace where you generate it — there is no separate sandbox environment, so the same key works for both production and testing.

API access is not included in a free Wafeq account. Your workspace needs to be on at least Wafeq's paid Starter plan, though the API is fully usable during a free trial — so you can build and test your integration on a trial workspace before upgrading.

Steps

1. Sign in to your Wafeq workspace at https://app.wafeq.com, or start a free trial from the same URL if you don't have a workspace yet.
2. Enable the Public API for your workspace. Open Settings → Developer, then toggle the Public API switch on. If you don't see the Developer section, your workspace is below the Starter plan or is outside its trial — upgrade, or contact Wafeq support. Without this step every API request returns 403 Forbidden, even with a valid key.
3. In the same Developer section, open API Keys.
4. Click Create new key.
5. Give the key a descriptive name (e.g. "Apideck integration") so you can identify it later.
6. Click Generate, then copy the API key value. Store it somewhere safe — you'll need it for the next step.

Connecting in Vault

In Apideck Vault, paste the API key into the API Key field when prompted. Vault will use it as Authorization: Api-Key <YOUR_KEY> for every request to Wafeq.

Revoking access

To revoke the integration, return to Settings → Developer → API Keys in Wafeq and delete the key. Vault connections using that key will stop working immediately.

References

• Wafeq developer portal
• Wafeq API authentication reference