Get MCA Document Status

Endpoint Overview

GET /api/v1/mca-api/status/mca_KHwqgnnunXmghCqcTmbY

Description

This API endpoint retrieves the current status of a Ministry of Corporate Affairs (MCA) document retrieval request. It provides comprehensive information about the requested company, including entity details, processing status, and a complete list of retrieved documents with their respective URLs, categories, and statuses.

Key Benefits

Track the real-time status of MCA document retrieval requests

Access comprehensive company documentation organized by categories

Obtain secure, time-limited URLs to download official company documents

Verify company credentials and incorporation details

Use Cases

Financial Services

Legal & Compliance

Business Partnerships

Due diligence during loan underwriting for corporate clients

Verification of company credentials before approving business accounts

Risk assessment for corporate investment opportunities

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication. Format: `Bearer {jwt_token}`
Content-Type	Yes	Application/json

Path Parameters

Parameter	Description
client_id	The unique identifier for the MCA document request (e.g., mca_KHwqgnnunXmghCqcTmbY)

This endpoint does not require a request body.

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Main response data
data.created_at	DateTime	Creation Date
data.entity_name	String	Name of the entity
data.credentials_provided	Boolean	Did user provide login credentials
data.status	String	Status of the order
data.mca_srn	String	MCA SRN
data.error	Boolean	Error in extraction
data.error_description	String	Error description
data.mca_payment	Boolean	Status of MCA payment
data.fetch_only	Boolean	Was the order in fetch only mode
data.fetch_order_registered	Boolean	Was the fetch requested
data.fetched	Boolean	Was the fetch completed
data.total_documents	Integer	Total MCA documents
data.completed_documents	Integer	Total MCA documents download completed
data.documents	List	List of MCA document objects
data.documents[].document_id	String	Document ID
data.documents[].document_name	String	Document name
data.documents[].category	String	Document category
data.documents[].type_of_document	String	Document type
data.documents[].status	String	Document download status
data.documents[].document_url	String	Document download URL
data.zip	Object	MCA document ZIP info
data.zip.status	String	Mca zip creation status
data.zip.zip_url	String	Zip download URL
status_code	Integer	HTTP status code
success	Boolean	Whether the request was successful
message	String	Message text
message_code	String	Message code

Example Successful Response

       {
  "data":
 {

    "created_at": null,
    "entity_name": "TECH SOLUTIONS PRIVATE LIMITED",
    "credentials_provided": false,
    "status": "completed",
    "mca_srn": null,
    "error": null,
    "error_description": null,
    "mca_payment": true,
    "fetch_only": null,
    "fetch_order_registered": null,
    "fetched": null,
    "total_documents": null,
    "completed_documents": null,
    "documents": [
      {
        "document_id": "edcefcd7-b26e-4bda-9374-0fbef0758a34",
        "document_name": "2017/04/20 CERTIFICATE OF INCORPORATION-20170420",
        "category": "Certificates",
        "type_of_document": null,
        "status": "completed",
        "document_url": "https://mca-test-bucket.s3.amazonaws.com/mca_documents/mca_ampKghRzCzyrLnamvfSn/Certificates/%5B20-04-2017%5D_CERTIFICATE_OF_INCORPORATION-20170420_0.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAWE3LGOMHK2UPET5N%2F20210927%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210927T070608Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=fcf754f5805106f15ca67fab2b131790ae3b203861b3c8ca9a38b499654de6ff"
      }
    ],
    "zip": {
      "status": null,
      "zip_url": null
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Authentication Error

Resource Not Found

Server Error

{
    "status_code": 401,
    "success": false,
    "message": "Authentication failed. Invalid token provided.",
    "message_code": "authentication_failed"
}

This error occurs when the JWT token is invalid, expired, or not provided.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement token refresh mechanisms to handle token expiration

Document URLs are time-limited (typically 30 minutes) - download documents promptly or request fresh URLs

Implement proper error handling for expired document URLs

User Experience Guidelines

Implement a status indicator to show the progress of document retrieval

Organize documents by categories for better user navigation

Provide document preview capabilities when possible

Implement document download functionality with proper progress indicators

Code Samples

cURL

Python

Node.js

Related APIs

MCA Document Request API: Initiates a new MCA document retrieval request

MCA Document Download API: Downloads specific MCA documents directly

MCA Document Search API: Searches for available MCA documents by company details

Compliance and Legal Considerations

The documents retrieved through this API are official government records and should be handled in accordance with data privacy regulations. Document URLs are time-limited for security purposes and should be refreshed if access is needed beyond the expiration time. Users should ensure they have proper authorization to access company documents and use the information in compliance with applicable laws and regulations.

{ "data": { "created_at": null, "entity_name": "TECH SOLUTIONS PRIVATE LIMITED", "credentials_provided": false, "status": "completed", "mca_srn": null, "error": null, "error_description": null, "mca_payment": true, "fetch_only": null, "fetch_order_registered": null, "fetched": null, "total_documents": null, "completed_documents": null, "documents": [ { "document_id": "edcefcd7-b26e-4bda-9374-0fbef0758a34", "document_name": "2017/04/20 CERTIFICATE OF INCORPORATION-20170420", "category": "Certificates", "type_of_document": null, "status": "completed", "document_url": "https://mca-test-bucket.s3.amazonaws.com/mca_documents/mca_ampKghRzCzyrLnamvfSn/Certificates/%5B20-04-2017%5D_CERTIFICATE_OF_INCORPORATION-20170420_0.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAWE3LGOMHK2UPET5N%2F20210927%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210927T070608Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=fcf754f5805106f15ca67fab2b131790ae3b203861b3c8ca9a38b499654de6ff" } ], "zip": { "status": null, "zip_url": null } }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Get Status

Get MCA Document Status#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Path Parameters#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses