Register a phone number
Register a WhatsApp Business number for Cloud API sending using its 6-digit two-step-verification PIN. This is the API equivalent of the dashboard's "Register" action — use it to finish onboarding a number that Meta reports as not yet CONNECTED, or to recover a number degraded with a "not registered" error. The account row must already exist: connect the number first via a customer setup link / embedded signup, then find its phone_number_id from GET /v1/accounts (rows whose status isn't connected or whose meta_status isn't CONNECTED are the ones that need this call). PIN semantics mirror Meta: if the number already has two-step verification the PIN must match the existing one; if it doesn't, the PIN you send becomes the number's permanent PIN. A wrong PIN, cooldown, or other Meta business error returns 422 whatsapp_registration_failed with a descriptive message. Unlike the other per-account endpoints, this one accepts numbers in any (non-connected) state — that's the whole point.
Request
- Base URL: https://api.kirimdev.com/v1
- URL: https://api.kirimdev.com/v1/{phone_number_id}/register
- Auth: HTTP bearer
Path parameters
Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).
Headers
Optional retry key. Reusing the same key with the same method, path, and body within 24 hours returns the original response; reusing it for a different request returns 422.
Request body
Example request
{
"pin": "123456"
}Response
Number registered — it can send now.
Example response
{
"data": {
"phone_number_id": "106540352242922",
"status": "connected",
"meta_status": "CONNECTED"
},
"request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}Changes
No recorded changes to this operation across all 1 revision of this API.