Account endpoints

Endpoints for profile, API keys, and account-level operations.

GET/v1/me

Return the authenticated user's profile, billing mode, balance, and status.

AuthPortal token

Request sampleGET /v1/me

No request body.

Response sample200 OK

{
  "id": "user_123",
  "email": "[email protected]",
  "billing_mode": "prepaid",
  "balance_credits": 2500,
  "status": "active"
}

GET/v1/api-keys

List API keys and scopes for the authenticated user.

AuthPortal token

Request sampleGET /v1/api-keys

No request body.

Response sample200 OK

[
  {
    "id": "key_123",
    "name": "Production",
    "key_prefix": "lks_live",
    "active": true
  }
]

POST/v1/api-keys

Create a new API key. The raw key is only returned once.

AuthPortal token

Parameters

Name	Type	Description	Required
`name`	string	Key label.	Yes
`scopes`	string[]	Optional API scopes.	No

Request samplePOST /v1/api-keys

{
  "name": "Production",
  "scopes": [
    "sms:send",
    "otp:send",
    "otp:verify",
    "whatsapp:send",
    "email:send",
    "account:read"
  ]
}

Response sample200 OK

{
  "api_key": "lks_live_xxxxxxxxxxxxx",
  "key": {
    "id": "key_123",
    "active": true
  }
}

DELETE/v1/api-keys/{key_id}

Disable an API key.

AuthPortal token

Parameters

Name	Type	Description	Required
`key_id`	path	API key identifier.	Yes

Request sampleDELETE /v1/api-keys/{key_id}

No request body.

Response sample200 OK

{
  "id": "key_123",
  "active": false
}