Overview
The Status API returns the current status of an asynchronous request by itsrequest_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
request_id returned when the original request was submitted as a path parameter.
Authentication
All requests must include an API key in thex-api-key HTTP header.
Request Reference
Example Request
Response
Response envelope
Detail object
Fields for acompany_addition request.
.png?fit=max&auto=format&n=SdGZnb5iGLBOelR9&q=85&s=6e183af2c7498a76797d0c8d9a81b986)
.png?fit=max&auto=format&n=SdGZnb5iGLBOelR9&q=85&s=7702c636c517001e39df24a084a9728d)