Skip to main content
The BKey API is in active development. Endpoints and schemas may change without notice.

​
Base URL

https://api.bkey.id

​
Authentication

Most endpoints require a Bearer token obtained via OAuth 2.1 client credentials or CIBA: 
Authorization: Bearer <access_token>
Merchant-facing endpoints use a separate merchant API key scheme: 
Authorization: Bearer mk_live_...
See Authentication Overview for details.

​
Response format

Successful responses return JSON: 
{
  "id": "chk_abc123",
  "status": "pending",
  "amount": 9.99
}

​
Error format

Errors return an appropriate HTTP status with structured details: 
{
  "success": false,
  "error": {
    "code": "invalid_argument",
    "message": "Amount is required"
  }
}

​
HTTP status codes

CodeMeaning
200Success
201Created
400Validation error — check request body
401Unauthorized — missing or invalid token
403Forbidden — insufficient scopes
404Resource not found
409Conflict — duplicate or concurrent request
429Rate limited
5XXServer error

​
OpenID Connect discovery

GET /.well-known/openid-configuration
Returns the OIDC discovery document with all supported endpoints, grant types, and signing algorithms.

​
Signing keys

GET /oauth/jwks
Returns the JSON Web Key Set for verifying BKey-issued JWTs. Keys use EdDSA (Ed25519).