> ## 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.

# Get Customer by Id

> Fetch a single platform customer by its id to read the stored exporter entity details before you fetch IRMs or submit an eBRC generation request for them.

Fetch one platform customer by its `id`. Use this to check a customer's current details or `isActive` state before filing for them.

### Request example

```bash theme={"dark"}
curl --location 'https://ebrcapi.eximfiles.io/api/v1/platform-customers/ee849a90-7a28-49b4-8cb2-8e31041650a2' \
  --header 'x-api-key: <YOUR_API_KEY>'
```

### Response example

```json theme={"dark"}
{
  "success": true,
  "data": {
    "id": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
    "name": "Rohan Mehta",
    "email": "finance@suryatextiles.example.com",
    "type": "customer",
    "companyName": "Surya Textile Exports Pvt Ltd",
    "address": "Tiruppur, Tamil Nadu",
    "platformId": "1f0c9a52-3b41-4d78-9e26-7a8b5c4d3e2f",
    "isActive": true,
    "createdAt": "2026-07-22T10:15:04.874Z",
    "updatedAt": "2026-07-22T10:21:33.120Z"
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T10:25:00.000Z"
}
```

### Errors

* `404` when no customer with that id belongs to your account.

### Next steps

* [Update this customer](/api-reference/customer/update).
* [Validate their DGFT credentials](/api-reference/customer/validate).
* [List all customers](/api-reference/customer/get).


## OpenAPI

````yaml GET /platform-customers/{id}
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:
  /platform-customers/{id}:
    get:
      summary: Get a platform customer
      description: Return a single platform customer by id.
      operationId: getPlatformCustomer
      parameters:
        - name: id
          in: path
          required: true
          description: The customer ID
          schema:
            type: string
      responses:
        '200':
          description: Customer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the platform customer
        name:
          type: string
        email:
          type: string
          format: email
        type:
          type: string
          enum:
            - customer
          default: customer
        companyName:
          type: string
        address:
          type: string
        platformId:
          type: string
          description: Platform user ID that owns this customer
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````