Webscale APIAccess Checks
Perform Access Check
Checks user access to features and returns entitlement information. This is the primary endpoint for determining what a user can access based on their identity, plans, and current usage.
The response includes:
- Feature access and properties
- Current usage and remaining quotas for metered features
- User identity and authentication status
- Customer data and identifiers
- Diagnostic information (for secret keys only)
User Identity
You can identify users in three ways (only one should be specified per request):
anonymousIdentifier: For anonymous/unauthenticated usersuserJwt: JWT token for authenticated usersuserIdentifier: Direct user ID (requires secret key)
User Agents
When running decisions from a server-side context with a secret key, the original client user agent
can be specified for use in decisions by setting the x-mos-user-agent header.
Authorization
ApiKeyAuth AuthorizationBearer <token>
API key authentication. Use secret keys (sk_*) for full access or public keys (pk_*) for limited access.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.monetizationos.com/api/v1/access-checks" \ -H "Content-Type: application/json" \ -d '{ "identity": { "anonymousIdentifier": "anon_session_789" }, "resource": { "id": "article_xyz" } }'{
"status": "success",
"eventId": "c918c19e-b782-4c2f-93c0-8a5f94c0a1b5",
"identity": {
"authType": "provided",
"isAuthenticated": true,
"identifier": "user_12345"
},
"customer": {
"isCustomer": true,
"hasProducts": true,
"customerIdentifiers": [
"user_12345",
"stripe_cus_abc123"
]
},
"features": {
"article": {
"featureId": "feat_123456",
"featureSlug": "article",
"properties": {
"enabled": {
"type": "meterable",
"counterId": "default:feat_123456.enabled",
"hasAccess": true,
"consumedUnits": 3,
"remainingUnits": 2,
"totalUnits": 5,
"periodStart": "2025-07-01T00:00:00Z",
"uniqueResources": false,
"resourceIdUsed": false,
"consumedInRequest": false,
"isFallback": false
},
"ads": {
"type": "boolean",
"value": false,
"isFallback": true
}
}
}
}
}{
"status": "error",
"statusCode": 400,
"message": "Invalid JSON body"
}{
"status": "error",
"statusCode": 401,
"message": "Invalid API key"
}{
"status": "error",
"statusCode": 404,
"message": "Organization not found"
}{
"status": "error",
"statusCode": 500,
"message": "Internal server error"
}