bcAuthorize

@FormUrlEncoded
@POST(value = "/{productType}/{apiVersion}/bc-authorize")
abstract suspend fun bcAuthorize(@Path(value = "productType") productType: String, @Path(value = "apiVersion") apiVersion: String, @Field(value = "login_hint") loginHint: String, @Field(value = "scope") scope: String, @Field(value = "access_type") accessType: String, @Header(value = "Ocp-Apim-Subscription-Key") productSubscriptionKey: String): Response<BcAuthorizeResponse>

Initiates a backchannel authorization (CIBA) request for the specified product type.

The response contains a BcAuthorizeResponse with an auth_req_id that must be used to poll for the access token once the user has approved the request on their device.

Return

A Response containing the BcAuthorizeResponse with the authorization request details.

Parameters

productType

The type of product initiating the authorization (e.g., collection).

apiVersion

The version of the API (e.g., v1_0).

loginHint

The account identifier hint in the format ID:{msisdn}/MSISDN (e.g. ID:563667/MSISDN).

scope

The OAuth2 scope being requested (e.g., profile openid).

accessType

The access type for the token (online or offline). Defaults to online.

productSubscriptionKey

The subscription key for the product.