> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ebrc.in/llms.txt
> Use this file to discover all available pages before exploring further.

# List Generation Requests

> List eBRC generation requests for a platform customer with filters and pagination, so you can track each submission and its processing status over time.

List a platform customer's eBRC generation requests. Use this to find older request IDs, audit past submissions, or drive a status dashboard on your side.

### Request example

```bash theme={"dark"}
curl --location 'https://ebrcapi.eximfiles.io/api/v1/genebrc?platformCustomerId=ee849a90-7a28-49b4-8cb2-8e31041650a2&status=Processed&page=1&limit=10' \
  --header 'x-api-key: <YOUR_API_KEY>'
```

Filters: `requestId`, `status`, `fromDate` / `toDate` (ISO dates), plus `page` / `limit` for pagination.

### `status` values

| Value       | Meaning                                                       |
| ----------- | ------------------------------------------------------------- |
| `Pending`   | Request saved; submission in progress or not yet acknowledged |
| `Validated` | Push accepted successfully                                    |
| `Failed`    | Push acknowledgement failed                                   |
| `Processed` | Processing completed successfully                             |
| `Errored`   | Processing failed                                             |
| `Error`     | Local/system failure                                          |

### Next steps

* [Get Request Status](/api-reference/genebrc/status) for a live DGFT status check.
* [Fetch eBRC details](/api-reference/genebrc/fetch-details) for processed requests.
* [Submit new IRMs](/api-reference/genebrc/push-irm).


## OpenAPI

````yaml GET /genebrc
openapi: 3.1.0
info:
  title: eBRC API
  description: >-
    REST API for generating and managing electronic Bank Realization
    Certificates (eBRC) through DGFT's GenEBRC module. Onboard exporters,
    validate their DGFT credentials, pull inward remittance (IRM) data, submit
    certificate generation requests singly or in bulk, and track them to
    completion. All JSON responses are wrapped in the standard envelope {
    success, data, statusCode, timestamp }; the schemas on each endpoint
    describe the data field.
  contact:
    name: Eximfiles support
    email: amin@eximfiles.io
  version: 1.0.0
servers:
  - url: https://ebrcapi.eximfiles.io/api/v1
    description: Production
  - url: https://ebrcapi.dev.eximfiles.com/api/v1
    description: Sandbox
security:
  - x-api-key: []
paths:
  /genebrc:
    get:
      summary: List generation requests
      description: >-
        List eBRC generation requests for a platform customer, filterable by
        requestId, status and date range.
      operationId: listEbrcRequests
      parameters:
        - name: platformCustomerId
          in: query
          required: true
          schema:
            type: string
        - name: requestId
          in: query
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by request status
          schema:
            type: string
            enum:
              - Pending
              - Validated
              - Failed
              - Processed
              - Errored
              - Error
        - name: fromDate
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 10
      responses:
        '200':
          description: List of GenEBRC requests
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Genebrc'
components:
  schemas:
    Genebrc:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier (UUID)
        userId:
          type: string
          nullable: true
        platformCustomerId:
          type: string
          nullable: true
        requestId:
          type: string
        iecNumber:
          type: string
        recordResCount:
          type: number
        uploadType:
          type: string
        decalarationFlag:
          type: string
          nullable: true
        ebrcBulkGenDtos:
          type: array
          items:
            $ref: '#/components/schemas/EbrcBulkGen'
        ebrcBulkGenStatusList:
          type: array
          items:
            type: object
          nullable: true
        dgftAckId:
          type: string
          nullable: true
        status:
          type: string
          description: Request lifecycle status
          enum:
            - Pending
            - Validated
            - Failed
            - Processed
            - Errored
            - Error
        errorDetails:
          type: object
          nullable: true
        processedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    EbrcBulkGen:
      type: object
      properties:
        serialNo:
          type: number
        uploadType:
          type: number
          description: >-
            eBRC type code: 101 Direct Export, 102 Softex, 103 Service Non IT,
            104 Deemed.
        branchSlNo:
          type: number
        irmIfscCode:
          type: string
        irmAdCode:
          type: string
        irmNumber:
          type: string
        irmDt:
          type: string
          description: IRM date in DDMMYYYY format, e.g. 01042024.
        irmFCC:
          type: string
          description: >-
            IRM foreign currency code (ISO 4217). See the [Currency Codes
            annexure](/annexure/currency-codes).
        irmPurposeCode:
          type: string
          description: >-
            RBI purpose code for the inward remittance. See the [Purpose Codes
            annexure](/annexure/purpose-codes).
        irmRemitAmtFCC:
          type: number
        sbCumInvoiceNumber:
          type: string
        sbCumInvoiceDate:
          type: string
          description: Shipping bill / SOFTEX / invoice date in DDMMYYYY format.
        portCode:
          type: string
          description: >-
            Port of export as per DGFT master data. See the [Port Codes
            annexure](/annexure/port-codes).
        billNo:
          type: string
        sbCumInvoiceFCC:
          type: string
          description: >-
            Invoice currency code (ISO 4217). See the [Currency Codes
            annexure](/annexure/currency-codes).
        sbCumInvoiceValueinFCC:
          type: number
        mappedIRMAmountFCC:
          type: number
        isVostro:
          type: string
        vostroType:
          type: string
          nullable: true
        mappedORMAmountFCC:
          type: number
          nullable: true
        isThirdPartyExport:
          type: string
          nullable: true
        commissionValDeduct:
          type: number
          nullable: true
        commissionValInfo:
          type: number
          nullable: true
        discountValDeduct:
          type: number
          nullable: true
        discountValInfo:
          type: number
          nullable: true
        insuranceValDeduct:
          type: number
          nullable: true
        insuranceValInfo:
          type: number
          nullable: true
        otherDeductionDeduct:
          type: number
          nullable: true
        otherdeductionsInfo:
          type: number
          nullable: true
          description: >-
            Other deduction for information, in invoice FCC (spelling as per
            DGFT specification).
        freightValDeduct:
          type: number
          nullable: true
        freightValInfo:
          type: number
          nullable: true
        sacCode1:
          type: string
        sacCode2:
          type: string
          nullable: true
        serviceTypeModesValue:
          type: number
          nullable: true
        isGstAvail:
          type: string
        gstinInvoiceNumber:
          type: string
        gstinInvoiceDate:
          type: string
          description: >-
            GST invoice date in DDMMYYYY format. Mandatory when isGstAvail is Y;
            must be null when N.
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````