Skip to content

Refresh Token

The Refresh Token section in the IIMMPACT API allows users to securely obtain a new access token without requiring the user to re-enter their credentials. By utilizing this functionality, users can seamlessly maintain their authentication session and access protected resources within the application.

  • IdToken : The IdToken is essential for authenticating your subsequent API requests and has an expiry of 60 minutes. Please make sure to save this IdToken and use it as a Bearer token in the Authorization header for other API interactions.

  • RefreshToken: To maintain continuous access, the RefreshToken is used to generate a new IdToken whenever the current IdToken expires. The RefreshToken itself has an expiry of 1 year. Make sure to save the RefreshToken securely and use it with our refresh API to obtain new tokens before the current ones expire.

INFO

Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

API Endpoint

http
POST https://api.iimmpact.com/v2/token/refresh

Request Body

ParameterTypeRequiredDescription
refresh_tokenstringNorefresh_token

Response 200

To test requests using your account, replace the sample username and password with your created account.

FieldTypeDescription
AuthenticationResultobjectThe result of the authentication process.
AuthenticationResult.AccessTokenstringThe access token generated for the user.
AuthenticationResult.ExpiresInnumberThe time duration until the idtoken expires.
AuthenticationResult.TokenTypestringThe type of token being generated.
AuthenticationResult.RefreshTokenstringThe refresh token used to obtain a new access token.
AuthenticationResult.IdTokenstringThe generated idtoken for the user.

Example Response:

json
{
  "AuthenticationResult": {
    "AccessToken": "eyJraWQiOiJRN21MeXUydEthSXlP0hiOHFGcjlBRT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJiYjlmODVkZi02MmY4LTQxMmVudF9pZCI6IjUyOGE3NGU3LTYyYmEtNDBmZi1iODM2LTA2OTRmYjIwYjJhYiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE3NDczODkwODAsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5hcC1zb3V0aGVhc3QtMS5hbWF6b25hd3MuY29tXC9hcC1zb3V0aGVhc3QtMV81RUVuajVMOXkiLCJleHAiOjE3NDczOTI3NDksImlhdCI6MTc0NzM4OTE0OSwianRpIjoiMjE2MjA3YmYtZjA4OC00NzhlLWEyNmItZmU0OWFjOWJlZTM3IiwiY2xpZW50X2lkIjoiNzZhdjZjZThxamZkMW9lYm10dTRya21zdG0iLCJ1c2VybmFtZSI6ImFsZXh0YW4zMzMifQ.TNWx-Rm3xj9nR0TfzoLwbC5p9Qeh7gyJmHiaSkzZgLVzqX-TFg7hRASO76V8T4t3DBK3V7LWses4Ll6xPMpzXb_zdSzMygeFnZ8lw6ki1Wej-4922HmAC0QwfjyYUmOwjTnfxO4uX9CsHsGJtfuBgPaXlX4pjp2PdSN0M-2YzkLvLE6i_2EDHXEhcRt9ULpyFVVPsk28oN8TtB7U2eZU6YvwtqxhSDHI3szzigzeEMaohtpBOAumrLev93uRZgfNy_9JDQ8T959Mq1Y9JtZdsqIlwEJ66yOBN2Qcq5JNITfpRNbWeZA-uw22pkf_JyCTbLaKodeNHGTw1GMsyhx9lg",
    "ExpiresIn": 3600,
    "TokenType": "Bearer",
    "RefreshToken": null,
    "IdToken": "eyJraWQiOiJsbGNGOW5cLzRhYXJqbDR0RUtrVDFcLzN0WWJuakk0V21ESXhBbXYwT2t5TjQ9IiwiYWxnIjoiUlMyNTYifQ.eyMmEtYWFiNi04MjZkZF92ZXJpZmllZCI6ZmFsc2UsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5hcC1zb3V0aGVhc3QtMS5hbWF6b25hd3MuY29tXC9hcC1zb3V0aGVhc3QtMV81RUVuajVMOXkiLCJwaG9uZV9udW1iZXJfdmVyaWZpZWQiOnRydWUsImNvZ25pdG86dXNlcm5hbWUiOiJhbGV4dGFuMzMzIiwiYXVkIjoiNzZhdjZjZThxamZkMW9lYm10dTRya21zdG0iLCJldmVudF9pZCI6IjUyOGE3NGU3LTYyYmEtNDBmZi1iODM2LTA2OTRmYjIwYjJhYiIsInRva2VuX3VzZSI6ImlkIiwiYXV0aF90aW1lIjoxNzQ3Mzg5MDgwLCJuYW1lIjoiQWxleCIsInBob25lX251bWJlciI6Iis2MDE0MjIwNDg4NyIsImV4cCI6MTc0NzM5Mjc0OSwiaWF0IjoxNzQ3Mzg5MTQ5LCJlbWFpbCI6ImFsZXgudGFuZmdAZ21haWwuY29tIn0.MoZoaV-Se1cjdmpU5eV1yd88GYGfgEru8Eg_YDFh4tQVNHyjaHXFUl_EAR97T6Iko9_PJFO13Zf3MQ4-faqPh3PQhT5OmhQUVrxREsf5KBefsf1K61Ul5_Bvfk2qIaDuJ4uAfRyhyw_pb2jwUzLOyEZcV2CtGGr_dO1KPNfrrUovwdZsrT3I5LzR3ss-u-M6Bk5IyFCcy4Pkt-u-GNMo3MN2Nsc_T368NzaDvKTsriISWt_UIXiX8OEY5A0uEPSLTNn-9hGx2M_7TiA3wEFvfDSNGkQqOWj7yCZ8cwiPKxrjj3Rlzwtbm2Xljxk09pRRf7IhxT0LzQrKCbvFNKnOHg"
  }
}

Response 401

json
{
    "message": "Invalid Refresh Token"
}

IIMMPACT API Documentation