Skip to main content
Welcome to the eBRC API documentation. This API offers a complete set of endpoints to help you handle eBRCs and related financial tasks.

​
Overview

Customer Management

Complete customer management

IRM Fetch

Easily integrate to fetch IRMs.

eBRC Generation

Procedure to generate eBRCs

​
Features

Secure Authentication

API Key authentication

Rate Limiting

Limited to 60 requests per minute per IP to prevent abuse.

​
Base URL

https://ebrcapi.dev.eximfiles.com/api/v1

​
Authentication

All protected endpoints require an API key, which you can obtain from the Eximfiles team.

​
Complete Header Example

x-api-key: your_api_key_here
Content-Type: application/json

​
Request Format

All requests should be made with JSON content type.
Content-Type: application/json

​
Response Format

All API responses follow this standard format for consistency.
{
  "status": boolean,
  "data": any,
  "message": string,
  "error": string | null
}

​
HTTP Status Codes

CodeTypeDescription
200OKRequest successful
201CreatedResource created successfully
400Bad RequestInvalid request parameters
401UnauthorizedAuthentication failed or invalid API key
403ForbiddenInsufficient permissions
404Not FoundResource not found
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error
422Issue related to DGFT configResource unavailable

​
Error Handling

Error responses include detailed information about what went wrong to help with debugging.

​
Validation Error Example

{
  "status": false,
  "message": "Validation failed",
  "error": "VALIDATION_ERROR"
}

​
Common Error Types

{
  "status": false,
  "message": "Invalid or missing API key",
  "error": "INVALID_API_KEY"
}

​
Security

HTTPS Required

All API requests must use HTTPS for secure communication

API Key Security

Keep API keys secure and never expose them in client-side code

​
Support

Contact Support

For help with the API, email us at [email protected]