Documentation
Everything you need to make your app enterprise ready
Paycux is a set of APIs for the parts of your product that enterprise buyers ask about: sign-in, single sign-on, user provisioning, roles and an audit trail. Start with the quickstart, then dip into the reference when you need a field name.
Start here
Four entry points, depending on what you came for.
Quickstart
Install an SDK, point your sign-in button at AuthKit and read a session — about fifteen minutes end to end.
Start buildingAPI reference
Every resource, every field: users, organizations, connections, directories, roles, audit logs and webhooks.
Browse the APISDKs
Idiomatic clients for Node.js, Python, Go, Ruby, PHP and Java, all generated from the same specification.
Pick a languageWebhooks
Subscribe to directory, session and organization events, verify the signature and process them idempotently.
Handle eventsOfficial SDKs
Six first-party clients, all generated from one specification, all released together. If a field exists in the API it exists in every SDK.
| Language | Package | Install |
|---|---|---|
| Node.js | @paycux/node | npm install @paycux/node |
| Python | paycux | pip install paycux |
| Go | paycux-go | go get github.com/paycux/paycux-go |
| Ruby | paycux | gem install paycux |
| PHP | paycux/paycux-php | composer require paycux/paycux-php |
| Java | com.paycux:paycux-java | implementation 'com.paycux:paycux-java' |
Core concepts
Six objects carry most of the platform. Learn them once and the rest of the API reads itself.
Users and organizations
A user is a person. An organization is the tenant they belong to. Almost every enterprise feature hangs off that pair.
ReferenceConnections
A connection is one customer's identity provider. Create it once, and every SAML or OIDC difference is normalised for you.
ReferenceDirectories
A directory keeps your user list in step with the customer's HR or IT system through SCIM and HRIS integrations.
ReferenceRoles and permissions
Roles are defined per environment and travel inside the session, so an authorisation check never costs a round trip.
ReferenceEvents and audit logs
Every meaningful action produces an event. Stream it to a webhook, export it, or expose it to your customer's security team.
ReferenceEnvironments
Staging and production are separate environments with separate keys, connections and webhook endpoints.
Reference1# Every call is a plain HTTPS request against one host,2# authenticated with a secret key from the current environment.3curl https://api.paycux.com/organizations \4 -H "Authorization: Bearer sk_example_123456789" \5 -H "Content-Type: application/json"
Popular guides
Protocol background and integration walkthroughs, written for the engineer who has to ship it rather than specify it.
- What SAML actually isAssertions, metadata and the handshake, in plain language.
- What SCIM actually isProvisioning, deprovisioning and why group sync drifts.
- OIDC flowsAuthorization code with PKCE, and when to use anything else.
- Modelling rolesHow to design a role set that survives your tenth enterprise customer.
- Audit log schemaActor, target, context — the shape a security reviewer expects.
- Handling errorsStatus codes, retry policy and what to do on a 429.
Getting help
Stuck on a connection that will not complete, or an event that never arrives? Send us the request id from the error body — it is the fastest way to a real answer.
Every plan can open a ticket. Support plans add named channels and defined response targets for production incidents.