# Create Ingestion Activity

### Request Method

POST

### Request URL

```
{{BASE_URL}}/ingestion/elt/createActivity
```

### Request Headers

| Parameter             | Data Type | Field Validations | Description                                                      |
| --------------------- | --------- | ----------------- | ---------------------------------------------------------------- |
| x-cleartax-auth-token | String    | NA                | Mandatory. Access token linked to the workspace and environment. |
| Content-Type          | String    | NA                | Mandatory. application/json                                      |

### Request Path Params

There are no path parameters for this API.

### Request Query Params

There are no query parameters for this API.

### Request Body

| Parameter    | Data Type | Field Validations | Description                            |
| ------------ | --------- | ----------------- | -------------------------------------- |
| fileInfo     | Object    | -                 | Mandatory. One or more template nodes. |
| metadata     | Object    | NA                | Optional. Leave this empty {}.         |
| activityFlow | String    | NA                | Mandatory. This should be “FULL”.      |

#### **Template Node Object**

<table><thead><tr><th>Parameter</th><th width="85.33331298828125">Data Type</th><th width="166.666748046875">Field Validations</th><th>Description</th></tr></thead><tbody><tr><td>{{template_name}}</td><td>Array</td><td>Enum:<br>Based on solution clarification discussion.<br><code>GST_SR, GST_PR,</code><br><code>TDS_PAYABLE,</code><br><code>GL</code> <br><br><br></td><td>Mandatory. Array of one or more file nodes belonging to the same template.</td></tr></tbody></table>

#### **File Node Object**

| Parameter    | Data Type | Field Validations | Description                                                                   |
| ------------ | --------- | ----------------- | ----------------------------------------------------------------------------- |
| s3FileUrl    | String    | NA                | Mandatory. Pre-signed URL where the file is uploaded (without the signature). |
| userFileName | String    | NA                | Mandatory. Name of the file uploaded. This will be visible to the end user.   |

### Response Status Codes

| HTTP Status Code | Description  |
| ---------------- | ------------ |
| 200              | OK           |
| 400              | Bad request  |
| 401              | Unauthorised |
| 403              | Forbidden    |

### Response Schema

| Parameter  | Data Type | Field Validations | Description                                                   |
| ---------- | --------- | ----------------- | ------------------------------------------------------------- |
| activityId | String    | NA                | Ingestion activity ID that can be used to check status later. |
| state      | String    | NA                | Initial state will be “EXECUTION\_STARTED”                    |

### Sample Request and Response

#### Sample Request

```
curl --location 'https://api-sandbox.clear.in/ingestion/elt/createActivity' \
--header 'x-cleartax-auth-token: ' \
--header 'Content-Type: application/json' \
--data '{
    "fileInfo": {
        "{{template_name}}": [
            {
                "s3FileUrl": "https://storage.clear.in/v1/ap-south-1/ingestionv2-prod/63459ca9-30b0-4482-acd6-6096a0d18c0e/ADVANCE_INGESTION/2025/APRIL/a068b77a-9cde-4f60-aafd-975be2cb7a57/OriginalFileName/a068b77a-9cde-4f60-aafd-975be2cb7a57__1744112398856.Success?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmFwLXNvdXRoLTEiSDBGAiEA7kqlmLIqXxs67bQCS6IxtDfY56mkKjVzDXiD%2BKL3QswCIQCNIONX9SUN7t%2BbcbFqjMMtAFb8rumIogKvQuN1TtcDwSr%2FBAh1EAYaDDIxOTM0MTkwNzk4MyIMKtW1w93aR7eCh%2BKXKtwEMfKRuBb9ZhrS9Mb6GiYSwreYRG%2FVTDGaPPaKehKJKqqeZD0x6xi16sGkT6MEP9Fk29rmWBhfk4EWil8kEMNNME9imUzMB63RYlEjr6LONduR07DwzZZz8qNWCM8VdvEzOpk36CXnWWjdj8iHtYke%2FmKBJ%2FZ0EHPOIzasR9EAfaDb6gkWgW9TLp%2FaGRdX7zB53lu6XbHDvSoVR4%2BjlwqXfqxZvcpjbi40HJj89H8T7wEF9TAOUkYbzrCbmvW0XT7TJvuT7W%2FM1Q%2BMkaFNorUzHbv%2FmFdx1gHYkPW7fp4udBe0ZkOV3HPUKuiiOQji8UrvvYfmmGUmjBHGiq8EinEvsTfFYpmoTbndgE4EIssWrwk%2BrSlM0SHVXt01ovj9Jvtgm1sEy1VjR%2ByO%2Fls603xZkRIndg1%2F%2FaqtJoccowD2tB%2FOYXyHQWbKBLUKkYnSV4iLUqvleMOCyz0lT3hdPYpDFMwow%2Fbjemrn7POklWSyV%2BWPTN1rolIcmH7aPEoAjhcuCoXRzSSMIZAgaPiNfTeP1GJ9THqf1hO9dEOePfm%2BYUTc3c%2Fabx810gl4zehUIgEr5WzxZzSBm5MztNZMLYPOiAdpLZ66v2g4JSrr1sUcXjfp0yfN%2Bd2ywxV%2FzPfUvqo0jfDnHticeHn%2FY4I2hCL7cf%2FPQoYhBUvwdjCNbzpuMDclc4CZvLCCyfLClnfkGTFYObcTEH0pLKcdTs2m50%2B7btt74mgJlP3p2YpXkXaJ3pdIoPx%2F6Kc%2FPfDiryktZ48UJrkvVuj5vLhyQzedWLObGAvlzNQxkue0qcPQkTCPltS%2FBjqZASiqswNWsdSLlGj%2F0Z9lFobK%2BMcKYIkC5lBDWm3txa0YBxuLAs%2BANtcl2cRPTB802R%2BRwkhffgBxWFx9av6KruSs8%2B7HnL%2FGJanX8TqWfmwmwPSIHVmSOWADTY3vh1cCjZHTYKkKEyOZlFtEiL7GDIqb%2FI9dYgZv1%2Fwt8L9zf92g1vh9dbVOpRj6Z%2FiwOVB2OgFHXvfp8oW%2B8A%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250408T113959Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=35999&X-Amz-Credential=ASIATGEOL5AHYVL4STOE%2F20250408%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=8b19f7852ff37f8b72af5ea4d8463051d67a024d72718f2e1e2a9c830d813ee7",
                "userFileName": "report.xlsx"
            }
        ]
    },
    "metadata": {},
    "activityFlow": "FULL"
}'
```

#### Sample Response

```json
{
    "activityId": "d244866c-998c-4646-8942-a650d7ab600c",
    "state": "EXECUTION_STARTED"
}
```

### API Validations <a href="#api-validations" id="api-validations"></a>

Currently there are no known validations.

### API Constraints

If more than one file is uploaded, then all of them will be processed as one batch. If there is any error, all of them might fail.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cleartax.in/cleartax-docs/gls-api/gls-api-reference/advanced-ingestion-api-reference-deprecated/create-ingestion-activity.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.