Skip to content
Domain Verification

API

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

Create a new organization domain

An organization is the tenant boundary in Paycux. Connections, directories, roles and audit log streams all hang off an organization, and a user reaches your application through a membership in one.

Create an organization per customer, not per environment. The same organization exists in staging and production with separate configuration.

Get a domain

Verify a domain before you let it drive access. Paycux issues a TXT record; once it resolves, the organization owns that domain and users arriving with a matching email address are routed to its connection.

Verification is re-checked periodically. If the record is removed, the domain returns to unverified and routing stops — it does not silently keep working.

Initiate verification for existing domain

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.