Skip to main content

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.

Prerequisites

  • A PCX account with an API key — generate one from the Dashboard
  • curl or any HTTP client

1. Authenticate

All requests require two headers: X-Api-Key and Authorization. Set whichever you are not using to the literal string NONE.
# For API key auth (server-to-server)
export PCX_API_KEY="your_api_key_here"

# For JWT auth (user sessions)
export PCX_JWT="eyJraWQ..."
See Authentication for full details.

2. Create an organization

curl -X POST https://prod-api.pcxpay.com/v1/organizations \
  -H "X-Api-Key: $PCX_API_KEY" \
  -H "Authorization: NONE" \
  -H "Content-Type: application/json" \
  -d '{
    "org_name": "Acme Corp",
    "country": "GB",
    "created_by": "user_abc123"
  }'
Response:
{
  "status": "success",
  "message": "Organization created successfully",
  "data": {
    "org_id": "org_xxxx",
    "org_name": "Acme Corp",
    "status": "active",
    "country": "GB",
    "createdAt": "2025-03-16T10:00:00.000Z",
    "kybComplete": false
  }
}

3. Start KYB verification

Before transacting, organizations must complete KYB.
curl -X POST https://prod-api.pcxpay.com/v1/kyb \
  -H "X-Api-Key: $PCX_API_KEY" \
  -H "Authorization: NONE" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "user_abc123",
    "org_id": "org_xxxx",
    "userCreatedAt": "2025-03-16T10:00:00Z",
    "orgCreatedAt": "2025-03-16T10:00:00Z",
    "businessInfo": {
      "businessName": "Acme Corp",
      "country": "GB",
      "emailAddress": "ops@acme.com"
    }
  }'

Next steps