Skip to main content
POST
/
platform-customers
/
{id}
/
check-dgft-credentials
cURL
curl --request POST \
  --url https://ebrcapi.dev.eximfiles.com/api/v1/platform-customers/{id}/check-dgft-credentials \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "dgftUsername": "<string>",
  "dgftPassword": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "type": "customer",
  "companyName": "<string>",
  "address": "<string>",
  "platformId": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://ebrcapi.docs.eximfiles.io/llms.txt

Use this file to discover all available pages before exploring further.

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>