Skip to main content
POST
/
api
/
v2
/
auth
/
request-otp
/
Request OTP for customer verification
curl --request POST \
  --url https://api.zupy.com/api/v2/auth/request-otp/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "identifier": "<string>"
}
'
{
  "status": "sent",
  "channel": "whatsapp",
  "expires_in": 300
}

Authorizations

​
X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Headers

​
X-API-Key
string
required

Partner API key

Body

​
identifier
string
required

Phone (+5511...), email, or CPF

Response

​
status
string
required

Always 'sent'

​
channel
string
required

Delivery channel: whatsapp, email, or sms

​
expires_in
integer
required

OTP expiry in seconds