Skip to main content
POST
Request OTP for customer verification

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