API

ScaSession

A strong customer authentication session.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method	Route	SDK operation	Returns
`POST`	`/profiles/{profileId}/sca-sessions/authorise`	`create`	A list of challenges to clear SCA

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

created, err := client.ScaSession(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local created, err = client:ScaSession():create({ profile_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$created = $client->ScaSession()->create(["profile_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

created = client.ScaSession().create({ "profile_id": 1 })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

created = client.ScaSession.create({ "profile_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const created = await client.ScaSession().create({ profile_id: 1 })

Fields

Field	Type	Required	Description

create

`POST` /profiles/{profileId}/sca-sessions/authorise

Operation ID: scaSessionCreate.

Authentication: bearer token (UserToken).

Parameters

Parameter	In	Type	Required	Description
`profileId`	`path`	`integer (int64)`	Yes	The profile ID.
`X-External-Correlation-Id`	`header`	`string (uuid)`	No	Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: A list of challenges to clear SCA

application/json

Property	Type	Required	Description
`oneTimeTokenProperties`	`object`	No	A one-time token is generated when accessing an endpoint secured by SCA. This token includes a list of all available challenges to complete. You can use the OTT status endpoint to view challenges and their statuses, or use create SCA session to manually trigger SCA and return a one-time token.
`oneTimeTokenProperties.challenges`	`array of object`	No	An array of challenges.
`oneTimeTokenProperties.challenges[].passed`	`boolean`	No	The status of a challenge.
`oneTimeTokenProperties.challenges[].primaryChallenge`	`object`	No
`oneTimeTokenProperties.challenges[].primaryChallenge.type`	`string`	No	A type of challenge.
`oneTimeTokenProperties.oneTimeToken`	`string (uuid)`	No	A one-time token unique identifier.
`oneTimeTokenProperties.validity`	`integer`	No	The One-Time Token expiration in seconds.

429: Rate limit exceeded. Retry after the number of seconds specified in the `Retry-After` header