Skip to main content
GET
Request Status

Overview

The Request Status API returns the current status of an asynchronous request by its request_id. Use it to poll a long-running request such as a Company Addition request until it completes. The response includes the top-level request status along with a detail object carrying request-type-specific fields. This is a free endpoint and does not consume credits.
As an alternative to polling this endpoint, you can configure a webhook to be notified automatically when a request’s status changes.

Endpoint Details

  • Method: GET
  • Endpoint: /api/v1/status/{request_id}/

Authentication requirements

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

Request

Request Parameters

Header Parameters

string
required
Your API key.

Path Parameters

string
required
The unique identifier of the request to check, returned when the original request was submitted. Example: 2db01b38-5c81-4b3f-b76d-8b36aeed603b

Response

Successful Response Fields

Returns a JSON object with the following structure:
string
Unique identifier of the request being tracked.
string
The type of request. Example: company_addition.
object
Request-type-specific details. Fields vary by request_type. See Detail Object Fields below for a company addition request.

Detail Object Fields

Fields for a company_addition request.
string
Name of the company submitted for addition.
string
Resolved domain of the submitted company.
string
Status of the request submitted.
string
Explanation when the request did not succeed. null unless the request has failed.
string
Akta UUID of the company once it has been added. null until the request is completed. Pass this as the company parameter in downstream APIs.
string
Timestamp when the underlying request was created, in ISO 8601 format.
string
Timestamp when the underlying request was last updated, in ISO 8601 format.

Authorizations

x-api-key
string
header
required

API key obtained from your Akta account.

Path Parameters

request_id
string
required

The unique identifier of the request to check, returned when the original request was submitted. Example: 2db01b38-5c81-4b3f-b76d-8b36aeed603b

Response

Status response

status
string
Example:

"success"

data
object
credits_consumed
number<float>
Example:

0