Skip to navigation

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.

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

requestIdstringRequiredformat: "^nar_[A-Za-z0-9]{16}$"

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

Request

This endpoint expects an object.
codestringRequired>=1 character
Code returned by the JSON Silent Auth device flow.

Response

Returns the terminal verification status.
requestIdstringformat: "^nar_[A-Za-z0-9]{16}$"
Unique Pinnacle ID for a Network API request.
statusenum

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.

Allowed values:

Errors

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