API Documentation

Build integrations with the Zanzibar Digital Free Zone API. Manage digital residents, companies, invoices, and payments programmatically.

Authentication

The ZDFZ API uses API keys for authentication. Include your API key in the Authorization header with all requests.

Authorization: Bearer YOUR_API_KEY

Obtaining an API Key

API keys are issued to registered resellers. Contact the ZDFZ administration to request API access for your organization.

Quick Start

Here's a quick example to get you started. This creates a new digital resident:

1. List Existing Residents

curl -X GET "https://api.zanzibardigitalfreezone.com/api/residents" \
  -H "Authorization: Bearer YOUR_API_KEY"

2. Create a Digital Resident

curl -X POST "https://api.zanzibardigitalfreezone.com/api/residents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "nationality": "US",
    "passport_number": "123456789"
  }'

3. Create a Company

curl -X POST "https://api.zanzibardigitalfreezone.com/api/companies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Global Ltd",
    "type": "FZCO",
    "resident_id": "RES-001",
    "business_activity": "Software Development"
  }'

Error Handling

The API uses standard HTTP status codes. Errors return a JSON object with an error field describing the issue.

Error Response Format

{
  "error": "Description of what went wrong"
}

Digital Residents

Digital Residents are individuals registered in the Zanzibar Digital Free Zone. A resident can own multiple companies and manage their business activities remotely.

Free Zone Companies

Companies can be registered as FZCO (Free Zone Company), FZLLC (Free Zone Limited Liability Company), or Cooperatives. Each type has different requirements and structures.

Invoices

Create and manage invoices for company fees, licensing, and services.

Contracts

Manage legal contracts and agreements. Templates are available for common contract types.

Payments

Process payments via cryptocurrency (Bitcoin, USDT) or PesaPal for fiat transactions.

Cryptocurrency Payments

PesaPal (Fiat)

KYC Verification

Know Your Customer (KYC) verification is required for all digital residents. The API integrates with third-party verification providers.

Treasury

Access treasury accounts and transaction history for companies and residents.