Skip to main content
GET
/
organizations
/
permissions
/
check
Check if a user has a specific permission
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/organizations/permissions/check \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "user_id": "<string>",
  "resource": "<string>",
  "action": "<string>",
  "org_id": "<string>",
  "allowed": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Query Parameters

​
user_id
string
required
​
resource
string
required
​
action
enum<string>
required
Available options:
READ,
CREATE,
UPDATE
​
org_id
string

Response

Permission check result

​
user_id
string
​
resource
string
​
action
string
​
org_id
string
​
allowed
boolean