network > silentAuth

Check Silent Authentication

Complete a Silent Authentication request by exchanging the code returned from the JSON flow. Call this from your server after the user's mobile app fetches jsonUrl.

This endpoint returns a terminal verification result. To inspect pending lifecycle states such as started or challenge-issued, use Get Network Request.

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

Request

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

Path parameters

requestIdstring required

Unique Pinnacle ID for a Network API request.

Silent Authentication request ID returned by POST /network/silent-auth.

Request body

codestring required

Code returned by the JSON Silent Auth device flow.

Response

Returns the terminal verification status.

requestIdstring required

Unique Pinnacle ID for a Network API request.

status'completed' | 'failed' required

Terminal verification result after exchanging a device flow code. completed means the phone number was verified; failed means the verification did not complete successfully. To inspect pending lifecycle states, use Get Network Request.

Changes

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