Skip to main content
POST
/
action
/
check-api-key
Check API Key Status
curl --request POST \
  --url https://getmipay.com/api/v1/action/check-api-key \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "public_apikey": "pk_1234567890abcdef"
}'
{
  "success": true,
  "data": {
    "api_key": {
      "id": 1,
      "key": "pk_1234567890abcdef",
      "status": "active",
      "is_active": true,
      "activated_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "has_been_rotated": false,
      "rotation_count": 0
    },
    "merchant": {
      "id": 1,
      "business_name": "My Business",
      "kyc_status": "approved",
      "kyc_status_label": "Approved",
      "status": "active",
      "is_active": true,
      "can_transact": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

API key to check

​
public_apikey
string
required

The public API key to check

Example:

"pk_1234567890abcdef"

Response

API key status retrieved successfully

​
success
boolean
Example:

true

​
data
object