Bulk Upload via Excel

Bulk upload via Excel

curl --request POST \
  --url https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file='@example-file'

import requests

url = "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"x-api-key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "dgftAckId": "ACK202401150001",
  "requestId": "IEC1234560120240001ABCDE12345",
  "ackStatus": "Validated",
  "recordResCount": 2,
  "errorDetails": [],
  "parsedRowCount": 2,
  "irmNumbers": [
    "IRM0000012345",
    "IRM0000012346"
  ],
  "irms": [
    {
      "serialNo": 1,
      "irmNumber": "IRM0000012345",
      "irmDt": "2024-01-10",
      "irmAdCode": "6390005",
      "irmIfscCode": "HDFC0000123",
      "sbCumInvoiceNumber": "INV-2024-001"
    },
    {
      "serialNo": 2,
      "irmNumber": "IRM0000012346",
      "irmDt": "2024-01-11",
      "irmAdCode": "6390005",
      "irmIfscCode": "HDFC0000123",
      "sbCumInvoiceNumber": "INV-2024-002"
    }
  ]
}

{
  "statusCode": 400,
  "message": "Excel validation failed",
  "errors": [
    {
      "row": 2,
      "field": "irmNumber",
      "message": "Required field \"irmNumber\" is missing"
    },
    {
      "row": 4,
      "field": "isGstAvail",
      "message": "Must be Y or N"
    }
  ]
}

POST

genebrc

bulk-upload

Bulk upload via Excel

curl --request POST \
  --url https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file='@example-file'

import requests

url = "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"x-api-key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "dgftAckId": "ACK202401150001",
  "requestId": "IEC1234560120240001ABCDE12345",
  "ackStatus": "Validated",
  "recordResCount": 2,
  "errorDetails": [],
  "parsedRowCount": 2,
  "irmNumbers": [
    "IRM0000012345",
    "IRM0000012346"
  ],
  "irms": [
    {
      "serialNo": 1,
      "irmNumber": "IRM0000012345",
      "irmDt": "2024-01-10",
      "irmAdCode": "6390005",
      "irmIfscCode": "HDFC0000123",
      "sbCumInvoiceNumber": "INV-2024-001"
    },
    {
      "serialNo": 2,
      "irmNumber": "IRM0000012346",
      "irmDt": "2024-01-11",
      "irmAdCode": "6390005",
      "irmIfscCode": "HDFC0000123",
      "sbCumInvoiceNumber": "INV-2024-002"
    }
  ]
}

{
  "statusCode": 400,
  "message": "Excel validation failed",
  "errors": [
    {
      "row": 2,
      "field": "irmNumber",
      "message": "Required field \"irmNumber\" is missing"
    },
    {
      "row": 4,
      "field": "isGstAvail",
      "message": "Must be Y or N"
    }
  ]
}

Upload an Excel file (.xlsx or .xls, max 5 MB) to generate eBRCs in bulk. Column headers are matched to the required fields by name and the rows are submitted to DGFT in a single request. Validation errors come back per row, so you know exactly which line to fix. Limited to 5 calls per minute. Download the starting file from Download Bulk Upload Template, or pre-filled with real IRM data. Extracting rows from shipping bill PDFs first? See Shipping Bill extraction.

Request example

curl -X POST "https://ebrcapi.eximfiles.io/api/v1/genebrc/bulk-upload?uploadType=1&decalarationFlag=Y&platformCustomerId=ee849a90-7a28-49b4-8cb2-8e31041650a2" \
  -H "x-api-key: <YOUR_API_KEY>" \
  -F "file=@/path/to/ebrc-data.xlsx"

Query parameters:

Parameter	Required	Values
`platformCustomerId`	Yes	Platform customer UUID
`uploadType`	Yes	`1`, `2`, `3`, or `4`
`decalarationFlag`	Yes	`Y` or `N` (spelling as per DGFT specification)

Response

Alongside the DGFT acknowledgement, the response echoes back every IRM that was parsed and submitted:

parsedRowCount: how many rows were read from the file
irmNumbers: flat list of the submitted IRM numbers, in file order
irms: the same rows with serialNo, irmDt, irmAdCode, irmIfscCode, and sbCumInvoiceNumber

Use irms rather than irmNumbers when reconciling, since an IRM number is not unique on its own: the same number can recur under a different AD code or date.

{
  "success": true,
  "data": {
    "dgftAckId": "ACK202404010001",
    "requestId": "IEC1234560120240001ABCDE12345",
    "ackStatus": "Validated",
    "recordResCount": 2,
    "errorDetails": [],
    "parsedRowCount": 2,
    "irmNumbers": ["IRM0000012345", "IRM0000012346"],
    "irms": [
      {
        "serialNo": 1,
        "irmNumber": "IRM0000012345",
        "irmDt": "2024-01-10",
        "irmAdCode": "6390005",
        "irmIfscCode": "HDFC0000123",
        "sbCumInvoiceNumber": "INV-2024-001"
      },
      {
        "serialNo": 2,
        "irmNumber": "IRM0000012346",
        "irmDt": "2024-01-11",
        "irmAdCode": "6390005",
        "irmIfscCode": "HDFC0000123",
        "sbCumInvoiceNumber": "INV-2024-002"
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T13:00:00.000Z"
}

Row-level validation errors

If the file fails validation, the API returns 400 with one entry per failing cell:

{
  "statusCode": 400,
  "message": "Excel validation failed",
  "errors": [
    { "row": 2, "field": "irmNumber", "message": "Required field \"irmNumber\" is missing" },
    { "row": 4, "field": "isGstAvail", "message": "Must be Y or N" }
  ]
}

Valid codes

Purpose Codes, Currency Codes, and Port Codes for the code columns.
Field formats: Push IRM Request Fields annexure.

Next steps

Get Request Status with the returned requestId.
List generation requests across your history.
Download certificates once processed.

Authorizations

x-api-key

string

header

required

Query Parameters

platformCustomerId

string

required

Platform customer UUID

uploadType

enum<string>

required

DGFT upload type

Available options:

1,

2,

3,

4

decalarationFlag

enum<string>

required

Declaration flag

Available options:

Y,

N

Body

multipart/form-data

file

required

Excel file (.xlsx or .xls), max 5 MB

Response

DGFT acknowledgement with parsed row count

dgftAckId

string

requestId

string

ackStatus

enum<string>

Available options:

Validated,

Failed

recordResCount

number

errorDetails

object[]

parsedRowCount

number

Number of rows successfully parsed from the Excel file

irmNumbers

string[]

Flat list of the IRM numbers submitted, in file order

irms

object[]

The parsed rows echoed back, one entry per submitted IRM. Use these to reconcile the submission; an IRM number alone is not unique across AD codes and dates.

Show child attributes

Download Bulk Upload Template Data Extraction APIs

⌘I

​Request example

​Response

​Row-level validation errors

​Valid codes

​Next steps

Authorizations

Query Parameters

Body

Response

Request example

Response

Row-level validation errors

Valid codes

Next steps