Company profile
Read the company profile
Read the profile your Tenancy stated, and be told plainly when it has stated none.
GET
This call answers the Company profile a Tenancy stated: the latest statement, exactly as it was stated, with the moment it was recorded.
A Tenancy that has never stated a profile answers
404 and names that state. It is an answer rather than a fault, and it is what lets a screen render the onboarding form instead of a company with no name.
There is one profile per Tenancy and no history behind it. A correction replaces what the last statement said, and no call answers what it replaced.
Path parameters
string
required
The Tenancy whose profile is read. 1–64 characters of
a–z A–Z 0–9 - _. A key authenticates for one Tenancy and the path names it; another Tenancy’s path answers 403.Response
string
required
The company as its own registry of companies has it.
string
required
Where the company lends, as an ISO 3166-1 alpha-2 code, and one of the 50 the Platform names. It is not the jurisdiction of any Loan and gates no issuance.
string
The name the products go out under. Absent when the statement made none, rather than answered as an empty string.
string
The legal form the company is registered under. Absent the same way.
string
required
RFC 3339 in UTC: the moment the Platform recorded the statement it is answering.
Refusals
This route reads no query parameter and takes no body.
A profile that exists under another Tenancy and one that was never stated are the same
404, which is what keeps the two indistinguishable from outside. A read-scoped key is enough; only stating needs a write-scoped one.