Skip to navigation
API ReferenceNetwork APIs

Start Silent Authentication

Start a Silent Authentication session to verify that the user controls the device attached to a phone number. Omit format to receive a browserUrl for the hosted browser/WebView flow, or set format: "json" to receive a jsonUrl for a native mobile app or custom client-side flow. The device check must run from the user’s cellular device, not your server.

The returned URL expires 60 seconds after creation. Open or fetch it immediately and use expiresAt to detect when a new Silent Auth session is required.

Limited availability. Contact founders@pinnacle.sh to request access.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
phoneNumberstringRequiredformat: "^\+[1-9]\d{9,14}$"
Phone number in E.164 format, including country code.
clientRefstringOptional1-40 characters
Your correlation ID, such as a user ID, session ID, or case ID.
formatenumOptional

Set to json when you want to fetch jsonUrl directly from your app and receive a JSON response. Omit this field for the hosted browser/WebView flow.

Allowed values:

Response

Returns a short-lived URL for completing Silent Authentication from the user’s device.

hostedobject
OR
jsonobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error