Partner sign-up links: send your customers to nxos

​

When you’d use this

• The nxos account must be opened on the email you already have for that customer.
• The customer must not be able to swap in another address on the way.
• The new organization must be attributed to you.

​

How it works

1. Your backend calls POST /v1/referral-invites with the customer’s email and your API key.
2. nxos stores an invite bound to that email and returns a url. The URL holds a random code only, never the email.
3. You redirect the customer to the url.
4. The nxos sign-up form opens with the email filled in and locked, and shows your organization as the referrer.
5. The nxos server refuses any other email: at the password step, with Google sign-up, and again when the email is confirmed.
6. The customer confirms the email once, through the usual nxos confirmation email.
7. The organization is created and attributed to you as its referrer. The customer then completes verification with nxos.

​

Issue a link

curl https://api.sandbox.nxos.io/v1/referral-invites \
  -X POST \
  -H "Authorization: Bearer nxos_sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "email": "[email protected]" }'

{
  "object": "referral_invite",
  "referralInviteId": "refinv_...",
  "email": "[email protected]",
  "url": "https://app.sandbox.nxos.io/r/k7x2m9qp3abc",
  "expiresAt": "2027-01-04T14:30:00.000Z",
  "createdAt": "2026-10-06T14:30:00.000Z"
}

• Your organization must be verified (APPROVED). Referrals are switched on for you on the first call if they were not already.
• The link is valid for 90 days.
• Calling again for the same email while the invite is pending returns the same link, valid for 90 days from the new call. You can request it each time you send the customer to nxos, without storing it.
• Nothing is emailed by nxos at this step: you decide when and how the customer reaches the link.

​

Errors

​

What this does not do

• No single sign-on. The customer confirms the email once with nxos and signs in to nxos with their own nxos credentials (password, Google or passkey). Being signed in on your side does not sign them in to nxos.
• No completion callback. You are not notified when the customer finishes signing up, and the API does not return their organization id.
• No delegation. A referral does not let you act on the customer’s account through the API. That needs the broker model and a Letter of Authorization, see Cross-org access.
• If the email already has an nxos account, sign-up fails as it would for any existing address, and the customer signs in instead.