Getting started

The Aziz Catalogue API gives agencies read access to the catalogue of Dubai off-plan and ready properties — projects, units and developers — together with a single write operation: submitting an end client’s application for a specific unit. Every operation requires an agency API key.

Issue an API key

Keys are issued by the agency itself on the Aziz platform, estate.azizdubai.com; the Catalogue API only verifies them. API keys are available to agency (broker) companies only — developer companies do not have access to this feature. The user issuing the key must hold the API keys permission: company owners have it by default, and for any other role the owner grants it under Roles & permissions.

In the API keys section of the agency account, create a key and give it a name that identifies the integration (for example, CRM integration). Optionally set a price_vector — a markup (positive) or discount (negative) in percent, greater than -100 and no greater than 100, applied to every price served under the key. The default 0 means list prices.

The key is shown once

A key looks like azk_ followed by 64 hexadecimal characters. It is displayed once only, at creation: Aziz stores only its SHA-256 hash and cannot show it again. If a key is lost, revoke it and issue a new one.

Make your first request

Start with GET /whoIAm. It returns the key that was presented, the company that owns it, the user who issued it and the price factor applied to its prices — a quick way to confirm that the key is active and that its price vector is configured as intended.

curl https://agent-dev.azizdubai.com/whoIAm \
  -H "X-API-Key: azk_<your key>"

A successful response is wrapped in the standard envelope:

{
  "status": "success",
  "data": {
    "api_key": { "id": 1, "name": "CRM integration", "key_prefix": "azk_1a2b", "status": 0, "price_vector": 5, "price_factor": 1.05 },
    "company": { "id": 12, "company_type": 2, "name": "Example Realty", "logo": null },
    "author": { "id": 34, "name": "Jane Doe", "email": "jane@example.com" }
  }
}

Next steps

• Authentication — header options, domain restrictions and licence requirements.
• Core concepts — the response envelope, pricing and field naming.
• API Reference — every operation, generated from the OpenAPI spec.