AactokiDevelopers
⌘ K
Actoki API documentation

A practical reference for building reliable integrations.

Start with a small authenticated request, understand the failure modes and move to production with confidence.

53installed service families
270documented endpoint definitions
JSONconsistent request and response format

Quick start

Keep your permanent key in a server-side secret store. The example below checks a domain using a bearer token and JSON body. Replace the sample domain with data you are authorised to process.

cURL
export ACTOKI_API_KEY="your_server_side_key"

curl --request POST \
  --url https://actoki.com/v1/domain-guard/check \
  --header "Authorization: Bearer $ACTOKI_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"domain":"example.org"}'
1

Create an account

Use a named developer account rather than a shared login so ownership and audit history remain clear.

2

Generate and scope a key

Grant only the services required by the application and separate development credentials from production.

3

Handle all response classes

Expect success, validation errors, authentication failures, rate limits and transient upstream failures.

4

Monitor before launch

Add timeouts, structured logging, usage alerts and an ownership plan for rotation and incident response.

Authentication

Send the account API key using the bearer scheme. Permanent API keys are secrets: keep them in your server environment or managed secret store, never in browser JavaScript, public repositories, screenshots or support tickets.

HTTP
Authorization: Bearer YOUR_ACTOKI_API_KEY
Content-Type: application/json
Accept: application/json
One server-key model for Actoki APIs. All normal service APIs, including Domain Guard, use Authorization: Bearer sk_live_... or sk_test_.... Restrict a key to one or more services and optionally to specific IPs/CIDRs/hostnames. Secret server keys belong only on your backend/BFF; never embed them in browser JavaScript, mobile apps or distributed desktop binaries. Older dgc_.../dgs_... Domain Guard pairs are deprecated compatibility credentials and should be migrated to a standard server key.
Use separate credentials by environment. A development key should not have production data access. Rotate credentials when a developer leaves, a repository is exposed or an integration changes owner.

Secret server keys

Keys beginning with sk_live_ or sk_test_ authenticate server-to-server API requests. The full value is displayed once and stored by Actoki as a one-way hash. Restrict each key to the required services and trusted server IPs.

Publishable map keys

Browser-facing map credentials can be copied again because they are limited to protected map delivery and exact approved origins. They cannot authorize the general API catalogue.

Safe rotation

Create a replacement, deploy it, confirm successful traffic and let the old server key expire after a short grace period. Use immediate revocation whenever exposure is suspected.

Test without exposing secrets

The account API Explorer uses a temporary, service-scoped server credential that is revoked after every request. Permanent keys never enter browser JavaScript.

Node 18+
const controller = new AbortController();
const timeout = setTimeout(() => controller.abort(), 8000);

try {
  const response = await fetch('https://actoki.com/v1/domain-guard/check', {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.ACTOKI_API_KEY}`,
      'Content-Type': 'application/json',
      Accept: 'application/json'
    },
    body: JSON.stringify({ domain: 'example.org' }),
    signal: controller.signal
  });

  const payload = await response.json();
  if (!response.ok) throw new Error(payload.message || 'Actoki request failed');
  console.log(payload);
} finally {
  clearTimeout(timeout);
}
Actoki Identity

Log people into your website or app with OpenID Connect

Actoki Identity at auth.actoki.com is separate from the bearer API key above. Use OpenID Connect Authorization Code + PKCE S256 when real people sign in to your website, SPA, iOS/Android app or desktop application. Your application redirects the browser to Actoki, Actoki authenticates the person using the methods enabled for your workspace, and your application receives a short-lived authorization code. Your application never receives the user's password, OTP, authenticator seed or passkey private key.

Server website

Confidential client. Keep the client secret on the server only. Use Authorization Code + PKCE.

SPA / browser

Public client. No client secret in JavaScript. Use Authorization Code + PKCE.

Mobile / desktop

Public client. Use the system browser and PKCE. Never embed a confidential secret in the distributed app.

Backend system

No human. Use OAuth 2.0 Client Credentials with an API resource, audience and least-privilege scopes.

1. Register the customer application

Signed-in customers configure Identity under Account -> Identity & SSO. Create a Server website, SPA, Mobile or Desktop application, register exact callback and post-logout URLs, and choose the required scopes. Server websites and machine clients receive encrypted client secrets. Authorised workspace users can reveal them again after password re-authentication. Public SPA/mobile/desktop clients do not receive a secret.

Encrypted credential vault

Actoki-generated server API keys, confidential OIDC/M2M client secrets, API-resource introspection secrets and Forward Auth proxy secrets are authenticated using one-way hashes and separately stored as AES-256-GCM ciphertext for authorised reveal. The encryption keyring is held outside the database.

Reveal safely

Secret lists remain masked. Reveal requires an authorised signed-in user, CSRF protection and current-password re-authentication. Reveals are audited and protected pages are sent with no-store cache headers. Legacy hash-only credentials cannot be recovered; rotate them once to create a revealable encrypted credential.

Zero-downtime rotation

The replacement credential works immediately. Choose immediate cutover, 1 hour, 24 hours or 7 days of overlap. During overlap both the previous and replacement credentials authenticate. At the deadline the previous credential is rejected even before cleanup runs; maintenance then marks it retired and destroys its recoverable ciphertext while keeping audit metadata.

2. Redirect the user to Actoki

Generate fresh high-entropy state, nonce and a PKCE verifier for each login. Store them until the callback, then redirect the browser to the authorization endpoint.

OIDC authorization
https://auth.actoki.com/oauth2/authorize
  ?response_type=code
  &client_id=YOUR_CLIENT_ID
  &redirect_uri=https%3A%2F%2Fexample.com%2Fauth%2Fcallback
  &scope=openid%20profile%20email
  &state=RANDOM_STATE
  &nonce=RANDOM_NONCE
  &code_challenge=PKCE_S256_CHALLENGE
  &code_challenge_method=S256

3. Validate the callback and exchange the code

Actoki returns the browser only to an exact registered redirect URI with code and the original state. Reject missing or mismatched state. Exchange the one-time code at POST https://auth.actoki.com/oauth2/token using the original PKCE verifier. Confidential server apps send client_id and client_secret in the form body (client_secret_post); public apps send no secret.

4. Validate identity before logging the user into your application

Verify the RS256 ID-token signature using the tenant discovery/JWKS metadata, then require the exact tenant issuer, your client ID as audience, valid lifetime and the original nonce. Use the pair issuer + sub as the stable external identity mapping to your own user ID. Do not use email as the permanent primary key.

User provisioning is separate from login. In this release customer local users are created/invited through the Identity management API, while trusted federated identities can be auto-provisioned when the workspace enables that policy. The generic /register route is reserved for first-party Actoki registration; it is not a public self-signup endpoint for arbitrary customer tenants.

5. Administration and lifecycle

The Identity management API supports applications, redirects/scopes/status, confidential secret rotation and credential revocation, users, invitations, sessions, authentication policy, providers, security events and portability export. See the Identity and SSO API endpoints in the reference below. Machine-to-machine systems additionally use API resources, audiences, service accounts and client_credentials.

Responses and errors

Successful requests return JSON appropriate to the endpoint. Error responses use the HTTP status to describe the broad class of failure and a machine-readable code or message for handling and diagnosis.

400Invalid or incomplete input. Correct the request rather than retrying it unchanged.
401Missing, invalid or revoked credentials. Check the secret and environment.
403The account or key does not have permission for the requested service.
404The route or requested resource does not exist.
409The request conflicts with the current state. Use idempotency or refresh state where relevant.
422The request is valid JSON but one or more values cannot be processed.
429The request is rate limited. Respect Retry-After and add bounded backoff with jitter.
5xxA server or upstream dependency failed. Retry only safe operations and cap the total retry window.
Example error
{
  "ok": false,
  "error": "validation_failed",
  "message": "A valid domain is required.",
  "request_id": "req_..."
}

Rate limits and retries

Rate limiting protects customer accounts and shared capacity. Exact allowances can vary by endpoint and account configuration, so integrations should respond to the HTTP status and headers rather than relying on a hard-coded global threshold.

  • Use short connect and total timeouts appropriate to the user journey.
  • Retry only transient failures and idempotent operations.
  • Use exponential backoff with jitter and a firm attempt limit.
  • Respect Retry-After when it is present.
  • Queue background work instead of creating uncontrolled request bursts.
  • Contact support before planned high-volume migrations or backfills.
A 429 is a control signal, not an invitation to retry immediately. Repeated tight-loop retries increase load and can extend the incident for your application.

Protected maps for websites and mobile apps

Protected maps use a deliberately different credential flow from normal APIs. A permanent sk_live_… server key stays on your backend. Website embeds use a browser-visible publishable map key restricted to approved origins. Native apps use a short-lived, one-time WebView launch session created by your backend.

Permanent keys stay on your backendWebsite: approved origin + publishable key · Mobile: application ID + one-time launch session
Website integration

Embed a protected map on an approved website

  1. Create the map. Use Map embeds in the admin area, or call POST /v1/maps/embeds from your backend.
  2. Add exact origins. Enter the scheme and hostname only, for example https://www.example.com. Add staging and mobile subdomains separately.
  3. Copy the generated iframe. The publishable mepk_… key is safe to expose only because it is limited to that map, its approved origins and configured limits.
  4. Test the real hostname. A localhost, preview or alternate subdomain will be rejected unless it is explicitly approved.
  5. Manage the credential from Account → API credentials. View opens the secure, non-billable preview and the complete iframe instructions. Rotate invalidates the current key immediately. Delete revokes the key and active sessions while retaining historical usage statistics.
Responsive website iframe
<div style="position:relative;aspect-ratio:16/9;min-height:320px">
  <iframe
    src="https://maps.actoki.com/embed/MAP_ID?key=YOUR_PUBLISHABLE_MAP_KEY"
    title="Our location"
    loading="lazy"
    referrerpolicy="strict-origin-when-cross-origin"
    allow="fullscreen"
    style="position:absolute;inset:0;width:100%;height:100%;border:0;border-radius:16px"
  ></iframe>
</div>

Create a website map through the API

POST /v1/maps/embeds
curl --request POST \
  --url https://actoki.com/v1/maps/embeds \
  --header "Authorization: Bearer $ACTOKI_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: london-office-map-v1" \
  --data '{
    "name": "London office",
    "allowed_origins": ["https://www.example.com"],
    "location": {"latitude": 51.5074, "longitude": -0.1278},
    "region": "uk",
    "style": "actoki-light",
    "labels": "on",
    "zoom": {"initial": 15, "minimum": 12, "maximum": 18},
    "controls": {"zoom": true, "pan": true, "rotation": false, "fullscreen": true},
    "marker_label": "London office",
    "marker_colour": "#2563eb",
    "credits_per_load": 1,
    "daily_view_limit": 1000,
    "monthly_view_limit": 20000,
    "rate_limit_per_minute": 60,
    "active": true
  }'
Origin checks reduce hotlinking; they are not a substitute for authentication. Publishable keys are visible to visitors. Use short-lived sessions, sensible limits and usage alerts, and rotate a map credential if it is copied to an unauthorised site.
Native mobile integration

Open a protected map in iOS or Android

Do not whitelist a phone's changing IP address and do not package a permanent server key in the app. The customer's backend creates a one-time mobile session after authenticating its own user.

  1. Approve the application identifier on the protected map, for example ios:com.example.travelapp or android:com.example.travelapp.
  2. Your backend calls POST /v1/maps/mobile-sessions with its secret server key.
  3. Return only the temporary valueswebview_url and binding—to the signed-in app.
  4. Open the URL once in a WebView with the X-Actoki-Mobile-Binding request header. Actoki exchanges it for a secure host cookie and activates the map.
  5. Create a new session after expiry or failure. Launch sessions are deliberately short-lived and one-time.
Backend session request
curl --request POST \
  --url https://actoki.com/v1/maps/mobile-sessions \
  --header "Authorization: Bearer $ACTOKI_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "map_id": "me_example123",
    "platform": "ios",
    "application_id": "com.example.travelapp",
    "ttl": 180
  }'
Example response
{
  "ok": true,
  "credits_consumed": false,
  "billing": "deferred_until_map_activation",
  "session": {
    "webview_url": "https://maps.actoki.com/mobile/launch/...",
    "binding": "one-time-binding-value",
    "expires_at": "2026-08-03T19:22:00Z"
  }
}
WKWebView
import WebKit

let configuration = WKWebViewConfiguration()
configuration.websiteDataStore = .default()
let webView = WKWebView(frame: .zero, configuration: configuration)

var request = URLRequest(url: URL(string: session.webviewURL)!)
request.setValue(session.binding, forHTTPHeaderField: "X-Actoki-Mobile-Binding")
webView.load(request)
Recommended mobile hardening: authenticate the user before issuing a session, keep the response out of logs, require HTTPS, restrict navigation to Actoki map hosts, and add Apple App Attest or Google Play Integrity verification when the customer risk level justifies it.
Configuration reference

Available protected-map options

Area and appearanceregion, style, labels, workspace/company address, custom address or manual centre coordinates, plus initial/minimum/maximum zoom.
Interaction controlszoom, pan, rotation, fullscreen and fit_to_content.
MarkersPrimary marker label, colour and optional HTTPS logo URL, plus additional pins.
RoutesConnect pins, choose straight or curved lines and set the line colour.
BoundariesGeoJSON boundary, stroke colour, fill colour and fill opacity.
Delivery policyApproved website origins, approved mobile application IDs, active state, credential rotation and permanent soft deletion with retained usage history.
Commercial controlsCredits per successful load, daily/monthly load ceilings and per-minute activation limit.
Safe retriesUse an Idempotency-Key header when creating a map through the API.

The complete field-by-field definitions, default values, ranges and examples are listed under Maps API in the endpoint reference.

Usage, credits and errors

When a map load is charged

  • Creating or listing a protected map uses the endpoint's normal API units.
  • Creating a native launch session is abuse-metered but does not deduct map-load credits.
  • One successful non-preview browser or mobile activation records one /v1/maps/embed-load usage event.
  • Denied origins, invalid applications, crawler requests, failed bootstraps and previews do not create a successful map-load charge.
  • If credits are unavailable, the map displays a controlled “additional credits required” message and the activation is not partially charged.
Keep account API keys on trusted backends. Browser embeds use a publishable map key plus an exact allowed parent origin; private calls from maps.actoki.com use MAPS_SERVER_SECRET over HTTPS.

Service maturity

The reference distinguishes production-enabled endpoints from preview integrations that still depend on an external provider, durable worker or isolated inspection service. Preview endpoints remain visible for planning, but return HTTP 503 before usage is recorded or credits are consumed.

Preview means transparent, not billable. Build against the documented contract, but enable production traffic only after the dependency has been configured and verified in staging.

Security and abuse prevention

No single mechanism prevents every form of misuse. Use layered controls that reduce the value of a stolen key, limit the blast radius of mistakes and make unusual behaviour visible.

Least privilegeEnable only the services and actions the application needs.
Secret separationUse distinct development, staging and production credentials.
Rotation and revocationDocument ownership and respond quickly to suspected exposure.
Input constraintsValidate size, type, format and business rules before sending data.
Bounded retriesPrevent retry storms and duplicate side effects.
Usage monitoringAlert on unexpected volumes, origins or access patterns.
Data minimisationSend only the information required for the selected endpoint.
AuditabilityRetain request IDs and administrative events without logging secrets.
Never log bearer tokens, password-reset tokens or raw private documents. Redact sensitive values at the logging boundary and use request IDs to correlate events instead.

Production checklist

Complete these checks before sending customer traffic. They are intentionally operational: secure code can still fail when deployed with weak secrets, missing backups or incorrect proxy settings.

Credentials

Use generated secrets, environment-specific API keys, least privilege and a documented rotation owner.

Network and TLS

Enforce HTTPS, verify proxy trust, restrict administrative access and test the real production hostname.

Reliability

Set timeouts, bounded retries, health checks, queues where needed and alerting for failed background work.

Data protection

Minimise payloads, define retention, protect backups and test a restore rather than assuming one will work.

Observability

Record request IDs, endpoint outcomes and latency without storing secrets or unnecessary personal data.

Launch rehearsal

Test authentication, rate limits, webhooks, email, maps and failure paths from a production-like staging environment.

No service or endpoint matched that search.

API reference

The reference below is generated from the installed service manifests. Availability, permissions and metered units depend on the account and server configuration.

API category

Business

1 services · 5 endpoints
Business

Business Enrichment API

v1.0.0

Domain to company profiling, company name cleanup and social link extraction.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/business/website-profileWebsite profile 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Example: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domaindnsacompany_guess

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/business/website-profile?domain=example.com"
GET / POST /v1/business/domain-to-companyInfer company from domain 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Example: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domaincompany_guess

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/business/domain-to-company?domain=example.com"
GET / POST /v1/business/company-clean-nameClean company name 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Company name to normalise by removing common legal suffixes.Maximum 5000 charactersExample: Example Travel Limited

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/business/company-clean-name?name=Example+Travel+Limited"
GET / POST /v1/business/email-domain-profileEmail domain profile 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Example: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainhas_mxhas_website

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/business/email-domain-profile?domain=example.com"
GET / POST /v1/business/social-linksExtract social links from HTML 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded
OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON Yes HTML content to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

links

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/business/social-links?html=example"
API category

Business Data

2 services · 10 endpoints
Business Data

Company Registry API

v1.0.0

Search and retrieve official company-register records through a normalised Actoki interface. UK Companies House is production-enabled.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/companies/searchSearch UK companies by name and, through advanced search, address or postcode. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Human-readable name.Example: example
q stringquery or JSON No Request option: Q.Default: Example: example
address stringquery or JSON No Request option: Address.Default: Example: example
postcode stringquery or JSON No Request option: Postcode.Default: Example: example
page stringquery or JSON No Request option: Page.Default: 1Example: 1
per_page stringquery or JSON No Request option: Per Page.Default: 20Example: 20

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessagecompany_namelocationsizestart_indexqitems_per_pageproviderjurisdictionquerynameaddresspostcodepaginationpageper_pagetotalresultsretrieved_at

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/search?name=example&q=example&address=example"
GET / POST /v1/companies/profileRetrieve an official company profile by company number. 4 units
Authentication Bearer server key Methods GET / POST Cost 4 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Company-register jurisdiction. The installed production connector currently supports GB/UK.Default: GB · Options: GB, UKExample: GB
company_number stringquery or JSON Yes Official company registration number.Maximum 20 charactersExample: 01234567

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/profile?jurisdiction=GB&company_number=01234567"
GET / POST /v1/companies/officersRetrieve company officers. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Company-register jurisdiction. The installed production connector currently supports GB/UK.Default: GB · Options: GB, UKExample: GB
company_number stringquery or JSON Yes Official company registration number.Maximum 20 charactersExample: 01234567

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/officers?jurisdiction=GB&company_number=01234567"
GET / POST /v1/companies/pscRetrieve persons with significant control. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Company-register jurisdiction. The installed production connector currently supports GB/UK.Default: GB · Options: GB, UKExample: GB
company_number stringquery or JSON Yes Official company registration number.Maximum 20 charactersExample: 01234567

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/psc?jurisdiction=GB&company_number=01234567"
GET / POST /v1/companies/filing-historyRetrieve filing history. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Company-register jurisdiction. The installed production connector currently supports GB/UK.Default: GB · Options: GB, UKExample: GB
company_number stringquery or JSON Yes Official company registration number.Maximum 20 charactersExample: 01234567

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/filing-history?jurisdiction=GB&company_number=01234567"
GET / POST /v1/companies/chargesRetrieve registered charges. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Company-register jurisdiction. The installed production connector currently supports GB/UK.Default: GB · Options: GB, UKExample: GB
company_number stringquery or JSON Yes Official company registration number.Maximum 20 charactersExample: 01234567

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/charges?jurisdiction=GB&company_number=01234567"
GET /v1/companies/sourcesList company-register providers and coverage. 1 units
Authentication Bearer server key Methods GET Cost 1 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/companies/sources"
Business Data

Trade Mark Registry API

v1.0.0

Search official trade-mark sources through a consistent interface, with EUIPO search and USPTO known-record support plus safe UK IPO source discovery.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/trademarks/searchSearch EU trade marks; return an official UK IPO search link where machine access is not licensed. 6 units
Authentication Bearer server key Methods GET / POST Cost 6 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Trade-mark jurisdiction.Default: EU · Options: EU, GB, UK, USExample: EU
name stringquery or JSON Yes Word mark or name to search.Example: ACTOKI
q stringquery or JSON No Alias for name.Example: ACTOKI
owner stringquery or JSON No Applicant or owner filter.Example: Example Ltd
status stringquery or JSON No Provider status filter.Example: registered
page integerquery or JSON No Zero-based result page.Default: 0 · Min: 0Example: 0
per_page integerquery or JSON No Results per page.Default: 20 · Min: 1 · Max: 100Example: 20

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/trademarks/search?jurisdiction=EU&name=ACTOKI&q=ACTOKI"
GET / POST /v1/trademarks/profileRetrieve EUIPO or USPTO trade-mark record details. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jurisdiction stringquery or JSON No Trade-mark jurisdiction.Default: EU · Options: EU, USExample: EU
application_number stringquery or JSON No EUIPO application number; required for EU records.Example: 018123456
serial_number stringquery or JSON No USPTO serial number; required for US records when registration_number is omitted.Example: 98765432
registration_number stringquery or JSON No USPTO registration number; alternative to serial_number.Example: 7654321

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Important behaviour

  • Use application_number for EU records. Use serial_number or registration_number for US records.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/trademarks/profile?jurisdiction=EU&application_number=018123456&serial_number=98765432"
GET /v1/trademarks/sourcesList supported official trade-mark providers and integration status. 1 units
Authentication Bearer server key Methods GET Cost 1 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/trademarks/sources"
API category

Communication

1 services · 3 endpoints
Communication

Notification API

v1.0.0

Prepare and track transactional notifications through controlled server-side workflows.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/notify/emailSend an email notification 15 unitsPreview
Preview dependency: Requires customer-approved sending rules and durable delivery processing. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

queuednotification_idchannelnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/notify/email"
GET / POST /v1/notify/templateSend a templated notification 15 unitsPreview
Preview dependency: Requires the durable customer template store. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

queuednotification_idchannelnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/notify/template"
GET / POST /v1/notify/statusCheck notification status 5 unitsPreview
Preview dependency: Requires the durable notification delivery store. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

queuednotification_idchannelnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/notify/status"
API category

Compliance

1 services · 5 endpoints
Compliance

Compliance & GDPR Tools API

v1.0.0

PII scanning, redaction, retention checks and privacy/cookie checks.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/compliance/pii-scanPII scanner 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to scan for personal information.Maximum 100000 charactersExample: Contact Jane at jane@example.com.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

service

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/compliance/pii-scan?text=Contact+Jane+at+jane%40example.com."
GET / POST /v1/compliance/redactionRedact PII/secrets 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

redactedservice

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/compliance/redaction?text=example"
GET / POST /v1/compliance/retention-checkRetention policy check 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
retention_days integerquery or JSON No Request option: Retention Days.Default: 365 · Min: 0 · Max: 3650Example: 365
created_at stringquery or JSON No Request option: Created At.Default: nowExample: now

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

retention_daysage_daysdelete_recommendednote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/compliance/retention-check?retention_days=365&created_at=now"
GET / POST /v1/compliance/cookie-auditCookie text audit 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded
OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

mentionsneeds_cookie_noticenote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/compliance/cookie-audit?text=example"
GET / POST /v1/compliance/privacy-policy-checkPrivacy policy content check 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

checksscorenot_legal_advice

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/compliance/privacy-policy-check?text=example"
API category

Content

1 services · 6 endpoints
Content

Content Safety & Text Intelligence API

v1.0.0

Detect sensitive content, redact common identifiers and add lightweight text intelligence to workflows.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/content/profanityDetect profanity in text 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

contains_profanitymatches

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/profanity?text=example"
GET / POST /v1/content/pii-detectDetect emails, phone numbers and basic PII 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

email_countphone_counthas_piiemailsphones

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/pii-detect?text=example"
GET / POST /v1/content/redactRedact basic PII 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

redacted

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/redact?text=example"
GET / POST /v1/content/language-detectDetect likely language 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

languageconfidence

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/language-detect?text=example"
GET / POST /v1/content/readabilityReadability score 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/readability?text=example"
GET / POST /v1/content/sentiment-basicBasic sentiment score 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

sentimentpositive_hitsnegative_hits

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/content/sentiment-basic?text=example"
API category

Data

2 services · 11 endpoints
Data

Data Quality API

v1.0.0

Normalise, compare, deduplicate and improve business data before it reaches downstream systems.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/data-quality/dedupeRemove duplicates 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example
items stringJSON No Array of input items.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

items

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data-quality/dedupe?text=example&items=example"
GET / POST /v1/data-quality/normaliseNormalise whitespace/casing 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

text

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data-quality/normalise?text=example"
GET / POST /v1/data-quality/fuzzy-matchFuzzy match two values 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
a stringquery or JSON No Request option: A.Default: Example: example
b stringquery or JSON No Request option: B.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

match_percentis_likely_match

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data-quality/fuzzy-match?a=example&b=example"
GET / POST /v1/data-quality/name-splitSplit a person name 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON No Human-readable name.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

firstlastparts

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data-quality/name-split?name=example"
GET / POST /v1/data-quality/company-name-cleanClean company suffixes 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON No Human-readable name.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

clean_name

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data-quality/company-name-clean?name=example"
Data

CSV & Spreadsheet Quality API

v1.0.0

Spreadsheet profiling, cleaning, column detection, email validation and dedupe.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/spreadsheet/profileSpreadsheet profile 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

rowscolumnsheaders

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/profile?csv=example"
GET / POST /v1/spreadsheet/cleanSpreadsheet cleaner 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

cleanednote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/clean?csv=example"
GET / POST /v1/spreadsheet/detect-columnsDetect columns 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

headersguesses

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/detect-columns?csv=example"
GET / POST /v1/spreadsheet/validate-emailsValidate emails in table 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

email_countemails

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/validate-emails?csv=example"
GET / POST /v1/spreadsheet/dedupe-rowsDedupe rows 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

rows

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/dedupe-rows?csv=example"
GET / POST /v1/spreadsheet/normalise-addressesAddress normalisation integration 15 unitsPreview
Preview dependency: Requires the configured address-normalisation provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON Yes CSV text including a header row.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

cleanednote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spreadsheet/normalise-addresses?csv=example"
API category

Date

1 services · 7 endpoints
Date

Calendar & Business Date API

v1.0.0

Business days, holidays, age, countdown and payday helpers.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/date/business-daysBusiness days between dates 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
end stringquery or JSON No Request option: End.Default: +30 daysExample: +30 days
start stringquery or JSON No Request option: Start.Default: todayExample: today

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

business_daysstartend

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/business-days?end=%2B30+days&start=today"
GET / POST /v1/date/add-business-daysAdd business days 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
start stringquery or JSON No Request option: Start.Default: todayExample: today
days integerquery or JSON No Request option: Days.Default: 5Example: 5

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

date

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/add-business-days?start=today&days=5"
GET / POST /v1/date/working-days-betweenWorking days between dates 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
end stringquery or JSON No Request option: End.Default: +30 daysExample: +30 days
start stringquery or JSON No Request option: Start.Default: todayExample: today

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

business_daysstartend

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/working-days-between?end=%2B30+days&start=today"
GET / POST /v1/date/holidayRegional public-holiday lookup 5 unitsPreview
Preview dependency: Requires a maintained regional public-holiday dataset. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
country stringquery or JSON No ISO country code.Default: GBExample: GB
year integerquery or JSON Yes Request option: Year.Example: 1

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

providercountryyear

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/holiday?country=GB&year=1"
GET / POST /v1/date/ageAge calculator 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
dob stringquery or JSON No Request option: Dob.Default: 2000-01-01Example: 2000-01-01

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

age_years

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/age?dob=2000-01-01"
GET / POST /v1/date/countdownCountdown 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
end stringquery or JSON No Request option: End.Default: +30 daysExample: +30 days
start stringquery or JSON No Request option: Start.Default: todayExample: today

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

daysstartend

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/countdown?end=%2B30+days&start=today"
GET / POST /v1/date/paydayPayday helper 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
start stringquery or JSON No Request option: Start.Default: todayExample: today

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

payday

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/date/payday?start=today"
API category

Deliverability

4 services · 8 endpoints
Deliverability

Blacklist Monitoring

v1.0.0

One-off and scheduled DNSBL monitoring for domains and sending IPs.

2 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
POST /v1/blacklist/checkCheck a domain or IPv4 address against configured DNSBLs. 10 units
Authentication Bearer server key Methods POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
type stringJSON No Request option: Type.Default: domainExample: domain
target stringJSON No Request option: Target.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

result

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "type": "domain",
    "target": "example"
}' \
  "https://actoki.com/v1/blacklist/check"
GET / POST / DELETE /v1/blacklist/monitorsCreate, list or delete blacklist monitors. 5 units
Authentication Bearer server key Methods GET / POST / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or form No Request option: Id.Example: example
type stringJSON No Request option: Type.Default: domainExample: domain
target stringJSON No Request option: Target.Default: Example: example
label stringJSON No Request option: Label.Default: Example: example
alert_email stringJSON No Request option: Alert Email.Default: Example: user@example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

erroridmonitors

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/blacklist/monitors?id=example&type=domain&target=example"
Deliverability

Email Finder

v1.0.0

Find likely business email addresses using patterns, DNS and optional SMTP evidence.

2 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
POST /v1/email-finder/findFind and rank likely email addresses. 20 units
Authentication Bearer server key Methods POST Cost 20 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
smtp booleanJSON No Request option: Smtp.Default: falseExample: false
first_name stringJSON No Request option: First Name.Default: Example: example
last_name stringJSON No Request option: Last Name.Default: Example: example
domain stringJSON No Domain name without a path.Default: Example: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

result

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "smtp": false,
    "first_name": "example",
    "last_name": "example"
}' \
  "https://actoki.com/v1/email-finder/find"
POST /v1/email-finder/batchFind emails for up to 100 people. 15 units
Authentication Bearer server key Methods POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
people stringJSON No Request option: People.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorindexcountresults

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "people": "example"
}' \
  "https://actoki.com/v1/email-finder/batch"
Deliverability

Inbox Placement

v1.0.0

Create seed-mailbox placement tests and inspect inbox, spam and authentication results.

2 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/inbox-placement/testsCreate or list inbox-placement tests. 50 units
Authentication Bearer server key Methods GET / POST Cost 50 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
label stringJSON No Request option: Label.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

testtests

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/inbox-placement/tests?label=example"
GET /v1/inbox-placement/statusRead inbox-placement results. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or form No Request option: Id.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errortest

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/inbox-placement/status?id=example"
Deliverability

Spam Test

v1.0.0

Mail-tester-style spam checker: send a real email to a one-off test address and get a scored SPF/DKIM/DMARC, blacklist and content report.

2 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/spam-test/testsCreate a one-off spam-test address or list previous tests. 40 units
Authentication Bearer server key Methods GET / POST Cost 40 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
label stringJSON No Request option: Label.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

testtests

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spam-test/tests?label=example"
GET /v1/spam-test/statusRead the score and itemised report for a spam test. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or form No Request option: Id.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errortest

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/spam-test/status?id=example"
API category

Design

1 services · 5 endpoints
Design

Design Tools API

v1.0.0

Colour palettes, colour conversion, contrast checks and gradients.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/design/palette/randomGenerate 2-5 matching random colours. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
count integerquery or JSON No Request option: Count.Default: 5 · Min: 2 · Max: 5Example: 5
style stringquery or JSON No Style key.Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochromeExample: bright

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/design/palette/random?count=5&style=bright"
GET / POST /v1/design/palette/from-colourGenerate matching colours from one colour. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
colour stringquery or JSON No Request option: Colour.Default: #3B82F6 · Maximum 20 charactersExample: #3B82F6
count integerquery or JSON No Request option: Count.Default: 5 · Min: 2 · Max: 5Example: 5
style stringquery or JSON No Style key.Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochromeExample: bright

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/design/palette/from-colour?colour=%233B82F6&count=5&style=bright"
GET / POST /v1/design/colour/convertConvert HEX/RGB/HSL colour formats. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
colour stringquery or JSON No Request option: Colour.Default: #3B82F6 · Maximum 20 charactersExample: #3B82F6

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/design/colour/convert?colour=%233B82F6"
GET / POST /v1/design/colour/contrastCheck WCAG colour contrast. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
foreground stringquery or JSON No Request option: Foreground.Default: #111827 · Maximum 20 charactersExample: #111827
background stringquery or JSON No Request option: Background.Default: #fff · Maximum 20 charactersExample: #fff

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

foregroundbackgroundcontrast_ratiowcagaa_normalaa_large

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/design/colour/contrast?foreground=%23111827&background=%23fff"
GET / POST /v1/design/gradientGenerate CSS gradients. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
from stringquery or JSON No Request option: From.Default: #3B82F6 · Maximum 20 charactersExample: #3B82F6
to stringquery or JSON No Request option: To.Default: #22C55E · Maximum 20 charactersExample: #22C55E
direction stringquery or JSON No Request option: Direction.Default: 90deg · Maximum 20 charactersExample: 90deg

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

fromtocss

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/design/gradient?from=%233B82F6&to=%2322C55E&direction=90deg"
API category

Developer

3 services · 19 endpoints
Developer

Data Formatter API

v1.0.0

CSV, JSON, XML, YAML and table cleaning utilities.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/data/csv-to-jsonCSV to JSON. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
csv stringquery or JSON No CSV text including a header row.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

rows

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/csv-to-json?csv=example"
GET / POST /v1/data/json-to-csvJSON to CSV. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
json stringquery or JSON No JSON text.Default: [] · Maximum 100000 charactersExample: []

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

csv

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/json-to-csv?json=%5B%5D"
GET / POST /v1/data/xml-to-jsonXML to JSON. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
xml stringquery or JSON No XML text.Default: <root/> · Maximum 100000 charactersExample: <root/>

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

jsonerror

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/xml-to-json?xml=%3Croot%2F%3E"
GET / POST /v1/data/yaml-to-jsonYAML to JSON scaffold. 5 unitsPreview
Preview dependency: Requires the configured YAML parser. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
input stringquery or JSON No Request option: Input.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readyinput

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/yaml-to-json?input=example"
GET / POST /v1/data/flatten-jsonFlatten JSON. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
json stringquery or JSON No JSON text.Default: {} · Maximum 100000 charactersExample: {}

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

flattened

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/flatten-json?json=%7B%7D"
GET / POST /v1/data/table-cleanClean table data. 5 unitsPreview
Preview dependency: Requires the production table-cleaning implementation. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
input stringquery or JSON No Request option: Input.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readyinput

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/data/table-clean?input=example"
Developer

Developer Tools API

v1.0.0

UUID, hashes, Base64, JSON, JWT, regex and URL tools.

9 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/dev/uuidGenerate UUID v4 values. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
count integerquery or JSON No Request option: Count.Default: 1 · Min: 1 · Max: 100Example: 1

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

uuids

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/uuid?count=1"
GET / POST /v1/dev/hashHash text. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
algorithm stringquery or JSON No Request option: Algorithm.Default: sha256 · Maximum 40 charactersExample: sha256
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

erroralgorithmhash

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/hash?algorithm=sha256&text=example"
GET / POST /v1/dev/base64/encodeBase64 encode. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

encoded

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/base64/encode?text=example"
GET / POST /v1/dev/base64/decodeBase64 decode. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

decoded

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/base64/decode?text=example"
GET / POST /v1/dev/json/validateValidate JSON. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
json stringquery or JSON No JSON text.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validerrorformatteddata

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/json/validate?json=example"
GET / POST /v1/dev/json/formatFormat JSON. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
json stringquery or JSON No JSON text.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validerrorformatteddata

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/json/format?json=example"
GET / POST /v1/dev/jwt/decodeDecode JWT. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
jwt stringquery or JSON No Request option: Jwt.Default: · Maximum 20000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validerrorheaderpayload

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/jwt/decode?jwt=example"
GET / POST /v1/dev/regex/testTest regex. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
pattern stringquery or JSON No Request option: Pattern.Default: // · Maximum 1000 charactersExample: //
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validmatchedmatches

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/regex/test?pattern=%2F%2F&text=example"
GET / POST /v1/dev/url/parseParse URL. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: · Maximum 2000 charactersExample: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

parts

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/dev/url/parse?url=https%3A%2F%2Fexample.com"
Developer

Webhook Testing & Delivery API

v1.0.0

Plan, test and operate webhook delivery with explicit status, retry and logging contracts.

4 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/webhooks/endpointCreate a test webhook endpoint 10 unitsPreview
Preview dependency: Requires the durable webhook endpoint store and delivery worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

endpoint_idurlnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/webhooks/endpoint"
GET / POST /v1/webhooks/sendSend a webhook payload 10 unitsPreview
Preview dependency: Requires the asynchronous delivery and retry worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com
payload stringJSON No JSON payload.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

testqueuedurlpayload_sha256note

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/webhooks/send?url=https%3A%2F%2Fexample.com&payload=example"
GET / POST /v1/webhooks/logsList webhook logs 10 unitsPreview
Preview dependency: Requires the durable webhook delivery log. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

logsnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/webhooks/logs"
GET / POST /v1/webhooks/retryRetry a webhook delivery 10 unitsPreview
Preview dependency: Requires the asynchronous delivery and retry worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id integerquery or JSON No Request option: Id.Default: 0Example: 0

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

retry_queuedwebhook_log_id

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/webhooks/retry?id=0"
API category

Dns

1 services · 8 endpoints
Dns

Domain Health API

v1.0.0

MXToolbox-style DNS, mail, SPF, DMARC, RDAP and domain health checks using free DNS/RDAP data sources.

8 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/domain/dnsReturn A, AAAA, MX, TXT, NS, SOA and CAA DNS records. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domaindns

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/dns?domain=example.com"
GET / POST /v1/domain/mxCheck MX records and whether MX targets resolve. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainmx

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/mx?domain=example.com"
GET / POST /v1/domain/spfRead and validate SPF TXT record. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainspf

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/spf?domain=example.com"
GET / POST /v1/domain/dmarcRead and validate _dmarc TXT record. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domaindmarc

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/dmarc?domain=example.com"
GET / POST /v1/domain/rdapReturn RDAP registration data where available. 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainrdap

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/rdap?domain=example.com"
GET / POST /v1/domain/whoisWHOIS-style response backed by RDAP. 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainwhoisnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/whois?domain=example.com"
GET / POST /v1/domain/healthFull DNS and mail health score. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/health?domain=example.com"
GET / POST /v1/domain/fullFull health report plus RDAP data. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON Yes Domain name without a path.Maximum 253 charactersExample: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

rdap

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain/full?domain=example.com"
API category

Documents

3 services · 18 endpoints
Documents

Document OCR & Extraction API

v1.0.0

Provider-ready document extraction, invoice/receipt helpers and MRZ parsing.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/document/extract-textExtract text from a submitted document 25 unitsPreview
Preview dependency: Requires the configured OCR or document-extraction engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

textcharactersnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/extract-text?text=example"
GET / POST /v1/document/extract-tablesExtract table-like rows 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

rowsrow_count

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/extract-tables?text=example"
GET / POST /v1/document/invoice-readRead invoice fields 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

document_typereferencetotalconfidence

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/invoice-read?text=example"
GET / POST /v1/document/receipt-readRead receipt fields 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

document_typereferencetotalconfidence

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/receipt-read?text=example"
GET / POST /v1/document/passport-mrzParse passport MRZ 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
mrz stringquery or JSON Yes Passport machine-readable zone text.Maximum 200 charactersExample: P<GBRDOE<<JANE<<<<<<<<<<<<<<<<<<<<<<<<<<

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/passport-mrz?mrz=P%3CGBRDOE%3C%3CJANE%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C%3C"
GET / POST /v1/document/boarding-pass-readParse boarding pass text 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

flightrouteconfidence

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/document/boarding-pass-read?text=example"
Documents

PDF / Document API

v1.0.0

Provider-ready PDF generation, invoice documents and PDF operations.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/pdf/from-htmlGenerate PDF from HTML. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/from-html?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
GET / POST /v1/pdf/invoiceGenerate invoice PDF. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/invoice?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
GET / POST /v1/pdf/mergeMerge PDFs. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/merge?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
GET / POST /v1/pdf/splitSplit PDFs. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/split?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
GET / POST /v1/pdf/watermarkWatermark PDF. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/watermark?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
GET / POST /v1/pdf/metadataRead PDF metadata. 25 units
Authentication Bearer server key Methods GET / POST Cost 25 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p> · Maximum 200000 charactersExample: <h1>Actoki Document</h1><p>Generated by Actoki PDF API.</p>
invoice_number stringquery or JSON No Request option: Invoice Number.Default: INV-TEST · Maximum 80 charactersExample: INV-TEST
amount stringquery or JSON No Request option: Amount.Default: 0.00 · Maximum 40 charactersExample: 0.00
engine stringquery or JSON Yes Request option: Engine.Maximum 30 charactersExample: example
output stringquery or JSON No Request option: Output.Default: base64 · Maximum 20 characters · Options: base64, downloadExample: base64
filename stringquery or JSON Yes Request option: Filename.Maximum 120 charactersExample: example
paper stringquery or JSON No Request option: Paper.Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, LegalExample: A4
orientation stringquery or JSON No Request option: Orientation.Default: portrait · Maximum 20 characters · Options: portrait, landscapeExample: portrait

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationengineoutputfilenamepaperorientationremoteprovider_readynotehtml

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/pdf/metadata?html=%3Ch1%3EActoki+Document%3C%2Fh1%3E%3Cp%3EGenerated+by+Actoki+PDF+API.%3C%2Fp%3E&invoice_number=INV-TEST&amount=0.00&engine=example&filename=example"
Documents

QR Code API

v1.0.0

Generate URL, WiFi, vCard, email, SMS and custom QR payloads.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/qr/createCreate generic QR SVG. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/create?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
GET / POST /v1/qr/wifiCreate WiFi QR. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/wifi?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
GET / POST /v1/qr/vcardCreate vCard QR. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/vcard?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
GET / POST /v1/qr/emailCreate email QR. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/email?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
GET / POST /v1/qr/smsCreate SMS QR. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/sms?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
GET / POST /v1/qr/urlCreate URL QR. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
data stringquery or JSON Yes Request option: Data.Maximum 4000 charactersExample: example
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com
security stringquery or JSON No Request option: Security.Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, smsExample: WPA
ssid stringquery or JSON No Request option: Ssid.Default: · Maximum 80 charactersExample: example
password stringquery or JSON No Request option: Password.Default: · Maximum 120 charactersExample: example
name stringquery or JSON No Human-readable name.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: example
phone stringquery or JSON No Telephone number.Default: · Maximum 40 characters · Options: wifi, vcard, email, smsExample: +442079460000
email stringquery or JSON No Email address.Default: · Maximum 120 characters · Options: wifi, vcard, email, smsExample: user@example.com
message stringquery or JSON No Request option: Message.Default: · Maximum 200 characters · Options: wifi, vcard, email, smsExample: example
size integerquery or JSON No Request option: Size.Default: 256 · Min: 128 · Max: 1024Example: 256

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

typedataformatsvg

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/qr/url?data=example&url=https%3A%2F%2Factoki.com&security=WPA"
API category

Email

1 services · 4 endpoints
Email

Email Content Tools API

v1.0.0

Email subject scoring, spam words, HTML-to-text and previews.

4 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/email-tools/subject-scoreScore subject line. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
subject stringquery or JSON No Request option: Subject.Default: · Maximum 300 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

subjectscorewarnings

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email-tools/subject-score?subject=example"
GET / POST /v1/email-tools/spam-wordsFind spam words. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

found

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email-tools/spam-words?text=example"
GET / POST /v1/email-tools/html-to-textHTML to text. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: · Maximum 100000 characters · Options: /v1/email-tools/html-to-text, /v1/email-tools/previewExample: example
subject stringquery or JSON No Request option: Subject.Default: Preview · Maximum 200 charactersExample: Preview

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

textsubject

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email-tools/html-to-text?html=example&subject=Preview"
GET / POST /v1/email-tools/previewPreview email. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON No HTML content to process.Default: · Maximum 100000 characters · Options: /v1/email-tools/html-to-text, /v1/email-tools/previewExample: example
subject stringquery or JSON No Request option: Subject.Default: Preview · Maximum 200 charactersExample: Preview

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

textsubject

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email-tools/preview?html=example&subject=Preview"
API category

Finance

2 services · 9 endpoints
Finance

Invoice & Accounting Validation API

v1.0.0

Invoice validation, VAT helpers, payment terms, late fees and credit notes.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/accounting/invoice-validateInvoice validation 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
invoice_number stringquery or JSON Yes Invoice reference or number.Example: INV-2026-001
date stringquery or JSON Yes Invoice issue date.Example: 2026-08-03
seller stringquery or JSON Yes Seller or supplier name.Example: Example Supplier Ltd
buyer stringquery or JSON Yes Buyer or customer name.Example: Example Customer Ltd
amount numberquery or JSON Yes Invoice total amount.Example: 1250.00

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validmissing

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/invoice-validate?invoice_number=INV-2026-001&date=2026-08-03&seller=Example+Supplier+Ltd&buyer=Example+Customer+Ltd&amount=1250.00"
GET / POST /v1/accounting/vat-calculateVAT calculator 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
amount numberquery or JSON No Request option: Amount.Default: 100Example: 100
rate numberquery or JSON No Request option: Rate.Default: 20Example: 20

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

netvat_ratevatgross

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/vat-calculate?amount=100&rate=20"
GET / POST /v1/accounting/vat-number-formatVAT number format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
vat stringquery or JSON Yes VAT registration number including country prefix where applicable.Maximum 30 charactersExample: GB123456789

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/vat-number-format?vat=GB123456789"
GET / POST /v1/accounting/payment-termsPayment due date calculator 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
invoice_date stringquery or JSON No Request option: Invoice Date.Default: nowExample: now
days integerquery or JSON No Request option: Days.Default: 30 · Min: 0 · Max: 365Example: 30

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

due_dateterms_days

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/payment-terms?invoice_date=now&days=30"
GET / POST /v1/accounting/late-feeLate fee calculator 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
days integerquery or JSON No Request option: Days.Default: 30 · Min: 0 · Max: 365Example: 30
rate numberquery or JSON No Request option: Rate.Default: 20Example: 20
amount numberquery or JSON No Request option: Amount.Default: 100Example: 100
annual_rate numberquery or JSON No Request option: Annual Rate.Default: 8Example: 8
days_late integerquery or JSON No Request option: Days Late.Default: 30 · Min: 0 · Max: 3650Example: 30

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

interestdays_lateannual_rate

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/late-fee?days=30&rate=20&amount=100"
GET / POST /v1/accounting/credit-noteCredit note helper 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
amount numberquery or JSON No Request option: Amount.Default: 1000Example: 1000

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

credit_note_numberamountstatus

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accounting/credit-note?amount=1000"
Finance

Finance Calculators API

v1.0.0

Professional finance calculators for interest, mortgage repayments, overpayments, salary estimates and percentage utilities.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/finance/interestSimple/compound interest and savings growth calculator. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
principal numberquery or JSON No Request option: Principal.Default: 1000 · Min: 0Example: 1000
annual_rate numberquery or JSON No Request option: Annual Rate.Default: 5 · Min: -100 · Max: 1000Example: 5
years numberquery or JSON No Request option: Years.Default: 1 · Min: 0 · Max: 100Example: 1
monthly_contribution numberquery or JSON No Request option: Monthly Contribution.Default: 0 · Min: 0Example: 0
compound stringquery or JSON No Request option: Compound.Default: monthly · Maximum 20 charactersExample: monthly
currency stringquery or JSON No Request option: Currency.Default: GBP · Maximum 3 charactersExample: GBP

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

principalannual_rateyearsmonthly_contributioncompoundcurrency

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/finance/interest?principal=1000&annual_rate=5&years=1"
GET / POST /v1/finance/mortgageMortgage repayment, total interest and overpayment savings calculator. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
principal numberquery or JSON No Request option: Principal.Default: 250000 · Min: 0Example: 250000
annual_rate numberquery or JSON No Request option: Annual Rate.Default: 5 · Min: 0 · Max: 100Example: 5
term_years integerquery or JSON No Request option: Term Years.Default: 25 · Min: 1 · Max: 50Example: 25
extra_monthly numberquery or JSON No Request option: Extra Monthly.Default: 0 · Min: 0Example: 0
currency stringquery or JSON No Request option: Currency.Default: GBP · Maximum 3 charactersExample: GBP

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

principalannual_rateterm_yearsextra_monthlycurrency

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/finance/mortgage?principal=250000&annual_rate=5&term_years=25"
GET / POST /v1/finance/salarySalary take-home estimate with configurable tax, pension and deductions. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
gross_salary numberquery or JSON Yes Request option: Gross Salary.Min: 0Example: 1
gross numberquery or JSON No Request option: Gross.Default: 35000 · Min: 0Example: 35000
period stringquery or JSON No Request option: Period.Default: annual · Maximum 20 charactersExample: annual
country stringquery or JSON No ISO country code.Default: GB · Maximum 4 charactersExample: GB
currency stringquery or JSON No Request option: Currency.Default: GBP · Maximum 3 charactersExample: GBP
personal_allowance numberquery or JSON No Request option: Personal Allowance.Default: 12570 · Min: 0Example: 12570
pension_percent numberquery or JSON No Request option: Pension Percent.Default: 0 · Min: 0 · Max: 100Example: 0
student_loan_annual numberquery or JSON No Request option: Student Loan Annual.Default: 0 · Min: 0Example: 0
other_deductions_annual numberquery or JSON No Request option: Other Deductions Annual.Default: 0 · Min: 0Example: 0
basic_rate numberquery or JSON No Request option: Basic Rate.Default: 20 · Min: 0 · Max: 100Example: 20
higher_rate numberquery or JSON No Request option: Higher Rate.Default: 40 · Min: 0 · Max: 100Example: 40
additional_rate numberquery or JSON No Request option: Additional Rate.Default: 45 · Min: 0 · Max: 100Example: 45
ni_primary_threshold numberquery or JSON No Request option: Ni Primary Threshold.Default: 12570 · Min: 0Example: 12570
ni_upper_threshold numberquery or JSON No Request option: Ni Upper Threshold.Default: 50270 · Min: 0Example: 50270
ni_basic_rate numberquery or JSON No Request option: Ni Basic Rate.Default: 8 · Min: 0 · Max: 100Example: 8
ni_upper_rate numberquery or JSON No Request option: Ni Upper Rate.Default: 2 · Min: 0 · Max: 100Example: 2

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

gross_salaryperiodcountrycurrencypersonal_allowancepension_percentstudent_loan_annualother_deductions_annualbasic_ratehigher_rateadditional_rateni_primary_thresholdni_upper_thresholdni_basic_rateni_upper_rate

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/finance/salary?gross_salary=1&gross=35000&period=annual"
API category

Location

1 services · 5 endpoints
Location

Address / Postcode API

v1.0.0

Postcode validation, address formatting, distance and geocode-ready endpoints.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/address/postcodeValidate UK postcode. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
postcode stringquery or JSON No Request option: Postcode.Default: · Maximum 20 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

postcodevalidformatted

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/address/postcode?postcode=example"
GET / POST /v1/address/formatFormat address. 5 unitsPreview
Preview dependency: Requires the configured address-normalisation provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
address stringquery or JSON Yes Request option: Address.Maximum 1000 charactersExample: example
query stringquery or JSON No Request option: Query.Default: · Maximum 1000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readyinputnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/address/format?address=example&query=example"
GET / POST /v1/address/validateValidate address. 10 unitsPreview
Preview dependency: Requires the configured address-validation provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
address stringquery or JSON Yes Request option: Address.Maximum 1000 charactersExample: example
query stringquery or JSON No Request option: Query.Default: · Maximum 1000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readyinputnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/address/validate?address=example&query=example"
GET / POST /v1/address/distanceDistance between coordinates. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
lat1 numberquery or JSON No Request option: Lat1.Default: 0Example: 0
lon1 numberquery or JSON No Request option: Lon1.Default: 0Example: 0
lat2 numberquery or JSON No Request option: Lat2.Default: 0Example: 0
lon2 numberquery or JSON No Request option: Lon2.Default: 0Example: 0

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

kilometresmiles

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/address/distance?lat1=0&lon1=0&lat2=0"
GET / POST /v1/address/geocodeGeocode address. 10 unitsPreview
Preview dependency: Requires the configured geocoding provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
address stringquery or JSON Yes Request option: Address.Maximum 1000 charactersExample: example
query stringquery or JSON No Request option: Query.Default: · Maximum 1000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readyinputnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/address/geocode?address=example&query=example"
API category

Maps

2 services · 13 endpoints
Maps

Geo Distance & Coordinates API

v1.0.0

Calculate distances, bounding boxes and coordinate relationships for location-aware products.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/geo/distanceDistance between coordinates 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
lat1 numberquery or JSON Yes Request option: Lat1.Example: 51.5074
lng1 numberquery or JSON Yes Request option: Lng1.Example: -0.1278
lat2 numberquery or JSON Yes Request option: Lat2.Example: 1
lng2 numberquery or JSON Yes Request option: Lng2.Example: 1

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

distance_km

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/geo/distance?lat1=51.5074&lng1=-0.1278&lat2=1&lng2=1"
GET / POST /v1/geo/bounding-boxCreate bounding box around a point 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
lat numberquery or JSON Yes Request option: Lat.Example: 51.5074
lng numberquery or JSON Yes Request option: Lng.Example: -0.1278
radius_km numberquery or JSON No Request option: Radius Km.Default: 10Example: 10

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

bbox

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/geo/bounding-box?lat=51.5074&lng=-0.1278&radius_km=10"
GET / POST /v1/geo/point-in-boxCheck if point is inside bbox 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
lat numberquery or JSON Yes Request option: Lat.Example: 51.5074
lng numberquery or JSON Yes Request option: Lng.Example: -0.1278
bbox stringquery or JSON No Request option: Bbox.Default: -180,-90,180,90Example: -180,-90,180,90

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

inside

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/geo/point-in-box?lat=51.5074&lng=-0.1278&bbox=-180%2C-90%2C180%2C90"
GET / POST /v1/geo/geohashGeohash encode 10 unitsPreview
Preview dependency: Geohash encoding is reserved for the production geospatial implementation. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/geo/geohash"
GET / POST /v1/geo/reverse-geohashGeohash decode 10 unitsPreview
Preview dependency: Geohash decoding is reserved for the production geospatial implementation. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

provider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/geo/reverse-geohash"
Maps

Maps API

v1.0.0

PMTiles, MapLibre styles, regional map permissions, short-lived map tokens and map usage reporting.

8 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET /v1/maps/catalogReturn the map regions available to the account. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

catalog

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/maps/catalog"
GET /v1/maps/stylesReturn available map styles. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

styles

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/maps/styles"
GET /v1/maps/styleReturn a MapLibre style JSON document. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

OptionType and locationRequiredDescription, defaults and accepted values
region stringquery or JSON No Region key returned by /v1/maps/catalog.Default: ukExample: uk
style stringquery or JSON No Style key returned by /v1/maps/styles.Default: actoki-light · Options: bright, pastel, pale, dark, monochromeExample: actoki-light
labels stringquery or JSON No Show or hide map labels.Default: on · Options: on, offExample: on

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/maps/style?region=uk&style=actoki-light&labels=on"
POST /v1/maps/tokenCreate a short-lived map token. 5 units
Authentication Bearer server key Methods POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
region stringquery or JSON No Region key returned by /v1/maps/catalog.Default: ukExample: uk
style stringquery or JSON No Map style key.Default: actoki-light · Options: bright, pastel, pale, dark, monochromeExample: actoki-light
labels stringquery or JSON No Show or hide labels.Default: on · Options: on, offExample: on
ttl integerquery or JSON No Requested token lifetime in seconds; the server may reduce it.Default: 3600 · Min: 60 · Max: 3600Example: 900

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "region": "uk",
    "style": "actoki-light",
    "labels": "on"
}' \
  "https://actoki.com/v1/maps/token"
POST /v1/maps/plotBuild a map style with pins, curved routes and boundaries. 10 units
Authentication Bearer server key Methods POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
region stringquery or JSON No Map region key.Default: ukExample: uk
style stringquery or JSON No Map style key.Default: actoki-light · Options: bright, pastel, pale, dark, monochromeExample: actoki-light
labels stringquery or JSON No Label mode.Default: on · Options: on, offExample: on
pins arrayquery or JSON No Pin objects containing longitude, latitude, label and optional colour.Example: [{"longitude":-0.1278,"latitude":51.5074,"label":"London"}]
connect_pins booleanquery or JSON No Draw a route between pins.Default: falseExample: true
curved_lines booleanquery or JSON No Use curved routes.Default: trueExample: true
line_colour stringquery or JSON No Route colour.Default: #ef4444Example: #ef4444
boundary objectquery or JSON No GeoJSON boundary.Example: []

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "region": "uk",
    "style": "actoki-light",
    "labels": "on"
}' \
  "https://actoki.com/v1/maps/plot"
GET / POST /v1/maps/embedsList protected embeds or create a map with automatically generated credentials. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON No Human-readable map name.Default: Business locationExample: London office
allowed_origins arrayquery or JSON No Exact approved HTTPS website origins.Example: ["https://www.example.com"]
mobile_apps arrayquery or JSON No Approved native identifiers in platform:application format.Example: ["ios:com.example.app","android:com.example.app"]
location objectquery or JSON No Map centre with latitude and longitude.Example: {"latitude":51.5074,"longitude":-0.1278}
region stringquery or JSON No Map region key.Default: ukExample: uk
style stringquery or JSON No Map style key.Default: actoki-light · Options: bright, pastel, pale, dark, monochromeExample: actoki-light
labels stringquery or JSON No Label mode.Default: on · Options: on, offExample: on
zoom objectquery or JSON No Initial, minimum and maximum zoom values.Example: {"initial":15,"minimum":12,"maximum":18}
controls objectquery or JSON No Interaction flags: zoom, pan, rotation and fullscreen.Example: {"zoom":true,"pan":false,"rotation":false,"fullscreen":false}
fit_to_content booleanquery or JSON No Fit the initial view to pins and boundaries.Default: falseExample: false
marker_label stringquery or JSON No Primary marker label.Example: London office
marker_colour stringquery or JSON No Primary marker CSS hex colour.Default: #2563ebExample: #2563eb
marker_logo_url stringquery or JSON No Optional HTTPS marker-logo URL.Example: https://www.example.com/logo.png
additional_pins arrayquery or JSON No Additional marker objects with latitude, longitude and optional label.Example: [{"latitude":51.5,"longitude":-0.12,"label":"Meeting point"}]
connect_pins booleanquery or JSON No Draw lines between pins.Default: falseExample: false
curved_lines booleanquery or JSON No Use curved connecting lines.Default: trueExample: true
line_colour stringquery or JSON No Connecting line colour.Default: #ef4444Example: #ef4444
boundary objectquery or JSON No GeoJSON boundary Feature or FeatureCollection.Example: []
boundary_colour stringquery or JSON No Boundary stroke colour.Default: #7c3aedExample: #7c3aed
boundary_fill_colour stringquery or JSON No Boundary fill colour.Default: #7c3aedExample: #7c3aed
boundary_fill_opacity numberquery or JSON No Boundary fill opacity.Default: 0.08 · Min: 0 · Max: 1Example: 0.08
credits_per_load integerquery or JSON No Credits charged for each successful protected-map activation.Default: 0 · Min: 0Example: 1
daily_view_limit integerquery or JSON No Maximum successful loads per day; zero uses platform defaults.Default: 0 · Min: 0Example: 1000
monthly_view_limit integerquery or JSON No Maximum successful loads per month; zero uses platform defaults.Default: 0 · Min: 0Example: 20000
rate_limit_per_minute integerquery or JSON No Per-map activation limit per minute.Default: 60 · Min: 1Example: 60
active booleanquery or JSON No Whether the protected map is available immediately.Default: trueExample: true
idempotency_key stringquery or JSON No Unique retry key. Prefer the Idempotency-Key HTTP header.Example: map-create-2026-08-03-001

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

erroridnameactiveallowed_originsmobile_appsregionstylelabelscenterzoominitialminmaxcontrolspanrotationfullscreencredentialslast_fourcreated_atrotated_atupdated_atembedsmessageidempotency_keycenter_latcenter_lngregion_keystyle_key

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.
  • GET lists protected maps. POST creates a protected map and returns its publishable key and iframe HTML.
  • Publishable map keys are browser-visible and must be protected with exact origins, limits and short-lived sessions.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/maps/embeds?name=London+office&allowed_origins=%5B%22https%3A%2F%2Fwww.example.com%22%5D&mobile_apps=%5B%22ios%3Acom.example.app%22%2C%22android%3Acom.example.app%22%5D"
POST /v1/maps/mobile-sessionsCreate a one-time native mobile WebView map session. Authentication is metered for abuse controls, but credits are charged only after successful map activation. 1 units
Authentication Bearer server key Methods POST Cost 1 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
map_id stringquery or JSON Yes Protected map public ID.Example: me_example123
platform stringquery or JSON Yes Native application platform.Options: ios, androidExample: ios
application_id stringquery or JSON Yes Approved iOS bundle ID or Android package name.Example: com.example.travelapp
ttl integerquery or JSON No One-time launch session lifetime in seconds.Default: 180 · Min: 60 · Max: 300Example: 180

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcredits_consumedbillingsessionmessage

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.
  • Session creation does not consume map-load credits. Billing occurs only after a successful WebView activation.
  • Call this endpoint from the customer backend, never directly from public mobile application code.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "map_id": "me_example123",
    "platform": "ios",
    "application_id": "com.example.travelapp"
}' \
  "https://actoki.com/v1/maps/mobile-sessions"
GET / POST /v1/maps/usageRecord or read map usage events. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Important behaviour

  • Map endpoints use the same bearer server key unless the guide explicitly describes a publishable embed key or one-time mobile session.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/maps/usage"
API category

Marketing

2 services · 12 endpoints
Marketing

Brand & Marketing Tools API

v1.0.0

Name checks, slug options, domain suggestions and tagline scoring.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/brand/name-checkBrand name check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Human-readable name.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

namesluglength_ok

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/brand/name-check?name=example"
GET / POST /v1/brand/slug-optionsSlug options 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Human-readable name.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

slugs

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/brand/slug-options?name=example"
GET / POST /v1/brand/domain-suggestionsDomain suggestions 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Human-readable name.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domains

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/brand/domain-suggestions?name=example"
GET / POST /v1/brand/tagline-scoreTagline score 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
tagline stringquery or JSON Yes Request option: Tagline.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

lengthscorenote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/brand/tagline-score?tagline=example"
GET / POST /v1/brand/social-handle-formatSocial handle formatter 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
name stringquery or JSON Yes Human-readable name.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

handle

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/brand/social-handle-format?name=example"
Marketing

SEO Audit API

v1.0.0

SEO page checks, metadata, headings, links, schema, sitemap and robots.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/seo/pageBasic page SEO audit. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/page?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/metaCheck meta tags. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/meta?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/headingsCheck headings. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/headings?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/linksExtract links. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded
OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/links?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/schemaCheck schema. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/schema?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/sitemapCheck sitemap. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/sitemap?url=https%3A%2F%2Factoki.com"
GET / POST /v1/seo/robotsCheck robots.txt. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 charactersExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/seo/robots?url=https%3A%2F%2Factoki.com"
API category

Media

1 services · 7 endpoints
Media

Image Utility API

v1.0.0

Create image placeholders, inspect metadata and derive useful visual properties for application workflows.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/image/resizeResize image. 15 unitsPreview
Preview dependency: Requires the configured image-processing engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/resize"
GET / POST /v1/image/compressCompress image. 15 unitsPreview
Preview dependency: Requires the configured image-processing engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/compress"
GET / POST /v1/image/convertConvert image. 15 unitsPreview
Preview dependency: Requires the configured image-processing engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/convert"
GET / POST /v1/image/metadataRead image metadata. 15 unitsPreview
Preview dependency: Requires the configured image metadata engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/metadata"
GET / POST /v1/image/strip-metadataStrip metadata. 15 unitsPreview
Preview dependency: Requires the configured image-processing engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/strip-metadata"
GET / POST /v1/image/placeholderGenerate placeholder. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
width integerquery or JSON No Request option: Width.Default: 1200 · Min: 1 · Max: 4000Example: 1200
height integerquery or JSON No Request option: Height.Default: 630 · Min: 1 · Max: 4000Example: 630

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlwidthheight

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/placeholder?width=1200&height=630"
GET / POST /v1/image/dominant-coloursDominant colours. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
colour stringquery or JSON No Request option: Colour.Default: #3B82F6 · Maximum 20 charactersExample: #3B82F6
count integerquery or JSON No Request option: Count.Default: 5 · Min: 2 · Max: 5Example: 5

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/image/dominant-colours?colour=%233B82F6&count=5"
API category

Monitoring

2 services · 10 endpoints
Monitoring

Scheduled Alerts API

v1.0.0

Create and manage scheduled checks with clear delivery and operational status.

4 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/alerts/createCreate a scheduled alert 10 unitsPreview
Preview dependency: Requires the scheduled alert worker and notification channel. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

statusalert_idoperationnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/alerts/create"
GET / POST /v1/alerts/listList scheduled alerts 10 unitsPreview
Preview dependency: Requires the scheduled alert store and worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

statusalert_idoperationnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/alerts/list"
GET / POST /v1/alerts/deleteDelete scheduled alert 10 unitsPreview
Preview dependency: Requires the scheduled alert store and worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

statusalert_idoperationnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/alerts/delete"
GET / POST /v1/alerts/testTest alert notification 10 unitsPreview
Preview dependency: Requires the scheduled alert worker and notification channel. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

statusalert_idoperationnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/alerts/test"
Monitoring

Website Monitoring API

v1.0.0

HTTP, SSL, DNS, domain expiry and basic page speed checks.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/monitor/httpHTTP status and response time. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basicExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/monitor/http?url=https%3A%2F%2Factoki.com"
GET / POST /v1/monitor/sslTLS certificate check: validity, expiry, hostname match, issuer, chain and protocol. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
host stringquery or form No Request option: Host.Example: example
domain stringquery or form No Domain name without a path.Example: example.com
url stringquery or form No Absolute HTTP or HTTPS URL.Example: https://example.com
port stringquery or form No Request option: Port.Example: example
timeout stringquery or form No Request option: Timeout.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorhintmessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/monitor/ssl?host=example&domain=example.com&url=https%3A%2F%2Fexample.com"
POST /v1/monitor/ssl-batchCheck TLS certificates for up to 25 hosts in one call (charged per host). 15 units
Authentication Bearer server key Methods POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
hosts stringquery or form No Request option: Hosts.Example: example
timeout stringquery or form No Request option: Timeout.Example: example
port stringquery or form No Request option: Port.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorhintmaxhostreachablecountsummaryvalidinvalidunreachableexpiring_within_30_daysresults

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "hosts": "example",
    "timeout": "example",
    "port": "example"
}' \
  "https://actoki.com/v1/monitor/ssl-batch"
GET / POST /v1/monitor/dnsDNS check. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON No Domain name without a path.Default: actoki.com · Maximum 255 charactersExample: actoki.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainrecords

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/monitor/dns?domain=actoki.com"
GET / POST /v1/monitor/domain-expiryDomain expiry check. 15 unitsPreview
Preview dependency: Requires a maintained RDAP or registrar expiry-data provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON No Domain name without a path.Default: actoki.com · Maximum 255 charactersExample: actoki.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/monitor/domain-expiry?domain=actoki.com"
GET / POST /v1/monitor/page-speed-basicBasic page speed timing. 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basicExample: https://actoki.com

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/monitor/page-speed-basic?url=https%3A%2F%2Factoki.com"
API category

Privacy

1 services · 3 endpoints
Privacy

Data Privacy Email Scanner API

v1.0.0

Scan emails, support messages and logs for PII, secrets and risky data.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/privacy/email-scanEmail privacy scanner 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Email text to scan for personal data and secrets.Maximum 200000 charactersExample: Please contact jane@example.com.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

piisecretssafe_to_store

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/privacy/email-scan?text=Please+contact+jane%40example.com."
GET / POST /v1/privacy/support-message-scanSupport message scanner 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Support-message text to scan for personal data and secrets.Maximum 200000 charactersExample: My API key is hidden here.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

piisecretssafe_to_store

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/privacy/support-message-scan?text=My+API+key+is+hidden+here."
GET / POST /v1/privacy/log-redactLog redaction 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

redacted

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/privacy/log-redact?text=example"
API category

Risk

2 services · 7 endpoints
Risk

Domain Guard API

v1.0.0

Flags disposable, banned and high-risk domains and email addresses at registration or opt-in time.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/domain-guard/checkCheck one email address or domain for disposable/banned status. 8 units
Authentication Bearer server key Methods GET / POST Cost 8 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value stringquery or JSON No Email address or domain to check. You may alternatively send email or domain; one of value/email/domain is required.Maximum 320 charactersExample: user@example.com
email stringquery or JSON No Alias for value when checking an email address.Maximum 320 charactersExample: user@example.com
domain stringquery or JSON No Alias for value when checking a domain.Maximum 253 charactersExample: example.com
mx booleanquery or JSON No Whether to perform a live MX lookup. Accepts true/false, 1/0 or yes/no.Default: trueExample: true

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okaccount_idendpointcredits_chargedinputdomainis_emailverdictscorereasonsmxerrormessage

Important behaviour

  • Authenticate with a standard Actoki server API key in Authorization: Bearer sk_live_... . Restrict the key to the domain_guard service for least privilege.
  • Secret server keys must stay on your backend/BFF. Do not embed sk_live_... or sk_test_... credentials in browser JavaScript, mobile apps or distributed desktop binaries.
  • GET/query, form-encoded POST and JSON POST are supported.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain-guard/check?value=user%40example.com&email=user%40example.com&domain=example.com"
POST /v1/domain-guard/batchCheck up to 100 values in one call (charged per value). 8 units
Authentication Bearer server key Methods POST Cost 8 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
values arrayquery or JSON Yes One to 100 email addresses and/or domains. Form/query input may also be a comma, semicolon or whitespace-separated string.Example: ["user@example.com","example.org"]
mx booleanquery or JSON No Whether to perform a live MX lookup for each item. Accepts true/false, 1/0 or yes/no.Default: trueExample: true

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okaccount_idendpointcountcredits_chargedsummaryblockedflaggedallowedresultsvaluedomainverdictscorereasonserror

Important behaviour

  • The batch is charged per submitted non-empty value and is capped at 100 values.
  • Authenticate with a standard server API key scoped to domain_guard; keep the secret on your backend.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "values": [
        "user@example.com",
        "example.org"
    ],
    "mx": "true"
}' \
  "https://actoki.com/v1/domain-guard/batch"
GET /v1/domain-guard/statusCredential and quota status; free of charge. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okaccount_idendpointcredits_chargedperiodusageby_domainauthenticationtypeheaderrecommended_scopenotecredentialsclient_iddomain_patternlabelactivelast_used_atdeprecatedexpires_atmigrated_api_key_id

Important behaviour

  • Current integrations use standard bearer API keys. The credentials collection is a backwards-compatible view of deprecated legacy dgc_/dgs_ pairs only.
  • New legacy Domain Guard credential issuance is disabled by default; migrate active legacy pairs to a normal vault-backed server key.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/domain-guard/status"
Risk

Fraud & Risk Scoring API

v1.0.0

Combine explainable signals into lightweight risk assessments for sign-up, order and account workflows.

4 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/risk/emailEmail risk score 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
email stringquery or JSON Yes Email address.Maximum 255 charactersExample: user@example.com
domain stringquery or JSON Yes Domain name without a path.Example: example.com
ip stringquery or JSON No Request option: Ip.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

risk_scorerisk_levelsignalsdomain

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/risk/email?email=user%40example.com&domain=example.com&ip=example"
GET / POST /v1/risk/ipIP risk score 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
email stringquery or JSON Yes Email address.Maximum 255 charactersExample: user@example.com
domain stringquery or JSON Yes Domain name without a path.Example: example.com
ip stringquery or JSON No Request option: Ip.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

risk_scorerisk_levelsignalsdomain

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/risk/ip?email=user%40example.com&domain=example.com&ip=example"
GET / POST /v1/risk/signupSignup risk score 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
email stringquery or JSON Yes Email address.Maximum 255 charactersExample: user@example.com
domain stringquery or JSON Yes Domain name without a path.Example: example.com
ip stringquery or JSON No Request option: Ip.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

risk_scorerisk_levelsignalsdomain

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/risk/signup?email=user%40example.com&domain=example.com&ip=example"
GET / POST /v1/risk/orderOrder risk score 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
email stringquery or JSON Yes Email address.Maximum 255 charactersExample: user@example.com
domain stringquery or JSON Yes Domain name without a path.Example: example.com
ip stringquery or JSON No Request option: Ip.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

risk_scorerisk_levelsignalsdomain

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/risk/order?email=user%40example.com&domain=example.com&ip=example"
API category

Security

2 services · 21 endpoints
Security

Identity and SSO API

v1.3.0

Hosted authentication, passkeys, email passwordless sign-in, social/enterprise federation, OpenID Connect, SAML, Forward Auth, LDAP/Active Directory, super-admin provider availability controls, users, sessions and audit events.

13 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST / PATCH / DELETE /v1/identity/appsManage OpenID Connect applications. 5 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or JSON No Application public ID. Required for PATCH, DELETE, rotate_secret and revoke_credential operations.Example: ia_example
action stringquery or JSON No POST management action. Omit to create an application.Options: rotate_secret, revoke_credentialExample: rotate_secret
credential_id stringquery or JSON No Specific credential public ID to revoke when action=revoke_credential.Example: icr_example
grace_seconds integerquery or JSON No How long previous confidential client credentials remain valid after rotation. 0 revokes immediately; maximum 7 days.Default: 86400 · Min: 0 · Max: 604800Example: 86400
name stringquery or JSON No Application name. Required when creating an application.Maximum 190 charactersExample: Customer Portal
integration_type stringquery or JSON No Client integration profile. Public SPA/mobile/desktop clients are designed for PKCE and do not receive a client secret; machine clients are confidential.Default: web · Options: web, spa, mobile, desktop, machineExample: web
application_type stringquery or JSON No Optional public/confidential override for non-machine integrations. Machine applications are always confidential.Options: public, confidentialExample: confidential
redirect_uris arrayquery or JSON No Exact callback URIs. Required for web/SPA/mobile/desktop; machine clients use none. HTTPS is required except permitted desktop loopback HTTP redirects.Example: ["https://example.com/auth/callback"]
post_logout_redirect_uris arrayquery or JSON No Exact HTTPS post-logout return URIs. Not used by machine applications.Example: ["https://example.com/"]
resource_id stringquery or JSON No API resource public ID. Required for integration_type=machine.Example: ir_example
allowed_scopes arrayquery or JSON No OIDC scopes for user clients, or API scopes allowed by the linked resource for machine clients.Example: ["openid","profile","email"]
skip_consent booleanquery or JSON No Skip the consent screen for a trusted application. Only enable for applications you trust.Default: falseExample: false
status stringquery or JSON No Application lifecycle state used by PATCH. Suspending/revoking a machine application revokes its active machine tokens.Options: active, suspended, revokedExample: active

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okapplicationsapplicationidclient_idclient_secretclient_secret_last_fourcredential_idcredentialsissuerintegration_typeapplication_typeredirect_urispost_logout_redirect_urisallowed_scopesresource_idresource_audienceservice_account_idstatusprevious_credentials_valid_for_secondserrormessage

Important behaviour

  • Confidential client secrets are authenticated by one-way hash and also stored as AES-256-GCM ciphertext in the Actoki credential vault so authorised portal users can reveal an active secret again after current-password re-authentication. The management API never provides a general reveal operation.
  • On rotation the new secret is active immediately. During grace_seconds both the new secret and the previous active credentials are accepted. At the grace deadline the old credential is rejected even if cleanup has not yet run; maintenance then marks it revoked and destroys its encrypted ciphertext.
  • Legacy hash-only credentials remain valid but cannot be revealed. Rotate once to create a vault-backed credential.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/apps?id=ia_example&action=rotate_secret&credential_id=icr_example"
GET / POST / PATCH / DELETE /v1/identity/resourcesManage OAuth API resources, audiences and introspection credentials. 5 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 5 units per successful request Input application/json

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or JSON No API resource public ID. Required for PATCH, DELETE and credential actions.Example: ir_example
action stringquery or JSON No POST credential action. Omit to create an API resource.Options: rotate_introspection_secret, revoke_credentialExample: rotate_introspection_secret
credential_id stringquery or JSON No Introspection credential public ID to revoke.Example: irc_example
grace_seconds integerquery or JSON No Overlap window for the old introspection secret after rotation.Default: 86400 · Min: 0 · Max: 604800Example: 86400
name stringquery or JSON No API resource name. Required on create.Maximum 190 charactersExample: Orders API
audience stringquery or JSON No Stable token audience. Required on create; use an HTTPS URI or URN.Example: https://api.example.com
allowed_scopes arrayquery or JSON No Machine scopes this resource accepts. At least one is required on create.Example: ["orders.read","orders.write"]
token_ttl_seconds integerquery or JSON No Lifetime of machine access tokens for this resource.Default: 900 · Min: 300 · Max: 3600Example: 900
status stringquery or JSON No Resource lifecycle state used by PATCH. Suspended/revoked resources invalidate active machine tokens.Options: active, suspended, revokedExample: active

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okresourcesresourceidnameaudienceallowed_scopestoken_ttl_secondsintrospection_client_idintrospection_secretintrospection_secret_last_fourcredential_idcredentialsstatusprevious_credentials_valid_for_secondserrormessage

Important behaviour

  • Introspection secrets use the credential vault and credential-history model. Portal reveal requires current-password re-authentication; API rotation returns the newly generated replacement secret.
  • Rotation supports immediate cutover or an overlap of up to 7 days. Authentication rejects an old credential as soon as valid_until passes, and cleanup later destroys its ciphertext.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/resources?id=ir_example&action=rotate_introspection_secret&credential_id=irc_example"
GET /v1/identity/exportExport portable Identity users, application metadata and provider mappings without reusable secrets. 10 units
Authentication Bearer server key Methods GET Cost 10 units per successful request Input No request body

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okexporttenantusersapplicationsprovidersapi_resourcesservice_accountsgenerated_aterrormessage

Important behaviour

  • Portability export contains identity/profile and configuration metadata needed for migration. It deliberately excludes reusable passwords, credential ciphertext, client secrets, provider secrets, live sessions and active access/refresh tokens.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/export"
GET / POST / PATCH / DELETE /v1/identity/usersManage application users. 3 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 3 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
limit integerquery or JSON No Maximum users returned by GET.Default: 100 · Min: 1 · Max: 500Example: 100
id stringquery or JSON No Identity user public ID. Required for PATCH and DELETE.Example: iu_example
email stringquery or JSON No Email address. Required for POST create/invite; checked by Domain Guard.Maximum 254 charactersExample: person@example.com
name stringquery or JSON No Display name. If omitted on invite, Actoki derives a simple name from the email local part.Maximum 190 charactersExample: Jane Example
status stringquery or JSON No User state used by PATCH. DELETE sets deleted.Options: pending, active, blocked, deletedExample: active

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okusersuserpublic_iduser_idemailnamestatusemail_verified_atlast_login_atcreated_atupdated_atinvitation_sentexpires_in_dayserrormessage

Important behaviour

  • POST creates or refreshes a pending user and sends an invitation. It does not return the invitation token. Customer business data should remain in the customer application and link to the stable issuer + subject identity.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/users?limit=100&id=iu_example&email=person%40example.com"
GET / POST / DELETE /v1/identity/invitationsCreate, resend or revoke hosted-login invitations. 5 units
Authentication Bearer server key Methods GET / POST / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id integerquery or JSON No Invitation numeric ID. Required for resend and DELETE.Example: 123
action stringquery or JSON No Use resend to issue and email a fresh invitation token while the invitation is still pending.Options: resendExample: resend
email stringquery or JSON No Email address for a new invitation.Maximum 254 charactersExample: person@example.com
name stringquery or JSON No Invitee display name.Maximum 190 charactersExample: Jane Example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okinvitationsinvitationiduser_idemailnameexpires_ataccepted_atrevoked_atcreated_atsentoriginal_link_preservederrormessage

Important behaviour

  • Invitation tokens are short-lived security credentials stored as hashes and delivered by email; they are intentionally not revealable from the portal or API.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/invitations?id=123&action=resend&email=person%40example.com"
GET / DELETE /v1/identity/sessionsList and revoke hosted identity sessions. 3 units
Authentication Bearer server key Methods GET / DELETE Cost 3 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
limit integerquery or JSON No Maximum sessions returned by GET.Default: 100 · Min: 1 · Max: 500Example: 100
id stringquery or JSON No Session public ID to revoke with DELETE.Example: is_example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

oksessionsiduser_idauth_methodcreated_atlast_seen_atexpires_atrevoked_aterrormessage

Important behaviour

  • DELETE revokes the selected Identity session. Session cookies and raw session tokens are never returned by this management API.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/sessions?limit=100&id=is_example"
GET /v1/identity/eventsRead authentication and security events. 3 units
Authentication Bearer server key Methods GET Cost 3 units per successful request Input query string

Request options

OptionType and locationRequiredDescription, defaults and accepted values
limit integerquery or JSON No Maximum audit/security events returned.Default: 100 · Min: 1 · Max: 500Example: 100

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okeventsevent_typeoutcomeuser_idapplication_idcreated_atmetadataerrormessage

Important behaviour

  • Security events are tenant-scoped. Sensitive credentials, authorization codes and raw tokens are not included in event payloads.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/events?limit=100"
GET / POST / DELETE /v1/identity/domainsPrepare and verify custom hosted-login domains. 5 units
Authentication Bearer server key Methods GET / POST / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id integerquery or JSON No Identity domain numeric ID. Required for verify and DELETE.Example: 12
action stringquery or JSON No POST verify rechecks DNS ownership for an existing domain.Options: verifyExample: verify
hostname stringquery or JSON No Hostname to register. Required when creating a domain.Maximum 253 charactersExample: login.example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okdomainsdomainidhostnamestatusverification_nameverification_valueverified_atcreated_atupdated_aterrormessage

Important behaviour

  • DNS ownership verification is required before the domain can be trusted for Identity use.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/domains?id=12&action=verify&hostname=login.example.com"
GET / POST / PATCH / DELETE /v1/identity/forward-authManage reverse-proxy Forward Auth policies and proxy secrets. 5 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or JSON No Forward Auth policy public ID. Required for PATCH, DELETE and credential actions.Example: ifa_example
action stringquery or JSON No POST credential action. Omit to create a Forward Auth policy.Options: rotate_secret, revoke_credentialExample: rotate_secret
credential_id stringquery or JSON No Forward Auth credential public ID to revoke.Example: ifc_example
grace_seconds integerquery or JSON No Overlap window for the old proxy secret after rotation.Default: 86400 · Min: 0 · Max: 604800Example: 86400
name stringquery or JSON No Policy name. Required on create.Maximum 190 charactersExample: Internal Admin
allowed_hosts arrayquery or JSON No Exact hostnames accepted from the reverse proxy. Wildcards are rejected.Example: ["admin.example.com"]
allowed_path_prefixes arrayquery or JSON No Allowed URL path prefixes protected by this policy.Example: ["/"]
session_ttl_seconds integerquery or JSON No Maximum Forward Auth session lifetime.Default: 43200 · Min: 900 · Max: 604800Example: 43200
status stringquery or JSON No Forward Auth policy state used by PATCH.Options: active, suspendedExample: active

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okpoliciespolicyidnamecheck_urlallowed_hostsallowed_path_prefixessession_ttl_secondsproxy_secretproxy_secret_last_fourcredential_idcredentialsstatusprevious_credentials_valid_for_secondserrormessage

Important behaviour

  • Forward Auth proxy secrets are generated by Actoki, hash-verified, vault-encrypted for authorised re-display, and support overlapping rotation for zero-downtime proxy updates.
  • Keep both old and new proxy secrets deployed only for the selected grace window. After valid_until the old secret is rejected; cleanup wipes its encrypted copy.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/forward-auth?id=ifa_example&action=rotate_secret&credential_id=ifc_example"
GET / POST / PATCH / DELETE /v1/identity/directoriesManage LDAP and Active Directory upstream identity connections. 5 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or JSON No Directory connection public ID. Required for PATCH and DELETE.Example: idc_example
provider stringquery or JSON No Directory type.Default: ldap · Options: ldap, active_directoryExample: ldap
name stringquery or JSON No Connection name. Required on create.Maximum 190 charactersExample: Corporate Directory
host stringquery or JSON No LDAP hostname without URL scheme, path or wildcard. Required on create.Maximum 253 charactersExample: ldap.example.com
port integerquery or JSON No LDAP TCP port. Defaults to 636 for LDAPS or 389 for StartTLS.Min: 1 · Max: 65535Example: 636
tls_mode stringquery or JSON No TLS transport mode.Default: ldaps · Options: ldaps, starttlsExample: ldaps
base_dn stringquery or JSON No LDAP search base DN. Required on create.Maximum 1024 charactersExample: dc=example,dc=com
bind_dn stringquery or JSON No Optional service bind DN.Maximum 1024 charactersExample: cn=reader,dc=example,dc=com
bind_password stringquery or JSON No Write-only bind password. Empty on PATCH clears it; non-empty values are encrypted at rest and are never returned.Example: ••••••••
user_filter stringquery or JSON No LDAP user filter. Must contain {email} or {username}.Maximum 1024 charactersExample: (&(objectClass=person)(mail={email}))
email_attribute stringquery or JSON No LDAP attribute containing the user email.Default: mailExample: mail
name_attribute stringquery or JSON No LDAP attribute containing the display name.Example: cn
subject_attribute stringquery or JSON No Stable LDAP attribute mapped to the upstream subject.Example: entryUUID
group_attribute stringquery or JSON No LDAP group-membership attribute.Default: memberOfExample: memberOf
required_group_dn stringquery or JSON No Optional group DN required for sign-in.Maximum 1024 charactersExample: cn=employees,ou=groups,dc=example,dc=com
priority integerquery or JSON No Directory evaluation priority; lower values run first.Default: 100 · Min: 0 · Max: 65535Example: 100
network_timeout_seconds integerquery or JSON No Directory network timeout.Default: 5 · Min: 2 · Max: 20Example: 5
status stringquery or JSON No Directory state.Options: active, suspendedExample: active

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okconnectionsconnectionidnameproviderhostporttls_modebase_dnbind_dnbind_password_configureduser_filteremail_attributename_attributesubject_attributegroup_attributerequired_group_dnprioritynetwork_timeout_secondsstatuscreated_atupdated_aterrormessage

Important behaviour

  • Directory bind passwords are customer-supplied upstream credentials. They are encrypted at rest and intentionally remain masked; replace the value to change it rather than revealing it.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/directories?id=idc_example&provider=ldap&name=Corporate+Directory"
GET / POST / PATCH /v1/identity/policyManage passkey, email-code, magic-link, WhatsApp OTP and passwordless-only authentication policy. 2 units
Authentication Bearer server key Methods GET / POST / PATCH Cost 2 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
passkey_enabled booleanquery or JSON No Allow passkey authentication.Example: true
password_enabled booleanquery or JSON No Allow password authentication. Passwordless-only mode forces this off.Example: true
email_otp_enabled booleanquery or JSON No Allow sign-in by emailed one-time code.Example: true
email_magic_link_enabled booleanquery or JSON No Allow email magic-link sign-in.Example: false
whatsapp_otp_enabled booleanquery or JSON No Allow WhatsApp OTP when the platform and tenant WhatsApp configuration permit it.Example: false
passwordless_only booleanquery or JSON No Disable password login and require passwordless/federated methods.Example: false
auto_provision_federated booleanquery or JSON No Automatically create/link a tenant user after a trusted federated provider authenticates them.Example: false

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okpolicypasskey_enabledpassword_enabledemail_otp_enabledemail_magic_link_enabledwhatsapp_otp_enabledwhatsapp_otp_configuredwhatsapp_provider_availablepasswordless_onlyauto_provision_federatederrormessage

Important behaviour

  • Actoki refuses policy changes that would leave a tenant with no usable sign-in method.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/policy?passkey_enabled=true&password_enabled=true&email_otp_enabled=true"
GET / POST / PATCH / DELETE /v1/identity/providersManage Google, Apple, Microsoft, GitHub, Facebook, Instagram, X, TikTok, external OIDC and SAML upstream identity providers. 5 units
Authentication Bearer server key Methods GET / POST / PATCH / DELETE Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
id stringquery or JSON No Provider connection public ID. Required to PATCH or DELETE an existing connection.Example: ifc_example
provider stringquery or JSON No Provider type. Required on create.Options: google, apple, microsoft, github, facebook, instagram, x, tiktok, oidc, samlExample: google
name stringquery or JSON No Customer-facing connection name.Maximum 190 charactersExample: Google
status stringquery or JSON No Provider state. Active providers require their provider-specific mandatory settings.Options: active, suspendedExample: suspended
client_id stringquery or JSON No OAuth/OIDC client ID for non-SAML providers.Maximum 512 charactersExample: provider-client-id
client_secret stringquery or JSON No Write-only provider secret for non-Apple OAuth/OIDC providers. Encrypted at rest and never returned.Example: ••••••••
private_key stringquery or JSON No Write-only Apple private key. Encrypted at rest and never returned.Example: -----BEGIN PRIVATE KEY-----...
discovery_url stringquery or JSON No HTTPS OpenID Connect discovery URL; configurable for generic OIDC.Example: https://idp.example.com/.well-known/openid-configuration
scopes stringquery or JSON No Space-separated upstream provider scopes. Provider defaults are used when omitted.Maximum 1000 charactersExample: openid email profile
microsoft_tenant stringquery or JSON No Microsoft tenant selector, e.g. common, organisations or tenant ID.Maximum 100 charactersExample: common
team_id stringquery or JSON No Apple Developer Team ID.Example: ABCDE12345
key_id stringquery or JSON No Apple Sign in with Apple key ID.Example: ABC123DEFG
graph_version stringquery or JSON No Meta Graph API version used by Facebook.Example: v25.0
idp_entity_id stringquery or JSON No SAML IdP entity ID. Required when an active SAML connection is configured.Example: https://idp.example.com/metadata
sso_url stringquery or JSON No SAML IdP HTTPS SSO URL.Example: https://idp.example.com/sso
x509_cert stringquery or JSON No SAML IdP PEM X.509 signing certificate.Example: -----BEGIN CERTIFICATE-----...
email_attribute stringquery or JSON No SAML assertion attribute containing email.Default: emailExample: email
name_attribute stringquery or JSON No SAML assertion attribute containing display name.Default: nameExample: name

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okconnectionsconnectionidprovidernamestatusclient_idsecret_configureddiscovery_urlscopesconfigcallback_urlsaml_acs_urlsaml_metadata_urlcreated_atupdated_aterrormessage

Important behaviour

  • Customer-supplied upstream provider secrets/keys are encrypted but remain intentionally masked; the API never returns them. Submit a replacement value to change them.
  • Provider availability is also subject to the global platform policy. Actoki prevents disabling the last usable authentication method for a tenant.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/providers?id=ifc_example&provider=google&name=Google"
GET / POST / PATCH /v1/identity/whatsappConfigure WhatsApp Cloud API authentication-code delivery for hosted Identity. 5 units
Authentication Bearer server key Methods GET / POST / PATCH Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
enabled booleanquery or JSON No Enable or suspend WhatsApp OTP for the tenant.Default: falseExample: false
phone_number_id stringquery or JSON No Meta WhatsApp Cloud API Phone Number ID.Maximum 32 charactersExample: 123456789012345
access_token stringquery or JSON No Write-only WhatsApp Cloud API access token. Encrypted at rest and never returned.Example: ••••••••
graph_version stringquery or JSON No Meta Graph API version.Default: v25.0Example: v25.0
template_name stringquery or JSON No Approved authentication template name.Default: actoki_auth_code · Maximum 512 charactersExample: actoki_auth_code
language_code stringquery or JSON No Template language code.Default: en_GBExample: en_GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

okwhatsapptenant_idavailablestatuseffective_statusphone_number_idaccess_token_configuredgraph_versiontemplate_namelanguage_codeerrormessage

Important behaviour

  • WhatsApp is an OTP delivery channel, not an OAuth identity provider. The customer-supplied Cloud API token is encrypted and remains masked; submit a replacement token to change it.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/identity/whatsapp?enabled=false&phone_number_id=123456789012345&access_token=%E2%80%A2%E2%80%A2%E2%80%A2%E2%80%A2%E2%80%A2%E2%80%A2%E2%80%A2%E2%80%A2"
Security

Security Headers & Secret Scanner API

v1.0.0

Security header checks, TLS basics and secret/API key scanning.

8 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/security/headersHTTP security headers 10 unitsPreview
Preview dependency: Requires the isolated remote inspection worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readyheaders_to_check

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/headers?url=https%3A%2F%2Fexample.com"
GET / POST /v1/security/csp-checkCSP check 10 unitsPreview
Preview dependency: Requires the isolated remote inspection worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readyheaders_to_check

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/csp-check?url=https%3A%2F%2Fexample.com"
GET / POST /v1/security/hsts-checkHSTS check 10 unitsPreview
Preview dependency: Requires the isolated remote inspection worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readyheaders_to_check

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/hsts-check?url=https%3A%2F%2Fexample.com"
GET / POST /v1/security/cookie-flagsCookie flags check 10 unitsPreview
Preview dependency: Requires the isolated remote inspection worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded
OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readyheaders_to_check

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/cookie-flags?url=https%3A%2F%2Fexample.com"
GET / POST /v1/security/tls-basicTLS certificate basics 10 unitsPreview
Preview dependency: Requires the isolated TLS inspection worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

hosterror

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/tls-basic?url=https%3A%2F%2Fexample.com"
GET / POST /v1/security/secrets-scanSecret scanner 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

api_keyprivate_keyjwthas_secretsmatches

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/secrets-scan?text=example"
GET / POST /v1/security/api-key-detectAPI key detector 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

api_keyprivate_keyjwthas_secretsmatches

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/api-key-detect?text=example"
GET / POST /v1/security/env-checkENV file safety check 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON Yes Text to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

api_keyprivate_keyjwthas_secretsmatches

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/security/env-check?text=example"
API category

Tax

1 services · 2 endpoints
Tax

VAT API

v1.0.0

Example drop-in service for VAT validation and calculations.

2 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/vat/checkExample VAT number format check. 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
vat stringquery or form No Request option: Vat.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

vatformat_validmessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/vat/check?vat=example"
GET / POST /v1/vat/calculateExample VAT calculation endpoint. 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
net stringquery or form No Request option: Net.Example: example
rate stringquery or form No Request option: Rate.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

netratevatgross

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/vat/calculate?net=example&rate=example"
API category

Travel

3 services · 17 endpoints
Travel

Government Travel Advice API

v1.0.0

Clean, structured travel advice sourced from official government publications, normalised into plain text for applications and customer journeys.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/travel-advice/countryReturn comprehensive official travel advice for a destination as clean plain text. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
provider stringquery or JSON No Official advice provider.Default: uk_fcdo · Options: uk_fcdoExample: uk_fcdo
destination stringquery or JSON Yes Destination country name or supported country slug.Example: france
country stringquery or JSON No Alias for destination.Example: france

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Important behaviour

  • Provide destination or country. The UK FCDO connector is currently the production-enabled provider.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel-advice/country?provider=uk_fcdo&destination=france&country=france"
GET / POST /v1/travel-advice/summaryReturn a concise destination summary, warning status and latest update. 3 units
Authentication Bearer server key Methods GET / POST Cost 3 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
provider stringquery or JSON No Official advice provider.Default: uk_fcdo · Options: uk_fcdoExample: uk_fcdo
destination stringquery or JSON Yes Destination country name or supported country slug.Example: france
country stringquery or JSON No Alias for destination.Example: france

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessageproviderdestinationadvisoryupdated_atsource_urldisclaimercache

Important behaviour

  • Provide destination or country. The UK FCDO connector is currently the production-enabled provider.

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel-advice/summary?provider=uk_fcdo&destination=france&country=france"
GET /v1/travel-advice/sourcesList official providers, coverage and current integration status. 1 units
Authentication Bearer server key Methods GET Cost 1 units per successful request Input query string

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorcodemessage

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel-advice/sources"
Travel

Booking & Travel Rules API

v1.0.0

Travel utility rules for airports, documents, time zones and trip planning.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/travel/baggage-basicAirline baggage-rules integration contract 10 unitsPreview
Preview dependency: Requires a maintained airline baggage-rules provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

notecarry_onchecked_bag

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/baggage-basic"
GET / POST /v1/travel/airport-min-connect-timeMinimum connection time helper 10 unitsPreview
Preview dependency: Indicative timings are not a production minimum-connect-time data source. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
airport stringquery or JSON No Request option: Airport.Default: LHRExample: LHR

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

airportdomestic_minutesinternational_minutesnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/airport-min-connect-time?airport=LHR"
GET / POST /v1/travel/flight-duration-estimateFlight duration estimate 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
distance_km numberquery or JSON No Request option: Distance Km.Default: 0Example: 0
from stringquery or JSON No Request option: From.Default: LHRExample: LHR
to stringquery or JSON No Request option: To.Default: JFKExample: JFK

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

distance_kmestimated_hours

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/flight-duration-estimate?distance_km=0&from=LHR&to=JFK"
GET / POST /v1/travel/country-documents-basicBasic country document guidance 10 unitsPreview
Preview dependency: Requires a maintained authoritative travel-document provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
country stringquery or JSON No ISO country code.Default: USExample: US

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

countrypassport_requiredvisa_note

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/country-documents-basic?country=US"
GET / POST /v1/travel/holiday-calendarPublic holiday calendar 10 unitsPreview
Preview dependency: Requires a maintained regional public-holiday dataset. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
country stringquery or JSON No ISO country code.Default: GBExample: GB
year integerquery or JSON Yes Request option: Year.Example: 1

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

providercountryyearnote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/holiday-calendar?country=GB&year=1"
GET / POST /v1/travel/time-at-destinationDestination local time 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
timezone stringquery or JSON No IANA timezone identifier.Default: Europe/LondonExample: Europe/London

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/time-at-destination?timezone=Europe%2FLondon"
GET / POST /v1/travel/jetlag-windowJetlag planning helper 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
timezone_difference_hours integerquery or JSON No Request option: Timezone Difference Hours.Default: 5 · Min: -14 · Max: 14Example: 5

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

timezone_difference_hoursadjustment_daysadvice

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/jetlag-window?timezone_difference_hours=5"
Travel

Travel & Country Utilities API

v1.0.0

Resolve practical airport, country, currency, dial-code and time-zone information for travel applications.

7 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/travel/airportAirport code lookup 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
code stringquery or JSON No Short code or identifier.Default: LHR · Maximum 4 charactersExample: LHR

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

LHRnamecitycountrylatlngLGWJFKDXBcodeairport

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/airport?code=LHR"
GET / POST /v1/travel/airport-distanceDistance between airports 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
from stringquery or JSON No Request option: From.Default: LHR · Maximum 4 charactersExample: LHR
to stringquery or JSON No Request option: To.Default: JFK · Maximum 4 charactersExample: JFK
code stringquery or form No Short code or identifier.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

fromtodistance_km

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/airport-distance?from=LHR&to=JFK&code=example"
GET / POST /v1/travel/timezoneTravel timezone lookup 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
timezone stringquery or JSON No Request option: Timezone.Default: Europe/LondonExample: Europe/London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

timezonenow

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/timezone?timezone=Europe%2FLondon"
GET / POST /v1/travel/countryCountry information 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
code stringquery or JSON No Short code or identifier.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

GBnamecurrencydial_codeUSAEcodecountry

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/country?code=GB"
GET / POST /v1/travel/visa-basicVisa guidance integration contract 10 unitsPreview
Preview dependency: Requires a maintained authoritative visa-information provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

No request fields.Authenticate and call the endpoint as shown. It reads account state or returns a catalogue/list without endpoint-specific input.

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

noteresult

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/visa-basic"
GET / POST /v1/travel/dial-codeCountry dial code 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
code stringquery or JSON No ISO 3166-1 alpha-2 country code.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valuecountry

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/dial-code?code=GB"
GET / POST /v1/travel/currencyCountry currency 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
code stringquery or JSON No ISO 3166-1 alpha-2 country code.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valuecountry

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/travel/currency?code=GB"
API category

Utilities

3 services · 16 endpoints
Utilities

Conversion API

v1.0.0

Unit, temperature, file size, timezone and currency conversions.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/convert/unitConvert common measurement units. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value numberquery or JSON No Request option: Value.Default: 1Example: 1
from stringquery or JSON No Request option: From.Default: m · Maximum 40 charactersExample: m
to stringquery or JSON No Request option: To.Default: km · Maximum 40 charactersExample: km

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/unit?value=1&from=m&to=km"
GET / POST /v1/convert/batchBatch unit conversion. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
items arrayJSON No Array of input items.Example: []

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

items

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/batch?items=%5B%5D"
GET / POST /v1/convert/currencyConvert currencies using a configured, timestamped rate source. 5 unitsPreview
Preview dependency: Requires a configured exchange-rate provider with timestamped rates. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value numberquery or JSON No Request option: Value.Default: 1Example: 1
from stringquery or JSON No Request option: From.Default: GBP · Maximum 3 charactersExample: GBP
to stringquery or JSON No Request option: To.Default: GBP · Maximum 3 charactersExample: GBP

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

warningresultratefromto

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/currency?value=1&from=GBP&to=GBP"
GET / POST /v1/convert/timezoneConvert a time between time zones. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
time stringquery or JSON No Request option: Time.Default: now · Maximum 80 charactersExample: now
from stringquery or JSON No Request option: From.Default: UTC · Maximum 80 charactersExample: UTC
to stringquery or JSON No Request option: To.Default: Europe/London · Maximum 80 charactersExample: Europe/London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

timeerror

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/timezone?time=now&from=UTC&to=Europe%2FLondon"
GET / POST /v1/convert/temperatureTemperature conversion. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value numberquery or JSON No Request option: Value.Default: 1Example: 1
from stringquery or JSON No Request option: From.Default: m · Maximum 40 charactersExample: m
to stringquery or JSON No Request option: To.Default: km · Maximum 40 charactersExample: km

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/temperature?value=1&from=m&to=km"
GET / POST /v1/convert/file-sizeDigital storage conversion. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value numberquery or JSON No Request option: Value.Default: 1Example: 1
from stringquery or JSON No Request option: From.Default: m · Maximum 40 charactersExample: m
to stringquery or JSON No Request option: To.Default: km · Maximum 40 charactersExample: km

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/convert/file-size?value=1&from=m&to=km"
Utilities

Core Utilities

v1.0.0

Password generation, percentage calculations and small utility APIs.

2 endpoints Enabled by default Required service Bearer key authentication Actoki owner
GET / POST /v1/password1Password-style password generator: random passwords, memorable word passwords and numeric PINs. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
words integerquery or JSON No Request option: Words.Default: 4 · Min: 3 · Max: 10 · Options: memorable, words, pin, pins, numericExample: 4
separator stringquery or JSON No Request option: Separator.Default: - · Maximum 3 charactersExample: -
capitalize booleanquery or JSON No Request option: Capitalize.Default: trueExample: true
numbers booleanquery or JSON No Request option: Numbers.Default: trueExample: true
digits integerquery or JSON No Request option: Digits.Default: 6 · Min: 4 · Max: 32 · Options: memorable, words, pin, pins, numericExample: 6
group integerquery or JSON No Request option: Group.Default: 0 · Min: 0 · Max: 8Example: 0
length integerquery or JSON No Request option: Length.Default: 20 · Min: 8 · Max: 128Example: 20
uppercase booleanquery or JSON No Request option: Uppercase.Default: trueExample: true
lowercase booleanquery or JSON No Request option: Lowercase.Default: trueExample: true
symbols booleanquery or JSON No Request option: Symbols.Default: falseExample: false
avoid_ambiguous booleanquery or JSON No Request option: Avoid Ambiguous.Default: trueExample: true
min_numbers integerquery or JSON Yes Request option: Min Numbers.Min: 0 · Max: 32Example: 1
min_symbols integerquery or JSON Yes Request option: Min Symbols.Min: 0 · Max: 32Example: 1
type stringquery or form No Request option: Type.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

type

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/password?words=4&separator=-&capitalize=true&min_numbers=1&min_symbols=1"
GET / POST /v1/percentagePercentage calculator endpoint. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
value stringquery or form No Request option: Value.Example: example
percent stringquery or form No Request option: Percent.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

result

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/percentage?value=example&percent=example"
Utilities

Text Tools API

v1.0.0

Slugify, case conversion, counts, extraction, de-duplication, diff and lorem ipsum.

8 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/text/slugifyCreate slug. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 1000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

slug

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/slugify?text=example"
GET / POST /v1/text/caseConvert case. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example
case stringquery or JSON No Request option: Case.Default: title · Maximum 20 characters · Options: upper, lowerExample: title

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

text

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/case?text=example&case=title"
GET / POST /v1/text/countCount text. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

characterswordslines

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/count?text=example"
GET / POST /v1/text/extract-emailsExtract emails. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phonesExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

items

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/extract-emails?text=example"
GET / POST /v1/text/extract-phonesExtract phones. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phonesExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

items

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/extract-phones?text=example"
GET / POST /v1/text/remove-duplicatesRemove duplicates. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
text stringquery or JSON No Text to process.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

text

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/remove-duplicates?text=example"
GET / POST /v1/text/diffSimple diff summary. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
old stringquery or JSON No Request option: Old.Default: · Maximum 100000 charactersExample: example
new stringquery or JSON No Request option: New.Default: · Maximum 100000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

changedold_lengthnew_length

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/diff?old=example&new=example"
GET / POST /v1/text/loremGenerate lorem ipsum. 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
words integerquery or JSON No Request option: Words.Default: 50 · Min: 1 · Max: 500Example: 50

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

text

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/text/lorem?words=50"
API category

Validation

3 services · 16 endpoints
Validation

Identity Document Helper API

v1.0.0

Parse and validate common identity-document formats without exposing permanent credentials to the browser.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/id/mrz-parseParse MRZ text 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
mrz stringquery or JSON Yes Request option: Mrz.Maximum 200 characters · Options: /v1/id/mrz-parse, /v1/id/passport-mrzExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valid_formatraw

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/id/mrz-parse?mrz=example"
GET / POST /v1/id/passport-mrzPassport MRZ helper 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
mrz stringquery or JSON Yes Request option: Mrz.Maximum 200 characters · Options: /v1/id/mrz-parse, /v1/id/passport-mrzExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valid_formatraw

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/id/passport-mrz?mrz=example"
GET / POST /v1/id/ibanIBAN format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
iban stringquery or JSON Yes Request option: Iban.Maximum 60 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

ibanvalid_format

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/id/iban?iban=example"
GET / POST /v1/id/ni-number-formatUK NI number format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
ni stringquery or JSON Yes Request option: Ni.Maximum 20 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

nivalid_format

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/id/ni-number-format?ni=example"
GET / POST /v1/id/vat-formatVAT number format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
vat stringquery or JSON Yes Request option: Vat.Maximum 30 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

vatvalid_format

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/id/vat-format?vat=example"
Validation

Phone Number API

v1.0.0

Validate, format and interpret international phone numbers for cleaner customer data.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/phone/validateValidate phone number 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
phone stringquery or JSON Yes Telephone number.Example: +442079460000
country stringquery or JSON No ISO country code.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operation

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/phone/validate?phone=%2B442079460000&country=GB"
GET / POST /v1/phone/formatFormat phone number 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
phone stringquery or JSON Yes Telephone number.Example: +442079460000
country stringquery or JSON No ISO country code.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operation

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/phone/format?phone=%2B442079460000&country=GB"
GET / POST /v1/phone/countryDetect phone country from prefix 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
phone stringquery or JSON Yes Telephone number.Example: +442079460000
country stringquery or JSON No ISO country code.Default: GB · Maximum 2 charactersExample: GB

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

operation

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/phone/country?phone=%2B442079460000&country=GB"
Validation

Form Validation API

v1.0.0

Validate common form inputs with predictable JSON responses and field-level results.

8 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/validate/emailValidate email format 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
email stringquery or JSON No Email address.Default: Example: user@example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valid

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/email?email=user%40example.com"
GET / POST /v1/validate/phoneValidate phone format 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
phone stringquery or JSON No Telephone number.Default: Example: +442079460000
country stringquery or JSON No ISO country code.Default: GBExample: GB

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/phone?phone=%2B442079460000&country=GB"
GET / POST /v1/validate/urlValidate URL 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON No Absolute HTTP or HTTPS URL.Default: Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

valid

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/url?url=https%3A%2F%2Fexample.com"
GET / POST /v1/validate/domainValidate domain and DNS 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
domain stringquery or JSON No Domain name without a path.Default: Example: example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

domainvalidhas_dns

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/domain?domain=example.com"
GET / POST /v1/validate/postcodeValidate UK postcode 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
postcode stringquery or JSON No Request option: Postcode.Default: Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

validcountry

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/postcode?postcode=example"
GET / POST /v1/validate/password-strengthPassword strength score 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
password stringquery or JSON No Request option: Password.Default: · Maximum 500 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

scorestrength

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/password-strength?password=example"
GET / POST /v1/validate/vatVAT format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
vat stringquery or JSON Yes VAT registration number to validate.Maximum 30 charactersExample: GB123456789

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/vat?vat=GB123456789"
GET / POST /v1/validate/ibanIBAN format check 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
iban stringquery or JSON Yes IBAN to validate; spaces are ignored.Maximum 60 charactersExample: GB82 WEST 1234 5698 7654 32

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/validate/iban?iban=GB82+WEST+1234+5698+7654+32"
API category

Verification

1 services · 3 endpoints
Verification

Email Verification

v1.0.0

Single and bulk email verification, suppression checks, disposable-domain checks and SMTP risk scoring.

3 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/email/checkFull email verification. SMTP mode has a 22-unit minimum (2.2p). 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
smtp stringquery or form No Request option: Smtp.Example: example
email stringquery or form No Email address.Example: user@example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

result

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email/check?smtp=example&email=user%40example.com"
POST /v1/email/bulkCreate a bulk email verification job. 15 units
Authentication Bearer server key Methods POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
emails stringquery or form No Request option: Emails.Example: user@example.com
smtp stringquery or form No Request option: Smtp.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorjob_idtotalsmtp

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --request POST \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "emails": "user@example.com",
    "smtp": "example"
}' \
  "https://actoki.com/v1/email/bulk"
GET /v1/email/bulk-statusRead a bulk email verification job status. 5 units
Authentication Bearer server key Methods GET Cost 5 units per successful request Input query string

Request options

OptionType and locationRequiredDescription, defaults and accepted values
job_id stringquery or form No Request option: Job Id.Example: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

errorjob

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/email/bulk-status?job_id=example"
API category

Weather

1 services · 4 endpoints
Weather

Weather & Climate Lookup API

v1.0.0

Current conditions, forecasts, travel windows and climate averages through a configured weather provider.

4 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/weather/currentCurrent weather conditions 10 unitsPreview
Preview dependency: Requires the configured weather-data provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
location stringquery or JSON No Map centre location object.Default: LondonExample: London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

locationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/weather/current?location=London"
GET / POST /v1/weather/forecastWeather forecast 10 unitsPreview
Preview dependency: Requires the configured weather-data provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
location stringquery or JSON No Map centre location object.Default: LondonExample: London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

locationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/weather/forecast?location=London"
GET / POST /v1/weather/travel-windowTravel weather window 10 unitsPreview
Preview dependency: Requires the configured weather-data provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
location stringquery or JSON No Map centre location object.Default: LondonExample: London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

locationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/weather/travel-window?location=London"
GET / POST /v1/weather/climate-averageClimate averages for a location 10 unitsPreview
Preview dependency: Requires the configured climate-data provider. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
location stringquery or JSON No Map centre location object.Default: LondonExample: London

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

locationprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/weather/climate-average?location=London"
API category

Web

2 services · 11 endpoints
Web

Accessibility Audit API

v1.0.0

Basic accessibility, contrast, heading, forms and alt text checks.

5 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/accessibility/pagePage accessibility audit 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON Yes HTML document to audit for alternative text, heading structure and form labels.Maximum 200000 charactersExample: <main><h1>Example</h1><img src="photo.jpg" alt=""></main>

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

alt_textheadingsforms

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accessibility/page?html=%3Cmain%3E%3Ch1%3EExample%3C%2Fh1%3E%3Cimg+src%3D%22photo.jpg%22+alt%3D%22%22%3E%3C%2Fmain%3E"
GET / POST /v1/accessibility/contrastColour contrast checker 15 unitsPreview
Preview dependency: Requires the complete document and computed-style inspection engine. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
foreground stringquery or JSON No Request option: Foreground.Default: #111111Example: #111111
background stringquery or JSON No Request option: Background.Default: #ffffffExample: #ffffff

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

foregroundbackgroundprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accessibility/contrast?foreground=%23111111&background=%23ffffff"
GET / POST /v1/accessibility/alt-textImage alt text checker 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON Yes HTML content to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

missing_alt_count

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accessibility/alt-text?html=example"
GET / POST /v1/accessibility/headingsHeading order checker 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON Yes HTML content to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

headingshas_h1

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accessibility/headings?html=example"
GET / POST /v1/accessibility/formsForm label checker 15 units
Authentication Bearer server key Methods GET / POST Cost 15 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
html stringquery or JSON Yes HTML content to process.Maximum 200000 charactersExample: example

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

input_countlabel_countlikely_missing_labels

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/accessibility/forms?html=example"
Web

URL Safety & Preview API

v1.0.0

URL preview, redirect, safety and UTM helpers.

6 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/url/previewURL preview metadata 5 unitsPreview
Preview dependency: Requires the isolated URL-fetching worker and SSRF controls. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/preview?url=https%3A%2F%2Fexample.com"
GET / POST /v1/url/redirect-chainInspect a URL redirect chain 5 unitsPreview
Preview dependency: Requires the isolated URL-fetching worker and SSRF controls. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/redirect-chain?url=https%3A%2F%2Fexample.com"
GET / POST /v1/url/safetyBasic URL safety score 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

risksignalsurl

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/safety?url=https%3A%2F%2Fexample.com"
GET / POST /v1/url/utm-builderUTM URL builder 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com
source stringquery or JSON No Request option: Source.Default: actokiExample: actoki
medium stringquery or JSON No Request option: Medium.Default: apiExample: api
campaign stringquery or JSON No Request option: Campaign.Default: campaignExample: campaign

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

utm_sourceutm_mediumutm_campaignurl

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/utm-builder?url=https%3A%2F%2Fexample.com&source=actoki&medium=api"
GET / POST /v1/url/utm-cleanerRemove tracking parameters 5 units
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

url

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/utm-cleaner?url=https%3A%2F%2Fexample.com"
GET / POST /v1/url/screenshot-basicCapture a controlled page screenshot 5 unitsPreview
Preview dependency: Requires the isolated browser-rendering worker. Requests return HTTP 503 before usage is recorded or credits are consumed.
Authentication Bearer server key Methods GET / POST Cost 5 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
url stringquery or JSON Yes Absolute HTTP or HTTPS URL.Example: https://example.com

Response fields

The normal response can include the standard ok, endpoint and credits_charged fields plus:

urlprovider_readynote

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/url/screenshot-basic?url=https%3A%2F%2Fexample.com"
API category

Workflow

1 services · 1 endpoints
Workflow

Business Rules / Decision API

v1.0.0

Evaluate straightforward business rules and return explainable decisions for application workflows.

1 endpoints Opt-in by default Optional service Bearer key authentication Actoki owner
GET / POST /v1/rules/evaluateEvaluate a JSON ruleset against input data 10 units
Authentication Bearer server key Methods GET / POST Cost 10 units per successful request Input application/json or application/x-www-form-urlencoded

Request options

OptionType and locationRequiredDescription, defaults and accepted values
rules stringJSON No Request option: Rules.Default: Example: example
input stringJSON No Request option: Input.Default: Example: example

Copy-ready examples

Use a permanent key only on a trusted backend. Choose a language to update the example in place.

Create account
cURL
API_KEY="YOUR_ACTOKI_API_KEY"

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $API_KEY" \
  "https://actoki.com/v1/rules/evaluate?rules=example&input=example"
Documentation generated from the service manifests shipped with this installation. Review the OpenAPI document for machine-readable discovery and the production checklist before launch.