POST/api/v3/validate-authcode

Validate Auth Code

This API allows you to exchange an auth code for an access token.

USE CASE

Get the access_token that authenticates every later API request, right after login completes.

Note

FYERS API access tokens expire daily at 6:30 AM. Generate a new token after 6:30 AM for it to remain valid throughout the day.

Details

Send a POST request with a JSON body containing grant_type (authorization_code), appIdHash and code, the auth_code from the login redirect.
appIdHash is the SHA-256 hash of app_id:app_secret; keep the app_secret private and never share it.
Use the returned access_token for all later requests, sent as app_id:access_token in the Authorization header.
If a token is expired or invalid, API calls return error code -8, -15, -16 or -17. See API Error Codes.

Request Attributes

Attribute	Data Type	Description
`grant_type`	string	This value must always be “authorization_code
`appIdHash`	string	SHA-256 of api_id + app_secret Eg: SHA-256 of app_id:app_secret is 7c7120d2b5004f8de22d8dc2da0453b4d7e6211e37a4108b8371266ecff00498 You can use this online tool for reference
`code`	string	This is the auth_code which is received from the first step

Response Attributes

Attribute	Data Type	Description
`s`	string	ok / error
`code`	int	This is the code to identify specific responses
`message`	string	This is the message to identify the specific error responses
`access_token`	string	This value will be used for all the subsequent requests.

Request

# Import the required module from the fyers_apiv3 package
from fyers_apiv3 import fyersModel

# Define your Fyers API credentials
client_id = "SPXXXXE7-100"  # Replace with your client ID
secret_key = "N********B"  # Replace with your secret key
redirect_uri = "https://trade.fyers.in/api-login/redirect-uri/index.html"  # Replace with your redirect URI
response_type = "code" 
grant_type = "authorization_code"  

# The authorization code received from Fyers after the user grants access
auth_code = "eyJ0eXAi*******.eyJpc3MiOiJhcGkubG9********.r_65Awa1kGdsNTAgD******"

# Create a session object to handle the Fyers API authentication and token generation
session = fyersModel.SessionModel(
    client_id=client_id,
    secret_key=secret_key, 
    redirect_uri=redirect_uri, 
    response_type=response_type, 
    grant_type=grant_type
)

# Set the authorization code in the session object
session.set_token(auth_code)

# Generate the access token using the authorization code
response = session.generate_token()

# Print the response, which should contain the access token and other details
print(response)

{
  's': 'ok',
  'code': 200,
  'message': '',
  'access_token': 'eyJ0eXAiOi***.eyJpc3MiOiJh***.HrSubihiFKXOpUOj_7***',
  'refresh_token': 'eyJ0eXAiO***.eyJpc3MiOiJh***.67mXADDLrrleuEH_EE***'
}

Validate Auth Code

Request Attributes

Response Attributes

Video learning