Skip to content
Paycux
AuthKit

API Gateway

How API Gateway works in Paycux, what it is for, and the smallest setup that gets it running.

Introduction

API Gateway is part of the Paycux platform. This page explains what it does, when to reach for it, and the smallest working setup you can ship.

Everything below applies to both environments. Build and test in staging, then promote the same configuration to production without changing your code — only the API key and client ID differ.

How it works

How it works is handled by API Gateway rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

The gateway assertion

The gateway assertion is handled by API Gateway rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Verifying the assertion at your origin

Verify the setup end to end before you hand it to a customer. Run the flow from a private browser window so no existing session masks a broken step.

  1. 1Open the connection in the dashboard and confirm its status reads Active.
  2. 2Start the flow from your application, not from the provider, so the redirect URI is exercised.
  3. 3Sign in as a test user and confirm the profile arrives with an email address.
  4. 4Check the connection's event list — a successful sign-in appears within a few seconds.

Using the identity

A user record holds the identity Paycux resolved for the person: email, name, verification state, and the identities they have linked. It is the object your application should key on.

Users are unique by email within a project. When the same person arrives through a second provider, Paycux links the identity to the existing user rather than creating a duplicate.