Company Addition API

Submits a company that is not yet in akta.pro’s database to be added, returning a request ID to track, or the existing company if it is already present.

POST /v1/company/addition-requests

Company Addition

cURL

curl --request POST \
  --url https://api.akta.pro/api/v1/company/addition-requests \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "company_name": "<string>",
  "website": "<string>"
}
'

import requests

url = "https://api.akta.pro/api/v1/company/addition-requests"

payload = {
    "company_name": "<string>",
    "website": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({company_name: '<string>', website: '<string>'})
};

fetch('https://api.akta.pro/api/v1/company/addition-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akta.pro/api/v1/company/addition-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_name' => '<string>',
    'website' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.akta.pro/api/v1/company/addition-requests"

	payload := strings.NewReader("{\n  \"company_name\": \"<string>\",\n  \"website\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.akta.pro/api/v1/company/addition-requests")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_name\": \"<string>\",\n  \"website\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akta.pro/api/v1/company/addition-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_name\": \"<string>\",\n  \"website\": \"<string>\"\n}"

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

New request created

{
    "already_exists": false,
    "company": null,
    "request_id": "2db01b38-5c81-4b3f-b76d-8b36aeed603b",
    "status": "pending",
    "domain": "brigadegroup.com",
    "credits_consumed": 0.00
}

{
    "already_exists": true,
    "company": {
        "uuid": "0002lx7",
        "website": "maximl.com",
        "domain": "maximl.com",
        "name": "Maximl Labs Private Limited",
        "legal_name": "Maximl Labs Private Limited"
    },
    "request_id": null,
    "status": null,
    "domain": "maximl.com",
    "credits_consumed": 0.00
}

Overview

The Company Addition API lets you add a company that isn’t yet in akta.pro’s database. Submit a company name and website, and if the company is new, an addition request is created and a request_id is returned so you can track it to completion (by polling the status endpoint or configuring a webhook). If the company already exists, no request is created and the existing company’s details are returned directly. This is a free endpoint and does not consume credits.

Endpoint Details

• Method: POST
• Endpoint: /v1/company/addition-requests

Authentication requirements

• Include a valid API key in the x-api-key request header.

Request

Request Parameters

Header Parameters

x-api-key · string · required

Your API key.

Content-Type · string · required

Must be application/json.

Body Parameters

company_name · string · required

Name of the company to add. Example: solios

website · string · required

Primary website URL of the company. Used to disambiguate and resolve the company. Example: https://www.soleosenergy.com/

Response

Successful Response Fields

Returns a JSON object with the following structure:

already_exists · boolean

true if the company is already in the database, in which case no addition request is created. false if a new addition request was created.

company · object

The existing company’s details when already_exists is true; otherwise null. See Company Object Fields below.

request_id · string

Unique identifier for the addition request, in UUID format. Use this to check request status or match webhook notifications. null when the company already exists.

status · string

Current status of the addition request at submission time. Typically pending. null when the company already exists.

domain · string

The resolved domain for the submitted company.

credits_consumed · float

Credits consumed by the request. This endpoint is free and always returns 0.00.

Company Object Fields

Returned only when already_exists is true.

uuid · string

Unique identifier for the company. Pass this as the company parameter in downstream APIs.

website · string

Primary website of the company.

domain · string

Resolved domain of the company.

name · string

Company name.

legal_name · string

Legal or registered name of the company.

New request created

{
    "already_exists": false,
    "company": null,
    "request_id": "2db01b38-5c81-4b3f-b76d-8b36aeed603b",
    "status": "pending",
    "domain": "brigadegroup.com",
    "credits_consumed": 0.00
}

{
    "already_exists": true,
    "company": {
        "uuid": "0002lx7",
        "website": "maximl.com",
        "domain": "maximl.com",
        "name": "Maximl Labs Private Limited",
        "legal_name": "Maximl Labs Private Limited"
    },
    "request_id": null,
    "status": null,
    "domain": "maximl.com",
    "credits_consumed": 0.00
}

Authorizations

x-api-key · string · header · required

API key obtained from your Akta account.

Body

application/json

Company addition request

company_name · string · required

Name of the company to add. Example: solios

website · string · required

Primary website URL of the company. Used to disambiguate and resolve the company. Example: https://www.soleosenergy.com/

Response

200

application/json

Company addition response

status · string

Example:

"success"

data · object

Show child attributes

credits_consumed · number<float>

Example:

0