> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akta.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# Request Status API

> Returns the current status of an asynchronous request, such as a company addition request, by its request ID.

## 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](/api-reference/supporting-apis/company-addition-api) 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.

<Tip>
  As an alternative to polling this endpoint, you can [configure a webhook](/webhook-config) to be notified automatically when a request's status changes.
</Tip>

## 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

<ParamField header="x-api-key" type="string" required>
  Your API key.
</ParamField>

#### Path Parameters

<ParamField path="request_id" type="string" required>
  The unique identifier of the request to check, returned when the original request was submitted. Example: `2db01b38-5c81-4b3f-b76d-8b36aeed603b`
</ParamField>

## Response

#### Successful Response Fields

Returns a JSON object with the following structure:

<ResponseField name="request_id" type="string">
  Unique identifier of the request being tracked.
</ResponseField>

<ResponseField name="request_type" type="string">
  The type of request. Example: `company_addition`.
</ResponseField>

<ResponseField name="status" type="string">
  Current status of the request. Possible values: `pending`, `in_progress`, `completed`, `failed`.
</ResponseField>

<ResponseField name="created_at" type="string">
  Timestamp when the request was created, in ISO 8601 format.
</ResponseField>

<ResponseField name="updated_at" type="string">
  Timestamp when the request was last updated, in ISO 8601 format.
</ResponseField>

<ResponseField name="detail" type="object">
  Request-type-specific details. Fields vary by `request_type`. See **Detail Object Fields** below for a company addition request.
</ResponseField>

#### Detail Object Fields

Fields for a `company_addition` request.

<ResponseField name="company_addition_request_id" type="string">
  Identifier of the underlying request record.
</ResponseField>

<ResponseField name="company_name" type="string">
  Name of the company submitted for addition.
</ResponseField>

<ResponseField name="domain" type="string">
  Resolved domain of the submitted company.
</ResponseField>

<ResponseField name="status" type="string">
  Status of the underlying request. Possible values: `pending`, `in_progress`, `completed`, `failed`.
</ResponseField>

<ResponseField name="reason" type="string">
  Explanation when the request did not succeed. `null` unless the request has failed.
</ResponseField>

<ResponseField name="company_uuid" type="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.
</ResponseField>

<ResponseField name="created_at" type="string">
  Timestamp when the underlying request was created, in ISO 8601 format.
</ResponseField>

<ResponseField name="updated_at" type="string">
  Timestamp when the underlying request was last updated, in ISO 8601 format.
</ResponseField>

<ResponseExample>
  ```json 200 expandable wrap theme={null}
  {
      "request_id": "2db01b38-5c81-4b3f-b76d-8b36aeed603b",
      "request_type": "company_addition",
      "status": "pending",
      "created_at": "2026-07-20T12:33:02.713287Z",
      "updated_at": "2026-07-20T12:33:02.713287Z",
      "detail": {
          "company_addition_request_id": "debdcbbb-8ddd-4084-be86-ca643ec5bad6",
          "company_name": "Brigade",
          "domain": "brigadegroup.com",
          "status": "pending",
          "reason": null,
          "company_uuid": null,
          "created_at": "2026-07-20T12:33:02.713287Z",
          "updated_at": "2026-07-20T12:33:03.393539Z"
      }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /v1/status/{request_id}
openapi: 3.0.3
info:
  title: Akta.pro API
  description: >
    Akta provides APIs for company intelligence and news monitoring:


    1. **News** – Enriched news articles with AI summaries, sentiment, event
    tags, industry classifications, and company mention resolution.

    2. **Company Enrichment** – Structured company data including firmographics,
    funding, headcount, and financials.

    3. **Company Search** – Free endpoint to resolve company names, domains, or
    UUIDs.

    4. **Product Reviews** – G2 product reviews with ratings and review content.

    5. **Employee Reviews** – Employee sentiment data with workplace ratings.


    **Authentication:** All endpoints require an API key in the `x-api-key` HTTP
    header.
  version: 1.0.0
  contact:
    url: https://akta.pro
servers:
  - url: https://api.akta.pro/api
    description: Production server
security: []
tags:
  - name: News
    description: Enriched news articles with AI summaries, sentiment, and company mentions
  - name: Company
    description: Company data enrichment, search, and addition
  - name: Reviews
    description: Product and employee reviews from external sources
  - name: Supporting APIs
    description: Utility endpoints for request tracking
externalDocs:
  description: Official Akta.pro API Documentation
  url: https://docs.akta.pro
paths:
  /v1/status/{request_id}:
    get:
      tags:
        - Supporting APIs
      summary: Request Status
      description: >
        Returns the current status of an asynchronous request, such as a company
        addition request, by its request ID.

        This is a free endpoint — it does not consume API credits.
      operationId: getRequestStatus
      parameters:
        - name: request_id
          in: path
          required: true
          schema:
            type: string
          description: >-
            The unique identifier of the request to check, returned when the
            original request was submitted. Example:
            2db01b38-5c81-4b3f-b76d-8b36aeed603b
      responses:
        '200':
          description: Status response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/StatusResponse'
                  credits_consumed:
                    type: number
                    format: float
                    example: 0
        '400':
          description: Bad request — invalid request ID.
        '401':
          description: Unauthorized — missing or invalid API key.
      security:
        - xApiKeyAuth: []
components:
  schemas:
    StatusResponse:
      type: object
      properties:
        request_id:
          description: Unique identifier of the request being tracked.
          type: string
        request_type:
          description: 'The type of request. Example: company_addition'
          type: string
        status:
          description: >-
            Current status of the request. Possible values: pending,
            in_progress, completed, failed.
          type: string
        created_at:
          description: Timestamp when the request was created, in ISO 8601 format.
          type: string
        updated_at:
          description: Timestamp when the request was last updated, in ISO 8601 format.
          type: string
        detail:
          $ref: '#/components/schemas/StatusDetail'
    StatusDetail:
      description: Request-type-specific details for company_addition request.
      type: object
      properties:
        company_addition_request_id:
          description: Identifier of the underlying request record.
          type: string
        company_name:
          description: Name of the company submitted for addition.
          type: string
        domain:
          description: Resolved domain of the submitted company.
          type: string
        status:
          description: >-
            Status of the underlying request. Possible values: pending,
            in_progress, completed, failed.
          type: string
        reason:
          description: >-
            Explanation when the request did not succeed. null unless the
            request has failed.
          type: string
          nullable: true
        company_uuid:
          description: >-
            Akta UUID of the company once it has been added. null until the
            request is completed.
          type: string
          nullable: true
        created_at:
          description: >-
            Timestamp when the underlying request was created, in ISO 8601
            format.
          type: string
        updated_at:
          description: >-
            Timestamp when the underlying request was last updated, in ISO 8601
            format.
          type: string
  securitySchemes:
    xApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key obtained from your Akta account.

````