Skip to content
PaloNexus
Request access Request

Verify Key

POST
/v1/keys/verify
 
curl --request POST \
  --url https://example.com/v1/keys/verify \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example" }'

Resolve a plaintext key to its record + stamp last-used. Revoked/unknown keys fail closed (ok=false). Consumed by the control plane / SDK gateway.

Request Body required

Section titled “Request Body required ”
Media type application/json
VerifyKeyRequest

Resolve a plaintext key to its record (and stamp last-used). Used by the control plane / SDK gateway to authenticate an pn_live_… / pn_test_… bearer. Revoked or unknown keys fail closed.

object
key
required
Key
string
Example generated
{
  "key": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
VerifyKeyResponse
object
ok
required
Ok
boolean
reason
required
Reason
string
keyId
Any of:
string
env
Any of:
string
scopes
Scopes
Array<string>
tenantId
Any of:
string
Example generated
{
  "ok": true,
  "reason": "example",
  "keyId": "example",
  "env": "example",
  "scopes": [
    "example"
  ],
  "tenantId": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}