API

ScaDeviceFingerprint

A device fingerprint, for strong customer authentication.

Operations

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

Method Route SDK operation Returns
POST /profiles/{profileId}/device-fingerprints create The device fingerprint has been successfully created
DELETE /profiles/{profileId}/device-fingerprints/{deviceFingerprintId} remove The device fingerprint has been deleted

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.ScaDeviceFingerprint(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
removed, err := client.ScaDeviceFingerprint(nil).Remove(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(removed)

Lua

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

local created, err = client:ScaDeviceFingerprint():create({ profile_id = 1 })
local removed, err = client:ScaDeviceFingerprint():remove({ id = "example_id", profile_id = 1 })

PHP

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

$created = $client->ScaDeviceFingerprint()->create(["profile_id" => 1]);
$client->ScaDeviceFingerprint()->remove(["id" => "example_id", "profile_id" => 1]);

Python

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

created = client.ScaDeviceFingerprint().create({ "profile_id": 1 })
client.ScaDeviceFingerprint().remove({"id": "example_id", "profile_id": 1})

Ruby

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

created = client.ScaDeviceFingerprint.create({ "profile_id" => 1 })
client.ScaDeviceFingerprint.remove({ "id" => "example_id", "profile_id" => 1 })

TypeScript

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

const created = await client.ScaDeviceFingerprint().create({ profile_id: 1 })
await client.ScaDeviceFingerprint().remove({ id: "example_id", profile_id: 1 })

Fields

Field Type Required Description
createdAt string No The device fingerprint creation timestamp.
deviceFingerprintId string No The identifier of the device fingerprint.
id string No Id

create

POST /profiles/{profileId}/device-fingerprints

Operation ID: scaDeviceFingerprintCreate.

Authentication: bearer token (UserToken).

Parameters

Parameter In Type Required Description
profileId path integer (int64) Yes The profile ID.
Accept-Encoding header string Yes
Content-Encoding header string Yes
X-tw-jose-method header string Yes
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.

Request body

application/jose+json

The request body is string.

Example request body:

"<JWE encrypted string>"

Responses

200: The device fingerprint has been successfully created

application/json

Property Type Required Description
createdAt string (date-time) No The device fingerprint creation timestamp.
deviceFingerprintId string (uuid) No The identifier of the device fingerprint.

Example response:

{
  "createdAt": "2025-05-24T07:27:58.273205554Z",
  "deviceFingerprintId": "636a5514-aa86-4719-8700-e9a9a0ae7ea7"
}
400: Maximum number of device fingerprints reached (default is 3)
409: The device fingerprint has already been created
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

remove

DELETE /profiles/{profileId}/device-fingerprints/{deviceFingerprintId}

Operation ID: scaDeviceFingerprintDelete.

Authentication: bearer token (UserToken).

Parameters

Parameter In Type Required Description
profileId path integer (int64) Yes The profile ID.
deviceFingerprintId path string (uuid) Yes The device fingerprint 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

204: The device fingerprint has been deleted
404: The device fingerprint ID does not exist
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.