Confirm OTP and Link Device to Organization

curl --request POST \
  --url https://api.getmelody.io/device/otp/confirm/v2 \
  --header 'Content-Type: application/json' \
  --header 'X-Org-Key: <x-org-key>' \
  --data '
{
  "otp": "123456"
}
'

import requests

url = "https://api.getmelody.io/device/otp/confirm/v2"

payload = { "otp": "123456" }
headers = {
    "X-Org-Key": "<x-org-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Org-Key': '<x-org-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({otp: '123456'})
};

fetch('https://api.getmelody.io/device/otp/confirm/v2', 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.getmelody.io/device/otp/confirm/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'otp' => '123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Org-Key: <x-org-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getmelody.io/device/otp/confirm/v2"

	payload := strings.NewReader("{\n  \"otp\": \"123456\"\n}")

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

	req.Header.Add("X-Org-Key", "<x-org-key>")
	req.Header.Add("Content-Type", "application/json")

	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.getmelody.io/device/otp/confirm/v2")
  .header("X-Org-Key", "<x-org-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"otp\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/device/otp/confirm/v2")

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

request = Net::HTTP::Post.new(url)
request["X-Org-Key"] = '<x-org-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"otp\": \"123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "device_key": "orbit-ranch-silver-tomato"
}

One-Time Password

Confirm OTP and Link Device to Organization

Confirm a one-time password, link device to organization, and receive a Device Key.

This endpoint returns a Device Key (4 BIP39 words) that identifies the device. The Device Key is stable: the same device always yields the same key.

Requires X-Org-Key header with a valid Developer Key to link the device to your organization.

Use the Device Key with /api/sessions/v2 to create a session token for API access.

Device Key Format

The Device Key consists of 4 BIP39 words separated by dashes:

orbit-ranch-silver-tomato

Flow

The user reads the 6-digit OTP from the device display and enters it in your app
This endpoint validates OTP and links device to your organization
Returns the Device Key
Create a session with POST /api/sessions/v2 using your Developer Key
Use the session token with X-Device-Key header to control the device

POST

device

otp

confirm

Confirm OTP and Link Device to Organization

curl --request POST \
  --url https://api.getmelody.io/device/otp/confirm/v2 \
  --header 'Content-Type: application/json' \
  --header 'X-Org-Key: <x-org-key>' \
  --data '
{
  "otp": "123456"
}
'

import requests

url = "https://api.getmelody.io/device/otp/confirm/v2"

payload = { "otp": "123456" }
headers = {
    "X-Org-Key": "<x-org-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Org-Key': '<x-org-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({otp: '123456'})
};

fetch('https://api.getmelody.io/device/otp/confirm/v2', 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.getmelody.io/device/otp/confirm/v2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'otp' => '123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Org-Key: <x-org-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getmelody.io/device/otp/confirm/v2"

	payload := strings.NewReader("{\n  \"otp\": \"123456\"\n}")

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

	req.Header.Add("X-Org-Key", "<x-org-key>")
	req.Header.Add("Content-Type", "application/json")

	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.getmelody.io/device/otp/confirm/v2")
  .header("X-Org-Key", "<x-org-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"otp\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/device/otp/confirm/v2")

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

request = Net::HTTP::Post.new(url)
request["X-Org-Key"] = '<x-org-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"otp\": \"123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "device_key": "orbit-ranch-silver-tomato"
}

Headers

X-Org-Key

string

required

Developer Key that identifies your organization

Example:

"MToxMjM0NTY3OC1hYmNkLTEyMzQtNTY3OC1hYmNkZWYxMjM0NTY"

Body

application/json

otp

string

required

The 6-digit one-time password displayed on the device.

Example:

"123456"

Response

Device linked successfully

Response containing a Device Key (public device identifier). The Device Key is a stable identifier for the device, consisting of 4 BIP39 words.

device_key

string

required

The Device Key in BIP39 word format. Format: 4 words separated by dashes (e.g., "orbit-ranch-silver-tomato"). This key is deterministic - the same device always produces the same key.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$

Example:

"orbit-ranch-silver-tomato"