Skip to main content
DELETE
Delete a platform customer
Delete a platform customer. Use this when an exporter offboards from your platform.
This is permanent and it cascades. Deleting a client also deletes, in a single transaction:
  • the stored DGFT connection for that client
  • every IRM record held for that client
  • every eBRC generation request submitted for that client
  • every certificate detail record enriched for that client
There is no undo and no soft delete. Certificates already issued by DGFT are unaffected on the DGFT portal, but your record of them here is gone. Export anything you need to keep first.
The operation returns 200 with a success flag, not 204.

Delete is not deactivate

The API has no deactivate. If you want to stop filing for an exporter while keeping their history, do not call this endpoint. Stop sending IRMs for that client, or deactivate them from the eBRC console, which has a status toggle for exactly this case and does not offer delete at all.

Request example

Response example

Errors

  • 401 No API key provided or Invalid API key. See authentication errors.
  • 404 Customer not found when no client with that id belongs to your account in the mode your key selects. A dev_ key cannot delete a live client, which is what stops a test integration from destroying live filing history.
  • 500 Error removing platform customer if the transaction fails. The whole cascade is one transaction, so a partial delete cannot happen.

Next steps

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The customer ID

Response

Deletion confirmation

success
boolean