GET/whoami

Whoami

Verify your API key works and see its metadata, tenant info, scopes, and usage count.

🔓 Scope required: any valid key

Request Example

curl https://api.scootsign.com/api/v1/whoami \
  -H "X-API-Key: aram_ent_a1b2c3d4e5f6..."

Response

{
  "success": true,
  "data": {
    "keyId": "key_abc123",
    "name": "CI/CD Pipeline",
    "prefix": "aram_ent_a1b2",
    "tenantId": "tenant_xyz",
    "tenant": "Acme Corp",
    "scopes": ["read", "write"],
    "rateLimit": 1000,
    "usageCount": 1423
  }
}

Response Fields

Field	Type	Description
`keyId`	string	Unique key identifier
`name`	string	Friendly name of the key
`prefix`	string	Key prefix for identification
`tenantId`	string	Your tenant ID
`tenant`	string	Your company name
`scopes`	string[]	Scopes assigned to this key
`rateLimit`	integer	Requests per hour allowed
`usageCount`	integer	Total API calls made with this key