Overview
The Company Addition API lets you add a company that isn’t yet in akta.pro’s database. If the Company Search API returns no results for a company, submit it here and akta.pro will add it. If the company already exists in the database, the API tells you so immediately and returns its details — no addition request is created. Otherwise, this is an asynchronous, two-step endpoint:- Submit a company for addition with a
POSTrequest. If it’s new, the API returns arequest_id. - Track the request to completion, either by polling the request status endpoint with that
request_id, or by configuring a webhook to be notified when the status changes.
company_name and website in a JSON request body. The request_id returned can then be used to check the status of the addition request.
Plan availability: This endpoint is only available to Subscription and Enterprise plan users. Rate limits: Subscription plans are limited to 100 requests/day on this endpoint. Enterprise plans have custom rate limits — contact your account representative to configure these.
Authentication
All requests must include an API key in thex-api-key HTTP header.
Request Reference
Send a JSON body with theContent-Type: application/json header.
Example requests:
Response
The response depends on whether the company already exists in akta.pro’s database, indicated by thealready_exists flag.
Company already exists
If the company is already in the database, no addition request is created —request_id and status are both null, and the existing company’s details are returned directly in the company object. You can use its uuid straight away, with no need to track a request.
New addition request created
If the company is not yet in the database, an addition request is created.company is null, and a request_id and status are returned so you can track the request to completion.
Response fields
Company object
Returned only whenalready_exists is true.
Request statuses
Checking request status
Once a company is submitted, track the request to completion in one of two ways.Option 1 — Poll the status endpoint
Pass therequest_id to the status endpoint to retrieve the current status on demand.
completed, the uuid field is populated with the newly added company’s Akta identifier, which you can then use as the company parameter in the Company Data, News, and other APIs.
Option 2 — Configure a webhook
Instead of polling, configure a webhook to be notified automatically when the status of an addition request changes. akta.pro will send aPOST request to your configured endpoint each time a request transitions status (e.g. to completed or failed).
Learn more about configuring webhooks here.
Using the UUID in other APIs
Once the addition request iscompleted and you have the company’s uuid, pass it as the company parameter in downstream API calls:
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=e0cafcb914826d8adc60e5092187e1ca)
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=f214ebe0a940d8aa0f19a709a6bfd7fa)