Skip to main content

Number Masking (Proxy) API

Connect Party A to Party B via a third “proxy” number — both sides dial / SMS the proxy and the platform forwards. Used by marketplaces and ride-share apps where the buyer and seller shouldn’t see each other’s real phone number. Base path: /api/v1/proxy Authentication: API key (X-API-Key) or session JWT.

Sessions

A session is the active mapping. While the session is open, calls and SMS to the proxy number from Party A are forwarded to Party B and vice versa.

Inbound webhook

Carrier inbound traffic to the proxy number is posted to POST /api/v1/proxy/inbound — platform-managed. You don’t call this directly.

Example — book a proxy session for an Uber-style ride

ttl_minutes is optional (1–1440, defaults to 60) and sets how long the session stays open before it expires. The response includes the proxy number both parties should call/text, plus the computed expiry. Close the session early with DELETE when the trip ends.