network > silentAuth

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.

<Note> Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access. </Note>
post/network/silent-auth

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/network/silent-auth
  • Auth: API key in header PINNACLE-API-KEY

Request body

phoneNumberstring required

Phone number in E.164 format, including country code.

clientRefstring

Your correlation ID, such as a user ID, session ID, or case ID.

format'json'

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.

Response

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

OR

Changes

No recorded changes to this operation across all 1 revision of this API.