Create a platform customer
Platform customers
Create Customer
Create a platform customer, the exporter entity you generate eBRCs for. Returns the platformCustomerId used in every later IRM and certificate generation call.
POST
Create a platform customer
Create a platform customer for each exporter you generate certificates for. This is the first call in the lifecycle: the returned
DGFT credentials are never returned by any customer endpoint.
id is the platformCustomerId you pass to every IRM and generation endpoint.
Request example
name, email, and type are required; type is always "customer". companyName and address are optional.
Response example
Returns201 with the customer in the data field of the standard envelope:
Errors
400withemail: email must be an emailwhen the email fails validation. See common validation errors.401/403for key problems. See authentication errors.
Next steps
- Validate the customer’s DGFT credentials to enable filings.
- Fetch their IRMs once services are enabled.
- Walk the whole flow in the Quick Start.
Authorizations
Body
application/json
Response
Customer created
Unique identifier of the platform customer
Available options:
customer Platform user ID that owns this customer