Skip to main content
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.
Services are enabled after 24 hours of successful validation. This endpoint is limited to 4 calls per minute.

Request example

Credentials are encrypted at rest, never logged, and never shown back by any endpoint.

Response example

Returns 201 with the sanitized customer in the data field:

Errors

  • 400 when the DGFT portal rejects the credentials.
  • 429 if 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

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The customer ID

Body

application/json
dgftUsername
string
required

DGFT portal username

dgftPassword
string<password>
required

DGFT portal password

Response

Credentials validated successfully

id
string

Unique identifier of the platform customer

name
string
email
string<email>
type
enum<string>
default:customer
Available options:
customer
companyName
string
address
string
platformId
string

Platform user ID that owns this customer

isActive
boolean
createdAt
string<date-time>
updatedAt
string<date-time>