This business's profile
Read-only for anybody who can see the business. Reading the profile is not managing it: a Viewer needs to know which business they are looking at and how to contact it, and gating that behind the settings permission would leave them staring at a blank page.
Read-only for anybody who can see the business.
Reading the profile is not managing it: a Viewer needs to know which business they are looking at and how to contact it, and gating that behind the settings permission would leave them staring at a blank page.
Authorization
OAuth2PasswordBearer In: header
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/api/b/v1/business"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "legal_name": "string", "trading_name": "string", "legal_structure": "sole_proprietorship", "registration_number": "string", "country": "string", "industry": "agriculture", "contact_email": "string", "contact_phone": "string", "website": "string", "address": "string", "display_currency": "string", "support_email": "string", "registration_issued_on": "2019-08-24", "address_street": "string", "address_city": "string", "address_region": "string", "address_postal_code": "string", "address_country": "string", "activity_description": "string", "needs_licence": true, "sends_disbursements": true, "wants_collections": true, "wants_disbursements": true, "kyb_status": "unverified", "kyb_tier": "tier_0", "status": "active", "locked_fields": [ "string" ], "created_at": "2019-08-24T14:15:22Z"}What the current token is scoped to GET
The business this session acts for, with the role the server read now. Useful to a dashboard on load, and the smallest endpoint that demonstrates scoping: it names a business without the caller having named one.
Update the editable part of the profile PATCH
Change what is not locked. Only fields actually present in the request are written, so a client sending back a partially rendered form cannot blank what it never showed. `legal_name` and `registration_number` are not accepted at all — they are locked after verification and changing one is E3-6's re-verification request, not a profile edit. Audit-logged with before and after, because a change of contact email is how an account is taken over quietly.