Skip to main content

Overview

The Status API returns the current status of an asynchronous request by its request_id. Its primary purpose is to poll a long-running request such as a Company Addition request — until it completes. This is a free endpoint so it does not consume API credits. Endpoint
Pass the request_id returned when the original request was submitted as a path parameter.
As an alternative to polling, you can configure a webhook to be notified automatically when a request’s status changes.

Authentication

All requests must include an API key in the x-api-key HTTP header.
Never expose your API key in client-side code, browser requests, or public repositories. A missing or invalid key returns 401 Unauthorized.

Request Reference

Example Request

Response

Response envelope

Detail object

Fields for a company_addition request.