Skip to main content
GET
Get one client firm + connection state
One registered firm, current state. Requires the firms scope. Tenant-isolated: a firm on another desk is a 404, existence is never leaked.

Request example

Response example

verification_pending means the one-time code is outstanding; complete it via authorize. The full vocabulary is on Register a firm.

Errors

  • 404 not_found, no such firm on your desk.
Terms used here: IEC, connection state, API key, scope. Full list in the terminology annexure.

Next steps

Authorizations

X-ScripX-Key
string
header
required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Path Parameters

iec
string
required

Response

OK

firm
object