Validate DGFT credentials
Platform customers
Validate Customer
Validate and securely store an exporter’s DGFT portal credentials for a platform customer. Required before you fetch their IRMs or generate an eBRC for them.
POST
Validate DGFT credentials
Validate the customer’s DGFT portal credentials and store them for later filings. Run this once after creating the customer, and again whenever their DGFT password changes: re-submitting the same username with a new password updates the stored password. Submitting a different username is rejected.
Credentials are encrypted at rest, never logged, and never shown back by any endpoint.
Services are enabled after 24 hours of successful validation. This endpoint is limited to 4 calls per minute.
Request example
Response example
Returns201 with the sanitized customer in the data field:
Errors
400when the DGFT portal rejects the credentials.429if you exceed 4 calls per minute. See rate limits.- Filings and downloads made later with a stale password return
DGFT_CREDENTIALS_INVALID; recover by calling this endpoint again with the new password. See DGFT credential error codes.
Next steps
- Fetch the customer’s IRMs after services are enabled.
- Submit IRMs for generation.
- Download eBRC PDF shows credential recovery end to end.
Authorizations
Path Parameters
The customer ID
Body
application/json
Response
Credentials validated successfully
Unique identifier of the platform customer
Available options:
customer Platform user ID that owns this customer