curl --request POST \
--url https://api.starkfi.io/security/email/verify-otp \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data '{"email":"user@example.com","code":"123456"}'
const response = await fetch("https://api.starkfi.io/security/email/verify-otp", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "<api_key>",
},
body: JSON.stringify({ email: "user@example.com", code: "123456" }),
});
const data = await response.json();
import requests
response = requests.post(
"https://api.starkfi.io/security/email/verify-otp",
headers={"Content-Type": "application/json", "x-api-key": "<api_key>"},
json={"email": "user@example.com", "code": "123456"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "email_verified",
"message": "Email verified successfully"
}
{
"statusCode": 400,
"success": false,
"status": "missing_params",
"message": "email and code are required"
}
{
"statusCode": 400,
"success": false,
"status": "otp_invalid",
"message": "Invalid code"
}
{
"statusCode": 400,
"success": false,
"status": "otp_expired",
"message": "Code expired, please request a new one"
}
{
"statusCode": 400,
"success": false,
"status": "otp_max_attempts",
"message": "Max attempts reached, please request a new code"
}
{
"statusCode": 404,
"success": false,
"status": "user_not_found",
"message": "User not found in whitelist"
}
{
"statusCode": 400,
"success": false,
"status": "email_already_verified",
"message": "Email is already verified"
}
{
"statusCode": 500,
"success": false,
"status": "server_error",
"message": "Server failed, try again later"
}
KYC
Verify email OTP (KYC)
Validate the email OTP so the user can create a KYC session.
POST
/
security
/
email
/
verify-otp
curl --request POST \
--url https://api.starkfi.io/security/email/verify-otp \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data '{"email":"user@example.com","code":"123456"}'
const response = await fetch("https://api.starkfi.io/security/email/verify-otp", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "<api_key>",
},
body: JSON.stringify({ email: "user@example.com", code: "123456" }),
});
const data = await response.json();
import requests
response = requests.post(
"https://api.starkfi.io/security/email/verify-otp",
headers={"Content-Type": "application/json", "x-api-key": "<api_key>"},
json={"email": "user@example.com", "code": "123456"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "email_verified",
"message": "Email verified successfully"
}
{
"statusCode": 400,
"success": false,
"status": "missing_params",
"message": "email and code are required"
}
{
"statusCode": 400,
"success": false,
"status": "otp_invalid",
"message": "Invalid code"
}
{
"statusCode": 400,
"success": false,
"status": "otp_expired",
"message": "Code expired, please request a new one"
}
{
"statusCode": 400,
"success": false,
"status": "otp_max_attempts",
"message": "Max attempts reached, please request a new code"
}
{
"statusCode": 404,
"success": false,
"status": "user_not_found",
"message": "User not found in whitelist"
}
{
"statusCode": 400,
"success": false,
"status": "email_already_verified",
"message": "Email is already verified"
}
{
"statusCode": 500,
"success": false,
"status": "server_error",
"message": "Server failed, try again later"
}
string
required
Your StarkFi API key when required by your environment.
string
required
Same email used for send OTP.
string
required
One-time code received by the user.
curl --request POST \
--url https://api.starkfi.io/security/email/verify-otp \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data '{"email":"user@example.com","code":"123456"}'
const response = await fetch("https://api.starkfi.io/security/email/verify-otp", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "<api_key>",
},
body: JSON.stringify({ email: "user@example.com", code: "123456" }),
});
const data = await response.json();
import requests
response = requests.post(
"https://api.starkfi.io/security/email/verify-otp",
headers={"Content-Type": "application/json", "x-api-key": "<api_key>"},
json={"email": "user@example.com", "code": "123456"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "email_verified",
"message": "Email verified successfully"
}
{
"statusCode": 400,
"success": false,
"status": "missing_params",
"message": "email and code are required"
}
{
"statusCode": 400,
"success": false,
"status": "otp_invalid",
"message": "Invalid code"
}
{
"statusCode": 400,
"success": false,
"status": "otp_expired",
"message": "Code expired, please request a new one"
}
{
"statusCode": 400,
"success": false,
"status": "otp_max_attempts",
"message": "Max attempts reached, please request a new code"
}
{
"statusCode": 404,
"success": false,
"status": "user_not_found",
"message": "User not found in whitelist"
}
{
"statusCode": 400,
"success": false,
"status": "email_already_verified",
"message": "Email is already verified"
}
{
"statusCode": 500,
"success": false,
"status": "server_error",
"message": "Server failed, try again later"
}
⌘I
.png?fit=max&auto=format&n=I_v6ul4JDafNKFQP&q=85&s=f0ad25536f8a3ca42331fcff88ab2b26)