Skip to main content
POST
/
api
/
canary
/
authentication
/
api-key
/
verify
Verify API Key
curl --request POST \
  --url https://api.cashful.africa/api/canary/authentication/api-key/verify \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "pk_live_12345..."
}
'
{
  "valid": {
    "valid": true,
    "key": {
      "id": "key_123",
      "name": "My API Key"
    }
  },
  "key": {
    "id": "key_123",
    "name": "My API Key"
  }
}

Body

application/json
​
key
string
required

The API key to verify

Example:

"pk_live_12345..."

Response

API key verified successfully

​
valid
boolean
required

API key verification result

Example:
{
  "valid": true,
  "key": { "id": "key_123", "name": "My API Key" }
}
​
key
object

API key details (without the actual key)

Example:
{ "id": "key_123", "name": "My API Key" }