Register an account

Pre-register an account when a trader already holds it at a provider and you want it waiting for them in trdrs. A registration says the account exists and names the trader who should see it. It holds the trader’s email, the account number and the login name, and only the trader’s own login links the account, which makes it safe to send straight from your onboarding pipeline. Use this page when you connect your onboarding to trdrs. By the end you can create a registration, read every registration’s status, and cancel one that’s still pending.

See how pre-registration works

You register the account, the trader signs in and finds it waiting, they enter their own login, and the account links once the provider accepts it.

You onboard the trader yourself, including every message to them and delivering their login at the provider securely.
You pre-register the account with your pre-registration key: the trader’s trdrs sign-in email, the account number and the login name you issued. That’s all a registration holds.
The trader signs in to trdrs, finds the registration waiting in Connect in the trading platform, and enters their own login.
The account links once the provider accepts that login. The login goes into trdrs’s encrypted vault, and you follow the registration’s status.

A registration names an account for the trader to link. Trading on it stays with the trader, and you tell them about it yourself. Pre-registration fills Connect in the trdrs trading platform, for traders who sign in to trdrs. If your traders sign in only to your own app, you build on Connect instead, and need no registration.

Know which provider a registration uses

A registration uses the built-in provider and system already set on your venue. trdrs takes both from your venue, not from the request, so a registration only names an account at a provider trdrs runs. Whether a trader can link also depends on the environment and on their own access at the provider. A registration adds no provider. A market trdrs doesn’t connect to reaches a venue as a public provider, written against the provider contract and passed through provider conformance. A published datafeed adds market data only.

Before you start

Your venue names a built-in provider and system. trdrs sets both on your venue, and a registration takes them from there.
You have a pre-registration key. Pre-registration is part of Connect and uses a pre-registration key (trdrs_sk_...), kept on your server. A Venue key or a Trading API key is refused here.

The examples use TRDRS_API_BASE_URL and TRDRS_PRE_REGISTRATION_KEY from your server’s environment.

Create the registration

Send the trader’s trdrs sign-in email, which is the only required field, plus the accountNumber at the provider when you know it and the venueLogin, the login name you issued there.

curl -X POST "$TRDRS_API_BASE_URL/api/pre-registration/registrations" \
  -H "Authorization: Bearer $TRDRS_PRE_REGISTRATION_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "trader@example.com",
    "accountNumber": "PA-4821-07",
    "venueLogin": "jsmith-apex"
  }'

const res = await fetch(`${process.env.TRDRS_API_BASE_URL}/api/pre-registration/registrations`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.TRDRS_PRE_REGISTRATION_KEY}`, 'content-type': 'application/json' },
  body: JSON.stringify({ email: 'trader@example.com', accountNumber: 'PA-4821-07', venueLogin: 'jsmith-apex' }),
})
const { registration } = await res.json()

The response is 200 with the registration: its id, the email, accountNumber and venueLogin you sent, the built-in provider it resolved to (the field is named provider), the system, status: "pending", createdAt, an expiresAt 30 days out, and linkedAt: null. accountNumber can be at most 40 characters and venueLogin at most 60.When the trader signs in with that same email, they find the account waiting. Your tile opens with your system filled in, and the trader enters their own login at the provider to finish.

Send it again safely

Registering is idempotent for each pair of email and accountNumber. Sending a pair that’s pending or expired refreshes its 30-day window, and its system and venueLogin, instead of creating a second registration. Once a registration is linked or cancelled, the same pair creates a new one. A pipeline that stopped halfway through a batch can run again, and a trader whose window lapsed gets a fresh one from the same call.A different account for the same trader is a different pair, so it’s a new registration. One registration is one account, so make a new one for a new account rather than reusing an old one.

List your registrations

Read your venue’s 200 most recent registrations, newest first. This is your audit view: who you invited, and who actually arrived.

curl "$TRDRS_API_BASE_URL/api/pre-registration/registrations" \
  -H "Authorization: Bearer $TRDRS_PRE_REGISTRATION_KEY"

const res = await fetch(`${process.env.TRDRS_API_BASE_URL}/api/pre-registration/registrations`, {
  headers: { Authorization: `Bearer ${process.env.TRDRS_PRE_REGISTRATION_KEY}` },
})
const { venue, registrations } = await res.json()

The response names your venue in venue and lists its registrations, for your own venue alone: trdrs finds it from the key.

Cancel one that's still pending

Take back a registration after a refund, a reassignment or a mistake. Pass its id as a query parameter.

curl -X DELETE "$TRDRS_API_BASE_URL/api/pre-registration/registrations?id=3f9c2b1e-8a4d-4c6b-9e2f-1a7d5c0b8e34" \
  -H "Authorization: Bearer $TRDRS_PRE_REGISTRATION_KEY"

The response is { "id": "3f9c2b1e-8a4d-4c6b-9e2f-1a7d5c0b8e34", "revoked": true }, and the registration’s status reads revoked. You can cancel a registration that’s pending or expired. A linked one can’t be cancelled, because the trader holds the account through their own login; ending that relationship is between you and the provider.

Read each status

`status`	What it means	What put it there
`pending`	Waiting for the trader.	You created or refreshed it.
`linked`	The trader signed in and linked the account. `linkedAt` says when.	The provider accepted the trader’s own login.
`revoked`	Cancelled before anyone linked it.	You cancelled it.
`expired`	30 days passed and nobody linked it.	`expiresAt` passed.

The login moves from your venue to the trader through your own onboarding, and from the trader to trdrs’s encrypted vault when they sign in to the provider. It never passes through this API or through an email from trdrs: trdrs sends the trader no message at all, so telling them and giving them their login is entirely your job.

venueLogin is a label, not a secret. It’s the login name you issued, so Connect can show the trader which login to use. Never put anything password-like in it.
There’s no field for a password, and the route reads no field it doesn’t define. A conformance run fails any registration that carries a credential field, such as password or token.

Handle errors

Status	When	What to do
`400`	The body isn’t JSON, the email is missing or malformed, a field is too long or the wrong type, or `id` is missing on a cancel.	Fix the request. The error says which field.
`401`	The key isn’t a pre-registration key for an active venue. A Trading API key or Venue key gets this too.	Use your pre-registration key.
`402 billing_paused`	Registering only: your venue’s billing pause is in force, so it adds no new registrations until its past-due invoices are paid. `billing` carries the standing and where to pay.	Pay the past-due invoices. Listing and cancelling keep working.
`404`	Cancel only: no pending registration has that `id`. It’s linked, already cancelled, or not yours, and the three look the same so no venue can probe another’s ids.	List your registrations to see its status.
`409 runs_on_required`	Your venue names no built-in provider its accounts run on, so a registration has nothing to resolve to.	Ask trdrs to set the provider and system on your venue.
`503 billing_unavailable`	Registering only: your venue’s billing standing couldn’t be read, so nothing was registered.	Try again shortly.

Test it end to end

In the sandbox, with a test trader who has signed up there:

Register the trader’s email with a test account number, and save the id.
Register the same email and account number again. You get the same id with a later expiresAt.
List your registrations and find it as pending.
Cancel it, then cancel it again. The second call answers 404.

Next steps

Follow registrations

Hear on your server when a trader links an account.

Get listed

Put your name and logo on the tile your traders pick in Connect.

Venue accounts

Issue accounts on the paper book instead, for evaluations.

Read your usage

See what a linked account costs, and reconcile your invoice.

Start here

Set up your venue

Run accounts

Connect pre-registration

Check your integration

See how pre-registration works

Know which provider a registration uses

Before you start

Read each status

Handle errors

Test it end to end

Next steps

Follow registrations

Get listed

Venue accounts

Read your usage

​See how pre-registration works

​Know which provider a registration uses

​Before you start

​Read each status

​Keep the login out of the request

​Handle errors

​Test it end to end

​Next steps

Follow registrations

Get listed

Venue accounts

Read your usage

See how pre-registration works

Know which provider a registration uses

Before you start

Read each status

Keep the login out of the request

Handle errors

Test it end to end

Next steps