Auth
POST
/users/auth
Overview
The Auth endpoint is used for authenticating a user within the Partner's ecosystem. It is primarily used when the Partner needs to verify and refresh a user's authentication credentials.
The main objectives of the Auth method are:
- User Authentication: It validates the refresh token that the Partner originally provided during the initialization of the WebFrame. This process confirms the user's identity and ensures that the authentication session is legitimate.
- Token Renewal: The method generates and returns a new, valid refresh token along with other user details. This updated token is essential for maintaining an active and secure session for the user.
- User Registration (if needed): If the user is not already present in the system, the method helps in registering the new user during the authentication process while ensuring that appropriate account parameters (such as PartnerUserId and CurrencyCode) are set.
- Session Integrity: By validating token authenticity and reissuing credentials, the method ensures that subsequent API calls are made by authenticated and authorized sessions, maintaining the overall security and data integrity within the BETCORE system.
In summary, the Auth endpoint is critical for securely managing user sessions by validating refresh tokens, reissuing updated tokens, and, if necessary, registering new users. This helps establish a trusted and consistent authentication flow between the Partner's client and the BETCORE API.
Request Parameters
Parameter | Data type | Description | Required | |
---|---|---|---|---|
JWT payload | ||||
data | json string | Request data. | Yes | |
RefreshToken | string | The refresh token that the Partner passed to the WebFrame when it was initialized. | Yes | |
TagId | number | Identification tag for an embedded iFrame page element; relevant for Partners using WebFrame as a client. See more on Tags. |
No |