Accept an invitation

View as Markdown

Completes an invitation and returns the new member’s API key. Requires a verification code issued by Create an account for the invited address — a code issued for any other address is rejected. Unauthenticated: the token plus the emailed code are the credentials. No new account is created and no phone number is provisioned; the caller joins the inviting account.

Path parameters

tokenstringRequired

Request

This endpoint expects an object.
verificationIdstringRequired

The verificationId returned by Create an account for the invited address.

codestringRequired=6 characters

The 6-digit code emailed to the invited address.

Response

The invitation was accepted. The API key is shown once — store it.

accountIdstring
The account the caller has joined.
apiKeystring
The member's own API key. Shown once.
memberobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error