Skip to main content
GET
Get pair code for phone number

Authorizations

X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

phone
string
required

Phone number to pair with (e.g. 1234567890)

Pattern: ^\+?\d{7,15}$

Response

Pair code generated

code
string
Example:

"ABCD-EFGH"