Verify OTP and return customer session
curl --request POST \
--url https://api.zupy.com/api/v2/auth/verify-otp/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"identifier": "<string>",
"otp_code": "<string>"
}
'import requests
url = "https://api.zupy.com/api/v2/auth/verify-otp/"
payload = {
"identifier": "<string>",
"otp_code": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: '<string>', otp_code: '<string>'})
};
fetch('https://api.zupy.com/api/v2/auth/verify-otp/', 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.zupy.com/api/v2/auth/verify-otp/",
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([
'identifier' => '<string>',
'otp_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.zupy.com/api/v2/auth/verify-otp/"
payload := strings.NewReader("{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-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.zupy.com/api/v2/auth/verify-otp/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/auth/verify-otp/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_id": "2awTHloSJX7kGGprFerOOsvABcd",
"is_new": false,
"otp_session": "abc123def456...",
"full_name": "João Silva",
"points_balance": 150,
"tier": "silver"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authentication
Verify OTP and return customer session
Verify OTP code and return session token with customer data. Creates customer if new. Session token valid for 30 minutes. Authentication via X-API-Key header (partner API key).
POST
/
api
/
v2
/
auth
/
verify-otp
/
Verify OTP and return customer session
curl --request POST \
--url https://api.zupy.com/api/v2/auth/verify-otp/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"identifier": "<string>",
"otp_code": "<string>"
}
'import requests
url = "https://api.zupy.com/api/v2/auth/verify-otp/"
payload = {
"identifier": "<string>",
"otp_code": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({identifier: '<string>', otp_code: '<string>'})
};
fetch('https://api.zupy.com/api/v2/auth/verify-otp/', 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.zupy.com/api/v2/auth/verify-otp/",
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([
'identifier' => '<string>',
'otp_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.zupy.com/api/v2/auth/verify-otp/"
payload := strings.NewReader("{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-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.zupy.com/api/v2/auth/verify-otp/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/auth/verify-otp/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier\": \"<string>\",\n \"otp_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_id": "2awTHloSJX7kGGprFerOOsvABcd",
"is_new": false,
"otp_session": "abc123def456...",
"full_name": "João Silva",
"points_balance": 150,
"tier": "silver"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Headers
Partner API key
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Customer ID (KSUID or user PK)
True if customer was just created
Session token (30min TTL) for subsequent OTP-protected requests
Customer full name
Current points balance
Loyalty tier
⌘I