Link a WhatsApp number | Swarmhit Developers

Starts a link and answers once WhatsApp shows something (a few seconds): a QR to scan, or a pairing code with pairing_phone_number. Both are 201 Checkpoint. The QR rotates about every 20 s: read the current one from GET /accounts/{id} (gateway.checkpoint). When the phone accepts, the account goes OK (events CREATION_SUCCESS, OK). 503 whatsapp-connecting when WhatsApp did not answer: try again.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Always WHATSAPP.

pairing_phone_number?string

Link with a pairing code instead of a QR: the number in international format (non-digits ignored).

Lengthlength <= 32

country?string

ISO code of the number's country: where its proxy is placed.

Match^[A-Za-z]{2}$

ip?string

An address to place it near, when no country is sent.

Lengthlength <= 64

proxy?

Your own proxy for the number, instead of one Swarmhit places. Optional; the number then goes out through it.

network_type?string

The kind of IP the number goes out from, residential, mobile or datacenter. Absent, the one set for your new numbers.

Value in

"residential"
"mobile"
"datacenter"

region?string

A region inside country, when the proxy provider offers one.

Lengthlength <= 64

Response Body

`application/json`

curl -X POST "https://example.com/whatsapp/api/v1/accounts" \  -H "Content-Type: application/json" \  -d '{    "provider": "WHATSAPP",    "country": "FR"  }'

{  "object": "Checkpoint",  "account_id": "wa_Xk2pQ9rT4vW8yZ1a",  "checkpoint": {    "type": "QRCODE",    "qrcode": "2@Zm9vYmFyLWV4YW1wbGUtcXI=,ZXhhbXBsZQ==,ZmFrZQ==",    "expires_at": "2026-10-31T09:30:20.000Z"  }}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

422application/json

503application/json

Example qr

Example pairing

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`