Skip to main content
GET
Get a platform customer
Fetch one platform customer by its id. Use this to check a client’s details, its IEC, or whether it is ready to file, before you push IRMs for it.

Request example

Response example

See the client object for what each field means. mode is not returned by this endpoint; a client is only reachable in the mode your key selects, so the mode is implied by the key you used. Fields the client has no value for are null.

Is this client ready to file?

Errors

  • 400 Invalid platform customer ID format: <id>. Expected a UUID format... when the id is not a UUID. Platform customer ids are UUIDs; a Clerk user id starting with user_ is not one.
  • 401 No API key provided or Invalid API key. See authentication errors.
  • 404 Platform customer with id <id> not found when no client with that id belongs to your account in the mode your key selects. A dev_ key cannot read a live client and gets this same 404.

Next steps

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The customer ID

Response

Customer response

id
string

Unique identifier of the platform customer. This is the platformCustomerId used in every later call.

name
string
email
string<email>
type
enum<string>
default:customer
Available options:
customer
companyName
string | null

The exporter's registered legal name. Required by the eBRC console, optional on this API.

iec
string | null

Importer Exporter Code: exactly 10 alphanumeric characters, stored uppercase. Required by the eBRC console, optional on this API.

Required string length: 10
Pattern: ^[A-Za-z0-9]{10}$
address
string | null

Free text. Not collected by the eBRC console, so console-onboarded clients have none.

platformId
string

Platform account that owns this client

mode
enum<string>

Fixed at creation from the API key prefix and never editable. Returned by create, update and validate; omitted by the list and get endpoints.

Available options:
test,
live
isActive
boolean

Always false at creation. Becomes true only when DGFT credentials are verified by POST /platform-customers/{id}/check-dgft-credentials.

hasDgftCredentials
boolean

Derived: true once DGFT credentials are on file. Branch on this; the raw DGFT credential fields are not part of the response contract and the password is never returned on any surface.

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

Not returned by GET /platform-customers (list).