Quick Start

This guide walks the full lifecycle once: create an exporter, connect their DGFT account, pull their remittances, submit them for generation, and track the request.

Before you begin

An API key, issued per environment. Create your account in the eBRC API console to request one; for help, email amin@eximfiles.io.
The exporter’s DGFT portal credentials.

The API is free for general use, so you can complete this whole guide without any billing setup. See Pricing.

Set BASE_URL to your environment’s base URL, for example https://ebrcapi.eximfiles.io/api/v1 for production. See Environments and Base URLs.

Services are enabled after 24 hours of customer validation.

Steps to generate an eBRC

Create a platform customer

Create the exporter entity you will generate for. See Create Customer.

curl --location "$BASE_URL/platform-customers/" \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --data-raw '{
    "name": "Rohan Mehta",
    "email": "finance@suryatextiles.example.com",
    "type": "customer",
    "companyName": "Surya Textile Exports Pvt Ltd",
    "address": "Tiruppur, Tamil Nadu"
  }'

The response’s data.id is the platformCustomerId used in every later call.

Validate DGFT credentials

Connect the exporter’s DGFT account. See Validate Customer. This endpoint is limited to 4 calls per minute.

curl --location "$BASE_URL/platform-customers/ee849a90-7a28-49b4-8cb2-8e31041650a2/check-dgft-credentials" \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "dgftUsername": "<DGFT_USERNAME>",
    "dgftPassword": "<DGFT_PORTAL_PASSWORD>"
  }'

Fetch IRMs

Pull the exporter’s inward remittances. See Fetch IRM List.

curl --location --request POST "$BASE_URL/irm/refresh?platformCustomerId=ee849a90-7a28-49b4-8cb2-8e31041650a2" \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data ''

Submit IRMs for generation

Map each IRM to its invoice and submit. See Submit IRMs for eBRC Generation and the field reference. Dates are DDMMYYYY strings; the message-level uploadType is a string code and the item-level one is a number: 101 Direct Export, 102 Softex, 103 Service Non IT, 104 Deemed.

curl --location "$BASE_URL/genebrc/push-irm" \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "platformCustomerId": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
    "recordResCount": 1,
    "uploadType": "101",
    "decalarationFlag": "Y",
    "ebrcBulkGenDtos": [
      {
        "serialNo": 1,
        "uploadType": 101,
        "branchSlNo": 0,
        "irmIfscCode": "HDFC0000123",
        "irmAdCode": "6390005",
        "irmNumber": "IRM0000012345",
        "irmDt": "01042024",
        "irmFCC": "USD",
        "irmPurposeCode": "P0101",
        "irmRemitAmtFCC": 25000,
        "sbCumInvoiceNumber": "SB7654321",
        "sbCumInvoiceDate": "15032024",
        "portCode": "INMAA1",
        "billNo": "EXP-2024-0042",
        "sbCumInvoiceFCC": "USD",
        "sbCumInvoiceValueinFCC": 25000,
        "mappedIRMAmountFCC": 25000,
        "isVostro": "N",
        "isGstAvail": "N",
        "gstinInvoiceNumber": null,
        "gstinInvoiceDate": null
      }
    ]
  }'

Keep the returned requestId. If validation fails, the exact messages are listed under common validation errors.

Check request status

Poll with your request ID. See Get Request Status.

Available in Production and Sandbox. In Production, a generation request is typically acknowledged within about 2 hours.

curl --location --request POST "$BASE_URL/genebrc/status" \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "platformCustomerId": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
    "requestId": "IEC1234560120240001ABCDE12345"
  }'

Once processed, fetch details or download the certificate PDF.

Prefer Excel?

Skip the JSON payload: download the pre-filled template, fill it, and upload it back. Validation errors come back per row.

Need help?

Contact support

Email amin@eximfiles.io and quote the requestId from your API response.

Get started

Essentials

Resources

Before you begin

Steps to generate an eBRC

Prefer Excel?

Need help?

Contact support

​Before you begin

​Steps to generate an eBRC

​Prefer Excel?

​Need help?

Contact support

Before you begin

Steps to generate an eBRC

Prefer Excel?

Need help?