Generate access token for protected actions using credentials

POST

Path parameters

brandCodeenumRequired
Allowed values: nibaunibnztidauwn

Request

This endpoint expects an object.
grant_typestringRequired

Use “password” to authenticate with credentials, and “refresh_token” to renew the access_token.

client_idstringRequired

The Id of the type of client authenticating, e.g. “InternalApi”, “ngPublicApp”, “mobileApp”, “ngUnderwriterApp”. Required for both the “refresh_token” and “password” grant_types.

usernamestringOptional

The user’s login. In most cases this is the user’s email address. Required when using the “password” grant_type.

passwordstringOptional

The user’s password. Required when using the “password” grant_type.

customerInterfaceIdstringOptional

The client user interface type Id. Values to choose from are 1 (Public website), 2 (CSC website), 3 (Mobile app), 5 (Partner website) and 6 (Underwriter website). Required when using the “password” grant_type.

userTypeIdstringOptional

The type id of the user trying to authenticate. Defaults to 1 (customer). Other values are 2 (Employee), 3 (Assistance Provider), 4 (Partner), 5 (Underwriter).

refresh_tokenstringOptional

The refresh token to use for renewal of the access token. Required when using the “refresh_token” grant_type.

Response

Authentication result

access_tokenstring
token_typestring
expires_ininteger

Seconds until expiry.

Built with