> For the complete documentation index, see [llms.txt](https://docs.volven.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.volven.io/api/volven-api/authentication.md). # Authentication In order to authenticate use following endpoint, passing your Volven/TYR Markets user name (which is your email) and password: ```http POST /httpserver/main/v2/auth/login { "username": "", "password": "" } ``` If you have 2FA enabled you will get following response: ```http 200 OK { "awsUsername": "9205eec4-8b36-48a4-aa6c-a73e8ce01684", "session": "AYABeK9med7n...Z7oBVQAjVJEZ0k", "challengeName": "SOFTWARE_TOKEN_MFA", "status": "CHALLENGE_REQUIRED" } ``` In that case you have to provide OTP (one time password) from your configured authenticator app.\ Send it in `challengeAnswer` field along with `awsUsername` and `session` from previous authentication response: ```http POST /httpserver/main/v2/auth/login { "awsUsername": "9205eec4-8b36-48a4-aa6c-a73e8ce01684", "session": "AYABeK9med7n...Z7oBVQAjVJEZ0k", "challengeName": "SOFTWARE_TOKEN_MFA", "status": "CHALLENGE_REQUIRED", "challengeAnswer": "898165" } ``` Once you are successfully authenticated (with or without 2FA enabled) you will get following response: ```http 200 OK Authorization: Bearer eyJraWQiOiJWQmd...8yeUJmCX2JXxyJBzHA { "refreshToken": "eyJjdHkiOiJKV1Qi...ULGaonedpIyv86GNpg", "expirationTime": 3600, "isAppConnected": false } ``` Now you need to use the token received in `Authorization` header from the response above to authorize all business API request. You simply pass this token in `Authorization` header when performing every HTTP request or initiating WebSocket connection. The token is valid for `expirationTime` number of seconds, which in this case is 1 hour. If you want to use API in continuous manner but authorize only once then use `refreshToken` from the response above. Perform following call periodically before your session expires (for instance 5 minutes before expiration time): ```http POST /httpserver/main/v2/auth/login { "refreshToken": "eyJjdHkiOiJKV1Qi...ULGaonedpIyv86GNpg" } ``` You should receive following response meaning that your session has been prolonged and will expire at `expirationTime` (Unix timestamp). You need to replace your existing token with a new one from `Authorization` header from the response below: ```http 200 OK Authorization: Bearer eyJraWQiOiJWQmd...nFmxU4PiUIV38iEbZA { "expirationTime": 1758546865 } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.volven.io/api/volven-api/authentication.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.