All URIs are relative to http://localhost/api/v1

Method	HTTP request	Description
anonymousAuth	POST /anonymous-auth
changeAccount	POST /change-account
confirmEmail	POST /confirm-email
createAccount	POST /account
getArtifacts	GET /artifacts
getSessionArtifacts	GET /session-artifacts
login	POST /login
logout	POST /logout
postSessionArtifacts	POST /session-artifacts
registerUserInteraction	POST /register-user-interaction
requestEmailConfirmationToken	POST /request-email-confirmation-token

anonymousAuth

AnonymousUserAuthResponseData anonymousAuth(AnonymousUserAuthRequestData)

Authenticate as an anonymous user, either using an existing user identifier or creating a new one.

Parameters

Name	Type	Description	Notes
AnonymousUserAuthRequestData	AnonymousUserAuthRequestData		[optional]

Return type

AnonymousUserAuthResponseData

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

changeAccount

GenericOkResponseData changeAccount(ChangeAccountRequestData)

Change the blockchain (Joystream) account associated with the Gateway account. Delete the old account's encryption artifacts and optionally set new ones.

Parameters

Name	Type	Description	Notes
ChangeAccountRequestData	ChangeAccountRequestData		[optional]

Return type

GenericOkResponseData

Authorization

cookieAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

confirmEmail

GenericOkResponseData confirmEmail(ConfirmEmailRequestData)

Confirm account's e-mail address provided during registration.

Parameters

Name	Type	Description	Notes
ConfirmEmailRequestData	ConfirmEmailRequestData		[optional]

Return type

GenericOkResponseData

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createAccount

GenericOkResponseData createAccount(CreateAccountRequestData)

Create a new Gateway account. Requires anonymousAuth to be performed first.

Parameters

Name	Type	Description	Notes
CreateAccountRequestData	CreateAccountRequestData		[optional]

Return type

GenericOkResponseData

Authorization

cookieAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getArtifacts

EncryptionArtifacts getArtifacts(id, email)

Get wallet seed encryption artifacts.

Parameters

Name	Type	Description	Notes
id	String	The lookup key derived from user's credentials.	[default to null]
email	String	The user's email address.	[default to null]

Return type

EncryptionArtifacts

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getSessionArtifacts

EncryptionArtifacts getSessionArtifacts()

Get wallet seed encryption artifacts for the current session.

Parameters

This endpoint does not need any parameter.

Return type

EncryptionArtifacts

Authorization

cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

login

LoginResponseData login(LoginRequestData)

Login to user's account by providing a message signed by the associated blockchain account.

Parameters

Name	Type	Description	Notes
LoginRequestData	LoginRequestData		[optional]

Return type

LoginResponseData

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

logout

GenericOkResponseData logout()

Terminate the current session.

Parameters

This endpoint does not need any parameter.

Return type

GenericOkResponseData

Authorization

cookieAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

postSessionArtifacts

GenericOkResponseData postSessionArtifacts(SessionEncryptionArtifacts)

Save wallet seed encryption artifacts for the current session on the server.

Parameters

Name	Type	Description	Notes
SessionEncryptionArtifacts	SessionEncryptionArtifacts		[optional]

Return type

GenericOkResponseData

Authorization

cookieAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

registerUserInteraction

GenericOkResponseData registerUserInteraction(RegisterUserInteractionRequestData)

Register a user interaction with Atlas part.

Parameters

Name	Type	Description	Notes
RegisterUserInteractionRequestData	RegisterUserInteractionRequestData		[optional]

Return type

GenericOkResponseData

Authorization

cookieAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

requestEmailConfirmationToken

GenericOkResponseData requestEmailConfirmationToken(RequestTokenRequestData)

Request a token to be sent to account's e-mail address, which will allow confirming the ownership of the e-mail by the user.

Parameters

Name	Type	Description	Notes
RequestTokenRequestData	RequestTokenRequestData		[optional]

Return type

GenericOkResponseData

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json