Skip to main content
POST
/
user-authenticators
/
totp
Start Authenticator App Enrollment
curl --request POST \
  --url https://api.authsignal.com/v1/client/user-authenticators/totp \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.authsignal.com/v1/client/user-authenticators/totp"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.authsignal.com/v1/client/user-authenticators/totp', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.authsignal.com/v1/client/user-authenticators/totp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.authsignal.com/v1/client/user-authenticators/totp"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.authsignal.com/v1/client/user-authenticators/totp")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.authsignal.com/v1/client/user-authenticators/totp")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "userAuthenticatorId": "<string>",
  "userId": "<string>",
  "uri": "<string>",
  "secret": "<string>"
}
{
  "error": "<string>",
  "errorDescription": "<string>"
}
{
  "error": "<string>",
  "errorDescription": "<string>",
  "errorCode": "<string>"
}
{
  "error": "<string>",
  "errorDescription": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Response

OK

​
userAuthenticatorId
string

The ID of the TOTP authenticator which has been created but not yet verified.

​
userId
string
​
uri
string

A URI which can be converted into a QR code and scanned by an authenticator app.

​
secret
string

A secret which can be manually entered into an authenticator app. Typically presented as a backup option if the user is unable to scan the QR code.