Portal Setup

Setup Order

All setup in this page happens in the Notify Africa Portal.

Fund The Account

• Add sufficient SMS credits before sending.
• Review the current balance in the Portal.
• Account for one debit per calculated segment, not one debit per API request.
• Add the segment cost for every eligible recipient in a batch.

The Developer API does not expose a balance endpoint.

Obtain A Sender ID

1. Request a sender ID in the Portal.
2. Wait for the Portal to show it as approved.
3. Use its current identifier or name in send requests.

A send fails when the sender ID is unknown, unapproved, privately owned by another customer, suspended, or past its usage limit.

The Developer API does not expose sender-ID creation, listing, approval, or update operations.

Create An SMS API Key

1. Open API-key management in the Portal.
2. Create a key with SMS access enabled.
3. Copy the full ntfy_... value when it is shown.
4. Store it in a server-side secret manager.

The full token is sensitive. Do not expose it in browser code, mobile binaries, logs, support messages, or source control.

Key Lifecycle

• Regenerate a key when its value may be compromised.
• Replace the deployed secret immediately after regeneration.
• Revoke or delete keys that are no longer used.
• Separate test and production keys.
• Grant only the API services each integration needs.

Tenant Scope

Authentication resolves the customer that owns the key. That customer boundary controls:

• sender-ID access.
• credit debit.
• message creation.
• message-status lookup.

Do not send customer or tenant identifiers in request headers or bodies. A message UUID from another customer is not accessible with your key.