Verify OTP (One-time passcode)
curl --request POST \
--url https://api.moonkey.fun/v1/auth/otps/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"otp": "829994",
"session_expires_in": 100,
"device_fingerprint": {
"ip": "123.2.1.1"
}
}
'import requests
url = "https://api.moonkey.fun/v1/auth/otps/verify"
payload = {
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"otp": "829994",
"session_expires_in": 100,
"device_fingerprint": { "ip": "123.2.1.1" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method_id: 'pn_24oXBLRv6BoHXbNZoTAZkAFlRsy',
otp: '829994',
session_expires_in: 100,
device_fingerprint: {ip: '123.2.1.1'}
})
};
fetch('https://api.moonkey.fun/v1/auth/otps/verify', 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.moonkey.fun/v1/auth/otps/verify",
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([
'method_id' => 'pn_24oXBLRv6BoHXbNZoTAZkAFlRsy',
'otp' => '829994',
'session_expires_in' => 100,
'device_fingerprint' => [
'ip' => '123.2.1.1'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.moonkey.fun/v1/auth/otps/verify"
payload := strings.NewReader("{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.moonkey.fun/v1/auth/otps/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moonkey.fun/v1/auth/otps/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"method_type": "phone_number",
"user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
"session_token": "7hssInGtOjKGUh8w7T4NjgLIKKSw6UdZ8uOduBYmJzrtfV6GrNtaUYoGehRS6jBh",
"session": {
"id": "sess_24tZ6tlJ7CxlTwB6Zoj6SHQ9vU3",
"user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
"session_token": "7hssInGtOjKGUh8w7T4NjgLIKKSw6UdZ8uOduBYmJzrtfV6GrNtaUYoGehRS6jBh",
"started_at": 1643496805,
"expires_at": 1643502805,
"last_active_at": 1643496805,
"factors": [
{
"delivery_channel": "sms",
"type": "otp",
"method": {
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"method_type": "phone_number",
"phone_number_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"phone_number": "+14152222222",
"last_verified_at": 1643496805
}
}
],
"device_fingerprint": {
"user_agent": "",
"ip": "123.2.1.1"
},
"updated_at": 1643496805,
"created_at": 1643496805
}
}OTPs
Verify OTP (One-time passcode)
Verify an OTP (one-time passcode) against a method ID (email, phone number) to authenticate the user. This endpoints verifies that the OTP sent in is valid for the given method ID.
Returns
A successful response returns an object with method_id, method_type, and verified user_id properties.
POST
/
v1
/
auth
/
otps
/
verify
Verify OTP (One-time passcode)
curl --request POST \
--url https://api.moonkey.fun/v1/auth/otps/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"otp": "829994",
"session_expires_in": 100,
"device_fingerprint": {
"ip": "123.2.1.1"
}
}
'import requests
url = "https://api.moonkey.fun/v1/auth/otps/verify"
payload = {
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"otp": "829994",
"session_expires_in": 100,
"device_fingerprint": { "ip": "123.2.1.1" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method_id: 'pn_24oXBLRv6BoHXbNZoTAZkAFlRsy',
otp: '829994',
session_expires_in: 100,
device_fingerprint: {ip: '123.2.1.1'}
})
};
fetch('https://api.moonkey.fun/v1/auth/otps/verify', 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.moonkey.fun/v1/auth/otps/verify",
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([
'method_id' => 'pn_24oXBLRv6BoHXbNZoTAZkAFlRsy',
'otp' => '829994',
'session_expires_in' => 100,
'device_fingerprint' => [
'ip' => '123.2.1.1'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.moonkey.fun/v1/auth/otps/verify"
payload := strings.NewReader("{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.moonkey.fun/v1/auth/otps/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moonkey.fun/v1/auth/otps/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method_id\": \"pn_24oXBLRv6BoHXbNZoTAZkAFlRsy\",\n \"otp\": \"829994\",\n \"session_expires_in\": 100,\n \"device_fingerprint\": {\n \"ip\": \"123.2.1.1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"method_type": "phone_number",
"user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
"session_token": "7hssInGtOjKGUh8w7T4NjgLIKKSw6UdZ8uOduBYmJzrtfV6GrNtaUYoGehRS6jBh",
"session": {
"id": "sess_24tZ6tlJ7CxlTwB6Zoj6SHQ9vU3",
"user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
"session_token": "7hssInGtOjKGUh8w7T4NjgLIKKSw6UdZ8uOduBYmJzrtfV6GrNtaUYoGehRS6jBh",
"started_at": 1643496805,
"expires_at": 1643502805,
"last_active_at": 1643496805,
"factors": [
{
"delivery_channel": "sms",
"type": "otp",
"method": {
"method_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"method_type": "phone_number",
"phone_number_id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
"phone_number": "+14152222222",
"last_verified_at": 1643496805
}
}
],
"device_fingerprint": {
"user_agent": "",
"ip": "123.2.1.1"
},
"updated_at": 1643496805,
"created_at": 1643496805
}
}Authorizations
Auth Platform API includes all the Auth related features. All Users, Phone Numbers, Emails, and OTPs are associated with an App as the container.
Endpoints only accept App's Secret API keys other than certain endpoints that are used client side or via SDK that accept the public_token.
Authentication using App Api Key
Header:
Authorization: Bearer {api_key}
Authenticated Request
curl \
-X GET https://api.moonkey.fun/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2 \
-H "Authorization: Bearer sk_test_pRqweh3wvWmJAAVYv7Z0T5iPLzFM4ql0muoyQcjOxGeN3p1r"
Body
application/json
Method ID to verify the OTP against. This can either be the phone_number_id or email_id returned by the send or login or create endpoints.
Minimum string length:
1OTP received by the User.
Minimum string length:
1Device fingerprinting metadata for fraud detection during OTP code verification step. This is useful to ensure that the user who originated the request matches the user that verifies the token. Verification requirements can be enabled by matching fields in the device_fingerprint such as IP, User Agent or the combination of them (more fraud detection features coming soon!)
Show child attributes
Show child attributes
Optional Extend the session expiration time to N minutes from now, must be between 5 to 525600 minutes (365 days). This parameter will create a new session if there is no existing session along with a session_token and session_jwt. However, if a valid session_token or session_jwt is sent in, it will extend that session by the minutes specified. If not sent in, no session will be created by default.
Optional Unique session token to verify.
Optional Unique Session JWT to verify.
Response
200 - application/json
Verify OTP (One-time passcode) response
Method ID of the phone number or email.
Minimum string length:
1Method Type. Possible values: email, phone_number.
Minimum string length:
1User ID of the verified user.
Minimum string length:
1Show child attributes
Show child attributes