Before you start
- A Venue key with the
trader:handoffscope, kept on your server. Venue keys shows how to create one. - An account you issued by email, and its
accountId. - The trader’s email, checked by your own sign-in. Send only an address you know the trader holds: the link signs whoever opens it in as that email.
How the first visit goes
Your trader is one of three people, and each sees one thing:
The email code is asked once per venue, so no venue can open an account that belongs to someone
else. Your trader removes your venue in their trdrs settings whenever they like, and the next link
asks for the code again.
1
Ask for a link from your backend
Ask for a link when your trader presses Trade, and name the account it opens on.Required scope: The token is in the link’s fragment, which no server receives. Each request makes a new link,
and the
trader:handoff.The answer is the link and when it stops working:Idempotency-Key is recorded in your venue’s audit as the link’s reference.2
Open it in the trader's browser at once
Send the trader’s browser to the
url straight away: the link lasts 60 seconds and opens one
session. A browser that opens a new window after a slow request may block it as a pop-up, so
navigate the same tab, or open the window before your request and set its address after.The session the link opens lasts as any trdrs sign-in does, 30 days from the trader’s last
visit.What the session can do
The session is your trader’s own: it trades and reads every account they hold, yours and any other. It links nothing new. Connecting a provider, creating a key, accepting someone else’s account and running a venue all need a session the trader opened themselves with their email code, and the trading platform asks them to sign in that way when they try.When something is refused
A link opened after its 60 seconds, or a second time, shows the trader “This link has expired” with a
way back to your site. Ask for a new link when they press Trade again.