network > requests

Get Network Request

Retrieve one Network API request by ID. The response includes lifecycle timestamps, request status, your clientRef, and result fields from the original check.

<Note> Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access. </Note>
get/network/requests/{requestId}

Request

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

Path parameters

requestIdstring required

Unique Pinnacle ID for a Network API request.

Network API request ID returned by a Network API endpoint.

Response

Returns the Network API request summary.

requestIdstring required

Unique Pinnacle ID for a Network API request.

type'silent-auth' | 'sim-swap' | 'subscriber-match' required

Type of Network API check.

status'started' | 'challenge-issued' | 'completed' | 'failed' | 'expired' required

Lifecycle status of a Network API request. started and challenge-issued are in-progress states; completed, failed, and expired are terminal states.

clientRefstring nullable required

Your correlation ID from the original request.

createdAtstring date-time required

Timestamp when the request record was created.

updatedAtstring date-time required

Timestamp when the request record was last updated.

completedAtstring date-time nullable required

Timestamp when the request reached a terminal state.

expiresAtstring date-time nullable required

Expiration timestamp for short-lived request flows, when applicable.

errorMessagestring nullable required

Error message for failed requests.

Changes

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