Get Network Request | Pinnacle

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

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}$"

Network API request ID returned by a Network API endpoint.

Response

Returns the Network API request summary.

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

Unique Pinnacle ID for a Network API request.

typeenum

Type of Network API check.

Allowed values:

statusenum

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

Allowed values:

clientRefstring or null

Your correlation ID from the original request.

createdAtstringformat: "date-time"

Timestamp when the request record was created.

updatedAtstringformat: "date-time"

Timestamp when the request record was last updated.

completedAtstring or nullformat: "date-time"

Timestamp when the request reached a terminal state.

expiresAtstring or nullformat: "date-time"

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

errorMessagestring or null

Error message for failed requests.

resultobject

Result from the original check, or null while the request is still pending or no result is available.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error