Skip to main content

​
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: /v1/status/{request_id}

​
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.

​
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

​
Successful Response Fields

Returns a JSON object with the following structure:
​
request_id
string
Unique identifier of the request being tracked.
​
request_type
string
The type of request. Example: company_addition.
​
status
string
Current status of the request. Possible values: pending, in_progress, completed, failed.
​
created_at
string
Timestamp when the request was created, in ISO 8601 format.
​
updated_at
string
Timestamp when the request was last updated, in ISO 8601 format.
​
detail
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.
​
company_addition_request_id
string
Identifier of the underlying request record.
​
company_name
string
Name of the company submitted for addition.
​
domain
string
Resolved domain of the submitted company.
​
status
string
Status of the underlying request. Possible values: pending, in_progress, completed, failed.
​
reason
string
Explanation when the request did not succeed. null unless the request has failed.
​
company_uuid
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.
​
created_at
string
Timestamp when the underlying request was created, in ISO 8601 format.
​
updated_at
string
Timestamp when the underlying request was last updated, in ISO 8601 format.