API reference

API reference · Account

Teams to join by a proven email address, or ask to join one

POST/api/account/team-joinSigned in session

An address is proven by signing in with email (or Google) through Privy, whose identity token is verified against Privy's published key and must name one of this account's wallets. The account's confirmed email does not count (its link is confirmed with no session, so it proves the inbox, not who asked), and a typed address is never accepted. Without orgId the answer lists the teams that verified those domains; with orgId it asks to join (202 pending) or joins at once where the domain auto approves (201). The token is not stored.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
identityTokenstring
orgIdinteger

Example

{
  "identityToken": "string",
  "orgId": 0
}

Answer 200

The proven addresses and the teams.

The answer's fields are not named in the document.

Answer 201

Joined.

The answer's fields are not named in the document.

Answer 202

Asked; an admin decides.

The answer's fields are not named in the document.

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 409OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter