---
title: "request pairing code"
method: POST
path: "/instances/{id}/client/action/request-pairing-code"
tags: ["client"]
---

# request pairing code

`POST /instances/{id}/client/action/request-pairing-code`

Request a pairing code for phone number registration. To prevent abuse and ensure system stability, pairing code requests are limited to 2 per minute. Multiple rapid requests may indicate automated abuse attempts.

## Path parameters

- `id` integer, required

## Request body

- object
  - `phoneNumber` string, required — Phone number in international format without symbols (e.g. 50664083362)
  - `showNotification` boolean — Whether to show notification when pairing code is received

## Response `200`

Successfully retrieved pairing code

- object
  - `data` object
    - `status` 'success' | 'error'
    - `instanceId` integer
    - `data` object
      - `pairingCode` string — The pairing code for phone number registration
  - `links` object
    - `self` string
  - `status` 'success' | 'error'

## Other responses

- `401` — Unauthorized — invalid or missing bearer token
- `403` — Forbidden — insufficient permissions or account blocked
- `404` — Not found — instance does not exist or does not belong to you
- `409` — Conflict — instance is not ready
- `422` — Validation error — invalid or missing request parameters
- `429` — Too many requests — rate limit exceeded

---

[API](https://skmtc.net/waapi/apis/waapi-api.md) · [All operations](https://skmtc.net/waapi/apis/waapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/waapi/waapi-api/revisions/1e2cc7c12090/schema)
