Product routes use X-API-Key. Billing, team, and API-key management use a dashboard login. POST /api/auth/token does not turn an API key into that login.

Authorize product calls with X-API-Key. The key only has the scopes you grant. Billing, team, and API-key management stay in the signed-in dashboard.

Sign up (dashboard or API)

Registration is multi-step so we can verify the owner’s mobile and email before the workspace is fully active. The hosted signup page runs this for you. If you call the API directly, follow the same order.

GET /api/auth/captcha — receive captchaId and an image. A person types the characters. The answer is not in the JSON. Server apps skip this and use an API key.
POST /api/auth/register — email, password, confirmPassword, name, tenantName, mobile, captchaId, captchaAnswer. Returns a registrationToken, not a full login.
POST /api/auth/mobile/send-otp then /mobile/verify-otp with that token.
POST /api/auth/email/send-verification-code then /email/verify.
POST /api/auth/login (or login OTP) to receive accessToken and refreshToken.

A 14-day trial starts with the workspace. When the trial ends, the workspace moves onto the Free plan with limited quotas — data is kept. Upgrade anytime from Billing.

API key, not login

Send X-API-Key for sessions, messages, inbox, contacts, campaigns, webhooks, usage, number check, and /api/external. The key only has the scopes you grant. Billing, team, and creating keys stay in the dashboard. Never put a secret key in a public browser.

POST/api/auth/token

API key session exchange

Rejected. An API key is not exchanged for a dashboard access token. Use X-API-Key on product routes.

URL: https://api.actiwapi.com/api/auth/token

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/token" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/token", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/token", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/token",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/token")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/token");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/auth/token");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/auth/token";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/token");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/token", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/token"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example403

{
  "success": false,
  "message": "API keys cannot be exchanged for a dashboard session."
}

Try in Swagger UI

GET/api/auth/captcha

Get captcha

Human login challenge. Returns captchaId and an SVG image. The characters are not in the response. Server integrations use X-API-Key and do not call this endpoint.

URL: https://api.actiwapi.com/api/auth/captcha

Auth: None

Code examples

curl -X GET "https://api.actiwapi.com/api/auth/captcha" \
  -H "Content-Type: application/json"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/captcha", {
    method: "GET",
    headers: {
    "Content-Type": "application/json"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/captcha", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.get(
    "https://api.actiwapi.com/api/auth/captcha",
    headers={
        "Content-Type": "application/json",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/captcha")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/captcha");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/auth/captcha");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/captcha";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.actiwapi.com/api/auth/captcha");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.actiwapi.com/api/auth/captcha", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/captcha"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": { "captchaId": "uuid", "image": "data:image/svg+xml;base64,...", "expiresInSeconds": 300 }
}

Try in Swagger UI

POST/api/auth/register

Register

Start signup. Returns a registrationToken used for mobile and email verification. Does not issue dashboard JWTs yet.

URL: https://api.actiwapi.com/api/auth/register

Auth: None

Request example

{
  "name": "Jane Doe",
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "confirmPassword": "SecurePass123!",
  "tenantName": "Acme Corp",
  "mobile": "919876543210",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/register" \
  -H "Content-Type: application/json"
  -d '{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/register", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({
  "name": "Jane Doe",
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "confirmPassword": "SecurePass123!",
  "tenantName": "Acme Corp",
  "mobile": "919876543210",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/register", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "Jane Doe",
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "confirmPassword": "SecurePass123!",
  "tenantName": "Acme Corp",
  "mobile": "919876543210",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/register",
    headers={
        "Content-Type": "application/json",
    },
    json={
  "name": "Jane Doe",
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "confirmPassword": "SecurePass123!",
  "tenantName": "Acme Corp",
  "mobile": "919876543210",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/register")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{  \"name\": \"Jane Doe\",  \"email\": \"owner@acme.com\",  \"password\": \"SecurePass123!\",  \"confirmPassword\": \"SecurePass123!\",  \"tenantName\": \"Acme Corp\",  \"mobile\": \"919876543210\",  \"captchaId\": \"uuid\",  \"captchaAnswer\": \"CBq32X\"}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/register");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/register", json_decode('{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/register";
var content = new StringContent("""
{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/register")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{  "name": "Jane Doe",  "email": "owner@acme.com",  "password": "SecurePass123!",  "confirmPassword": "SecurePass123!",  "tenantName": "Acme Corp",  "mobile": "919876543210",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/register", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/register"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"name\": \"Jane Doe\",  \"email\": \"owner@acme.com\",  \"password\": \"SecurePass123!\",  \"confirmPassword\": \"SecurePass123!\",  \"tenantName\": \"Acme Corp\",  \"mobile\": \"919876543210\",  \"captchaId\": \"uuid\",  \"captchaAnswer\": \"CBq32X\"}"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example201

{
  "success": true,
  "data": {
    "requiresVerification": true,
    "registrationToken": "jwt-registration-token",
    "nextStep": "mobile",
    "phoneMasked": "+91******3210",
    "emailMasked": "o***@acme.com"
  }
}

Try in Swagger UI

POST/api/auth/login

Login

Dashboard sign-in. Returns tokens for the website session. API integrations do not call this; they send X-API-Key.

URL: https://api.actiwapi.com/api/auth/login

Auth: None

Request example

{
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/login" \
  -H "Content-Type: application/json"
  -d '{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/login", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/login",
    headers={
        "Content-Type": "application/json",
    },
    json={
  "email": "owner@acme.com",
  "password": "SecurePass123!",
  "captchaId": "uuid",
  "captchaAnswer": "CBq32X"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/login")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{  \"email\": \"owner@acme.com\",  \"password\": \"SecurePass123!\",  \"captchaId\": \"uuid\",  \"captchaAnswer\": \"CBq32X\"}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/login");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/login", json_decode('{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/login";
var content = new StringContent("""
{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/login")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{  "email": "owner@acme.com",  "password": "SecurePass123!",  "captchaId": "uuid",  "captchaAnswer": "CBq32X"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/login", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/login"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"email\": \"owner@acme.com\",  \"password\": \"SecurePass123!\",  \"captchaId\": \"uuid\",  \"captchaAnswer\": \"CBq32X\"}"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": {
    "accessToken": "eyJhbG...",
    "refreshToken": "eyJhbG...",
    "expiresIn": "7d",
    "user": { "id": "uuid", "email": "owner@acme.com", "role": "owner" }
  }
}

Try in Swagger UI

POST/api/auth/refresh

Refresh token

Exchange a valid refresh token for a new access token.

URL: https://api.actiwapi.com/api/auth/refresh

Auth: None

Request example

{ "refreshToken": "eyJhbG..." }

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/refresh" \
  -H "Content-Type: application/json"
  -d '{ "refreshToken": "eyJhbG..." }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/refresh", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({ "refreshToken": "eyJhbG..." }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/refresh", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ "refreshToken": "eyJhbG..." }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/refresh",
    headers={
        "Content-Type": "application/json",
    },
    json={ "refreshToken": "eyJhbG..." },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/refresh")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{ \"refreshToken\": \"eyJhbG...\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/refresh");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{ "refreshToken": "eyJhbG..." }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/refresh", json_decode('{ "refreshToken": "eyJhbG..." }', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/refresh";
var content = new StringContent("""
{ "refreshToken": "eyJhbG..." }
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "refreshToken": "eyJhbG..." }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/refresh")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "refreshToken": "eyJhbG..." }`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/refresh", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/refresh"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"refreshToken\": \"eyJhbG...\" }"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": {
    "accessToken": "eyJhbG...",
    "refreshToken": "eyJhbG...",
    "expiresIn": "7d"
  }
}

Try in Swagger UI

POST/api/auth/logout

Logout

Invalidate the refresh token so it cannot mint new access tokens.

URL: https://api.actiwapi.com/api/auth/logout

Auth: None

Request example

{ "refreshToken": "eyJhbG..." }

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/logout" \
  -H "Content-Type: application/json"
  -d '{ "refreshToken": "eyJhbG..." }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/logout", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({ "refreshToken": "eyJhbG..." }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/logout", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ "refreshToken": "eyJhbG..." }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/logout",
    headers={
        "Content-Type": "application/json",
    },
    json={ "refreshToken": "eyJhbG..." },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/logout")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{ \"refreshToken\": \"eyJhbG...\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/logout");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{ "refreshToken": "eyJhbG..." }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/logout", json_decode('{ "refreshToken": "eyJhbG..." }', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/logout";
var content = new StringContent("""
{ "refreshToken": "eyJhbG..." }
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "refreshToken": "eyJhbG..." }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/logout")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "refreshToken": "eyJhbG..." }`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/logout", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/logout"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"refreshToken\": \"eyJhbG...\" }"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "message": "Logged out" }

Try in Swagger UI

POST/api/auth/forgot-password

Forgot password

Send a password-reset email if the address exists. Always returns success to avoid account enumeration.

URL: https://api.actiwapi.com/api/auth/forgot-password

Auth: None

Request example

{ "email": "owner@acme.com" }

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/forgot-password" \
  -H "Content-Type: application/json"
  -d '{ "email": "owner@acme.com" }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/forgot-password", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({ "email": "owner@acme.com" }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/forgot-password", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ "email": "owner@acme.com" }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/forgot-password",
    headers={
        "Content-Type": "application/json",
    },
    json={ "email": "owner@acme.com" },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/forgot-password")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{ \"email\": \"owner@acme.com\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/forgot-password");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{ "email": "owner@acme.com" }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/forgot-password", json_decode('{ "email": "owner@acme.com" }', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/forgot-password";
var content = new StringContent("""
{ "email": "owner@acme.com" }
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "email": "owner@acme.com" }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/forgot-password")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "email": "owner@acme.com" }`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/forgot-password", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/forgot-password"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"email\": \"owner@acme.com\" }"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "message": "If the email exists, a reset link was sent" }

Try in Swagger UI

POST/api/auth/reset-password

Reset password

Set a new password using the token from the reset email.

URL: https://api.actiwapi.com/api/auth/reset-password

Auth: None

Request example

{ "token": "hex-token", "password": "NewSecurePass123!" }

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/reset-password" \
  -H "Content-Type: application/json"
  -d '{ "token": "hex-token", "password": "NewSecurePass123!" }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/reset-password", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({ "token": "hex-token", "password": "NewSecurePass123!" }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/reset-password", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ "token": "hex-token", "password": "NewSecurePass123!" }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/reset-password",
    headers={
        "Content-Type": "application/json",
    },
    json={ "token": "hex-token", "password": "NewSecurePass123!" },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/reset-password")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{ \"token\": \"hex-token\", \"password\": \"NewSecurePass123!\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/reset-password");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{ "token": "hex-token", "password": "NewSecurePass123!" }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/reset-password", json_decode('{ "token": "hex-token", "password": "NewSecurePass123!" }', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/reset-password";
var content = new StringContent("""
{ "token": "hex-token", "password": "NewSecurePass123!" }
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "token": "hex-token", "password": "NewSecurePass123!" }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/reset-password")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "token": "hex-token", "password": "NewSecurePass123!" }`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/reset-password", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/reset-password"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"token\": \"hex-token\", \"password\": \"NewSecurePass123!\" }"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "message": "Password updated" }

Try in Swagger UI

GET/api/auth/profile

Get profile

Returns the authenticated user and account context.

URL: https://api.actiwapi.com/api/auth/profile

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X GET "https://api.actiwapi.com/api/auth/profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/profile", {
    method: "GET",
    headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/profile", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.get(
    "https://api.actiwapi.com/api/auth/profile",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer {accessToken}",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/profile")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {accessToken}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/profile");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Authorization: Bearer {accessToken}"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer {accessToken}',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/auth/profile");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");

var url = "https://api.actiwapi.com/api/auth/profile";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");
});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.actiwapi.com/api/auth/profile");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.actiwapi.com/api/auth/profile", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer {accessToken}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/profile"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
      .header("Authorization", "Bearer {accessToken}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": {
    "id": "uuid",
    "email": "owner@acme.com",
    "name": "Jane Doe",
    "role": "owner",
    "tenantId": "uuid",
    "tenantName": "Acme Corp"
  }
}

Try in Swagger UI

PUT/api/auth/profile

Update profile

Change display name or other profile fields for the current user.

URL: https://api.actiwapi.com/api/auth/profile

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{ "name": "Jane Doe" }

Code examples

curl -X PUT "https://api.actiwapi.com/api/auth/profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{ "name": "Jane Doe" }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/profile", {
    method: "PUT",
    headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
    body: JSON.stringify({ "name": "Jane Doe" }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/profile", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
  body: JSON.stringify({ "name": "Jane Doe" }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.put(
    "https://api.actiwapi.com/api/auth/profile",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer {accessToken}",
    },
    json={ "name": "Jane Doe" },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/profile")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Put.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {accessToken}"
request.body = "{ \"name\": \"Jane Doe\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/profile");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Authorization: Bearer {accessToken}"
    ],
    CURLOPT_POSTFIELDS => '{ "name": "Jane Doe" }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer {accessToken}',
];

$response = Http::withHeaders($headers)->withBody('{ "name": "Jane Doe" }', 'application/json')->put("https://api.actiwapi.com/api/auth/profile");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");

var url = "https://api.actiwapi.com/api/auth/profile";
var content = new StringContent("""
{ "name": "Jane Doe" }
""", Encoding.UTF8, "application/json");
var response = await client.PutAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "name": "Jane Doe" }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("PUT"), "https://api.actiwapi.com/api/auth/profile")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "name": "Jane Doe" }`)
	req, err := http.NewRequest("PUT", "https://api.actiwapi.com/api/auth/profile", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer {accessToken}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/profile"))
    .method("PUT", HttpRequest.BodyPublishers.ofString("{ \"name\": \"Jane Doe\" }"))
      .header("Content-Type", "application/json")
      .header("Authorization", "Bearer {accessToken}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "data": { "id": "uuid", "name": "Jane Doe" } }

Try in Swagger UI

POST/api/auth/change-password

Change password

Change password while logged in. Requires the current password.

URL: https://api.actiwapi.com/api/auth/change-password

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{
  "currentPassword": "SecurePass123!",
  "newPassword": "EvenMoreSecure123!"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/change-password" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/change-password", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
    body: JSON.stringify({
  "currentPassword": "SecurePass123!",
  "newPassword": "EvenMoreSecure123!"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/change-password", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {accessToken}"
  },
  body: JSON.stringify({
  "currentPassword": "SecurePass123!",
  "newPassword": "EvenMoreSecure123!"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/change-password",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer {accessToken}",
    },
    json={
  "currentPassword": "SecurePass123!",
  "newPassword": "EvenMoreSecure123!"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/change-password")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {accessToken}"
request.body = "{  \"currentPassword\": \"SecurePass123!\",  \"newPassword\": \"EvenMoreSecure123!\"}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/change-password");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Authorization: Bearer {accessToken}"
    ],
    CURLOPT_POSTFIELDS => '{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer {accessToken}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/change-password", json_decode('{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");

var url = "https://api.actiwapi.com/api/auth/change-password";
var content = new StringContent("""
{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", "Bearer {accessToken}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/change-password")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{  "currentPassword": "SecurePass123!",  "newPassword": "EvenMoreSecure123!"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/change-password", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer {accessToken}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/change-password"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"currentPassword\": \"SecurePass123!\",  \"newPassword\": \"EvenMoreSecure123!\"}"))
      .header("Content-Type", "application/json")
      .header("Authorization", "Bearer {accessToken}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "message": "Password changed" }

Try in Swagger UI

POST/api/auth/login/send-otp

Resend login OTP

Resend the mobile OTP for an in-progress login challenge (after password login requires a second factor).

URL: https://api.actiwapi.com/api/auth/login/send-otp

Auth: None

Request example

{ "loginChallengeToken": "token-from-login" }

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/login/send-otp" \
  -H "Content-Type: application/json"
  -d '{ "loginChallengeToken": "token-from-login" }'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/login/send-otp", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({ "loginChallengeToken": "token-from-login" }),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/login/send-otp", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ "loginChallengeToken": "token-from-login" }),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/login/send-otp",
    headers={
        "Content-Type": "application/json",
    },
    json={ "loginChallengeToken": "token-from-login" },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/login/send-otp")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{ \"loginChallengeToken\": \"token-from-login\" }"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/login/send-otp");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{ "loginChallengeToken": "token-from-login" }',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/login/send-otp", json_decode('{ "loginChallengeToken": "token-from-login" }', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/login/send-otp";
var content = new StringContent("""
{ "loginChallengeToken": "token-from-login" }
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{ "loginChallengeToken": "token-from-login" }
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/login/send-otp")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{ "loginChallengeToken": "token-from-login" }`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/login/send-otp", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/login/send-otp"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"loginChallengeToken\": \"token-from-login\" }"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{ "success": true, "data": { "phoneMasked": "+91******3210" } }

Try in Swagger UI

POST/api/auth/login/verify-otp

Verify login OTP

Complete a login challenge with the SMS/WhatsApp OTP (or Firebase ID token).

URL: https://api.actiwapi.com/api/auth/login/verify-otp

Auth: None

Request example

{
  "loginChallengeToken": "token-from-login",
  "otpCode": "123456"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/auth/login/verify-otp" \
  -H "Content-Type: application/json"
  -d '{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/auth/login/verify-otp", {
    method: "POST",
    headers: {
    "Content-Type": "application/json"
  },
    body: JSON.stringify({
  "loginChallengeToken": "token-from-login",
  "otpCode": "123456"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/auth/login/verify-otp", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "loginChallengeToken": "token-from-login",
  "otpCode": "123456"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/auth/login/verify-otp",
    headers={
        "Content-Type": "application/json",
    },
    json={
  "loginChallengeToken": "token-from-login",
  "otpCode": "123456"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/auth/login/verify-otp")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request.body = "{  \"loginChallengeToken\": \"token-from-login\",  \"otpCode\": \"123456\"}"

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

$ch = curl_init("https://api.actiwapi.com/api/auth/login/verify-otp");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => '{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/auth/login/verify-otp", json_decode('{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();


var url = "https://api.actiwapi.com/api/auth/login/verify-otp";
var content = new StringContent("""
{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{

});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/auth/login/verify-otp")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

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

func main() {
	payload := []byte(`{  "loginChallengeToken": "token-from-login",  "otpCode": "123456"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/auth/login/verify-otp", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/auth/login/verify-otp"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"loginChallengeToken\": \"token-from-login\",  \"otpCode\": \"123456\"}"))
      .header("Content-Type", "application/json")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": { "accessToken": "eyJhbG...", "refreshToken": "eyJhbG...", "expiresIn": "7d" }
}

Try in Swagger UI

Error codes

Failed requests return a JSON envelope with success: false and a human-readable message.

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "phone": "Valid phone number is required"
  }
}

HTTP	Code	Description
400	VALIDATION_ERROR	Request body or query failed validation.
401	UNAUTHORIZED	Missing or invalid JWT / API key.
403	FORBIDDEN	Authenticated but lacking permission or entitlement.
403	SUBSCRIPTION_INACTIVE	Action not allowed on the current plan (including Free after trial). Upgrade or wait for entitlements.
403	LIMIT_EXCEEDED	Plan limit reached (sessions, messages, API requests, etc.).
404	NOT_FOUND	Resource does not exist or is not in your account.
409	CONFLICT	Duplicate resource or invalid state transition.
429	RATE_LIMITED	Too many requests; retry after backoff.
500	INTERNAL_ERROR	Unexpected server error.
502	WHATSAPP_UNAVAILABLE	WhatsApp session disconnected or provider error.