Check availability
Mobile
Check availability
Check registration availability for a phone number on WhatsApp
POST
Check availability
Overview
Method used to check the registration availability of a number. This endpoint verifies if the number is available for registration and performs the WhatsApp onboarding setup. It must be called before requesting the confirmation code.ATTENTIONDo not use this method if you do not have access to the phone where the number is currently linked. This method is useful for speeding up the code confirmation process without having to wait for an SMS or voice call, but it requires you to have the device in hand with the WhatsApp app open.
Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Body
string
required
Country code
string
required
Phone number with area code, no formatting
Request Body
Response
200
boolean
Returns true if the number is available for registration
boolean
Whether the number is banned or blocked for some other reason
string
Token for unban request (when blocked)
number
Time to wait before requesting SMS
number
Time to wait before requesting voice call
number
Time to wait before requesting in-app pop-up
boolean
Whether the pop-up code request method is available
string
In case of error, this attribute states the reason why the error occurred