Provision a tenant

Register one of your customers

POST https://nofy.encipher.co.tz/v2/tenants

Registers a customer under your own id for it. Idempotent: provisioning an existing external_id returns that tenant with created: false, so onboarding can call it unconditionally.

Authorizations

Authorizationstringheaderrequired

Bearer <token>, where the token comes from Create a token with the client-credentials grant.

Body application/json

external_id string required

Your id for the customer, typically its uuid.

name string

Display name for the console. Up to 255 characters.

Responses

201 Created.

200 Already existed; nothing changed.

400 external_id is missing.

Read the guideTenants & quotas

Request

curl -X POST https://nofy.encipher.co.tz/v2/tenants \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "company-uuid-1", "name": "Acme Fuel"}'

import requests

response = requests.post(
    "https://nofy.encipher.co.tz/v2/tenants",
    headers={
        "Authorization": "Bearer <token>",
    },
    json={
        "external_id": "company-uuid-1",
        "name": "Acme Fuel"
    },
)
print(response.status_code, response.json())

const response = await fetch("https://nofy.encipher.co.tz/v2/tenants", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.NOFY_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "external_id": "company-uuid-1",
    "name": "Acme Fuel"
  }),
});
console.log(response.status, await response.json());

Response

{
  "tenant_id": "KCrU9UsxCnrc",
  "external_id": "company-uuid-1",
  "created": true
}

{
  "tenant_id": "KCrU9UsxCnrc",
  "external_id": "company-uuid-1",
  "created": false
}

{
  "external_id": "This field is required."
}