Update the editable part of the profile

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.

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.

Authorization

OAuth2PasswordBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The editable half of the profile.

legal_name and registration_number are deliberately absent. Once a business is verified those are locked, and changing one is a request that forces re-verification — POST /kyb/field-change-requests (E3-6), not a profile edit. Accepting them here and refusing them at runtime would make the contract say one thing and the server another.

Every field is optional; only what is sent is changed. A client that sends the whole form back must not blank a field it never displayed.

trading_name?|

What the business trades as, where that differs from its legal name. Shown to payers; legal_name is not.

Example"Meridian"

contact_email?|

Where we write about the account itself — verification, limits, incidents. Not where webhooks go and not shown to payers.

Example"ops@meridianlabs.co"

contact_phone?|

International form. Used for account contact only.

Example"+250 788 000 000"

website?|

Shown on payment pages and checked during verification, so it should resolve.

Example"https://meridianlabs.co"

address?|

Trading address, one line. Appears on invoices.

Example"KG 7 Ave, Kigali, Rwanda"

display_currency?|

ISO 4217. What totals are shown in across the dashboard when no currency is asked for. Presentation only — it converts nothing and changes no balance.

Example"RWF"

support_email?|

Where the business's own customers reach it for support. Distinct from contact_email, which is where we write about the account.

Example"help@meridianlabs.co"

registration_issued_on?|

YYYY-MM-DD. The date the business was registered, as on its certificate of incorporation.

Example"2019-04-01"

address_street?|

Registered address: street and number.

Example"KG 7 Ave"

address_city?|

Registered address: city.

Example"Kigali"

address_region?|

Registered address: state, province or region, where it has one.

Example"Kigali City"

address_postal_code?|

Registered address: postal code, where the country uses one.

Example"00100"

address_country?|

Registered address: ISO 3166-1 alpha-2 country.

Example"RW"

activity_description?|

What the business does, in its own words.

Example"We import and roast coffee for East Africa."

needs_licence?|

Whether the business says it needs a licence to operate.

Examplefalse

sends_disbursements?|

Whether the business says it needs to send disbursements.

Exampletrue

wants_collections?|

Whether the business wants to collect payments from customers.

Exampletrue

wants_disbursements?|

Whether the business wants to pay out to staff, vendors or customers.

Exampletrue

Response Body

`application/json`

curl -X PATCH "https://example.com/api/b/v1/business" \  -H "Content-Type: application/json" \  -d '{}'

{  "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"}

Authorization

Cookie Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`