API Usage Guide

This guide covers common flows with the v2 API. For full endpoint details, see the API Reference.

Prerequisites

• A ChinqIT Verify API key (X-API-Key). Create an account, then create the key under API keys in the dashboard. A new account can create a key right away and send OTPs; normal messages unlock after its first top-up.
• Base URL: https://sms.chinqit.com/api/v2

Quick start

1. Send an SMS — POST /api/v2/notify
2. Send an OTP — POST /api/v2/code
3. Verify an OTP — POST /api/v2/check
4. Track delivery — GET /api/v2/notify/
5. Broadcasts — POST /api/v2/bulk/send and GET /api/v2/bulk/status/

Each endpoint is documented with curl examples, parameters, and responses in the API Reference.

OTP and SMS Retriever (Android)

For Android OTP auto-fill, include the hash parameter in POST /api/v2/code. See the SMS Retriever Guide.

Phone login: Supabase and Firebase.

Phone format and errors

Mauritanian phone numbers must match the formats in the API Reference. For issues, see Troubleshooting.

Sender ID (alphanumeric sender name)

Outgoing messages are sent under an alphanumeric sender ID — the name recipients see instead of a phone number. Sender IDs are letters and digits only (no spaces or special characters), for example MyCompany, Store123, or Bank2024. To use a custom sender ID, open Sender IDs in the dashboard and choose Request sender ID. Save draft stores the request without charging your wallet; Save and pay saves it, pays the monthly fee from your wallet, and submits it for review. If your wallet has insufficient funds, the saved draft remains editable. You can also pay for an existing draft from the Requests tab. A rejected request shows the reason in the same tab. Once the request is approved, the sender ID is active. Active sender IDs show the days left before expiry; renewal opens 5 days before expiry, and auto-renew charges one month's fee one day before expiry. A renewal is paid from your wallet and takes effect immediately, with no new review: the dashboard confirms it with the new expiry date. Until a sender ID is active, messages use the default CHINQIT sender.

The request page shows the monthly fee. Review usually takes 2–4 working days. The fee is paid from a top-up, not from the welcome credit.

---

API v1 (deprecated): archived docs in deprecated API section.