Update business profile

PATCH/partner/v1/business-profiles/{customerId}

Auth Bearer tokenScope partner.write

Corrects a business profile, adds people, and confirms uploaded documents. Every field is optional. An omitted field is left unchanged.

Allowed until an analyst starts reviewing (InReview) or decides. After that the call returns Customer.AlreadySubmitted.

tip

When the status is ChangesRequested, this call is your response. It moves the customer to ChangesRequestCompleted and back into review.

Path

customerIduuidpathrequired

From Create business profile.

Body

companyNamestring

2 to 255 characters.

tradingNamestring

emailstring

Valid email, up to 255 characters.

phoneNumberstring

E.164, for example +2348012345678.

businessTypeCodestring

One of the business type codes.

incorporationCountryCodestring

ISO 3166-1 alpha-3.

industrystring

One of the industry codes.

descriptionstring

websitestring

Absolute https:// URL.

registrationNumberstring

Up to 50 characters.

registrationDatedate

YYYY-MM-DD.

addressesAddress[]

Replaces the existing list. Same shape as on create.

financialsobject

Replaces the existing object. Same shape as on create.

businessDocumentIdListuuid[]

Document ids from Request upload link for this customer, each at most once. An unknown id, or one from another customer, fails the whole call.

businessPersonListBusinessPerson[]

People to add. Existing people are never removed or replaced. Emails must be new to this customer, and total percentageShare across existing and new people must stay at or below 100. Same shape as on create, including the identity rules.

Field changes and document confirmation commit together. If anything fails, nothing changes.

Response

customerIduuid

partnerCustomerIdstring

businessDocumentsobject[]

The documents this call confirmed, each with documentId and documentType.

addedBusinessPersonsobject[]

The people this call added, in the same shape as ubos on create.

Errors

Besides the common errors:

Show endpoint errors

Code	HTTP	When
BusinessType.NotFound	400	Unknown businessTypeCode.
BusinessType.NotOffered	400	businessTypeCode is a retired code, e.g. Llc. Leave it out to keep the business's current type.
BusinessType.ChangeNotPossible	409	The business is on a retired code and this call moves it to a new one, but no onboarding setup is live for its country to move its document requirements to. Nothing was changed. Leave businessTypeCode out, or contact support.
Country.NotFound	400	Unknown incorporationCountryCode.
PhoneNumber.Invalid	400	phoneNumber is not E.164.
OwnershipDetails.PercentageShareExceeded	400	Existing and new people own more than 100%.
ValidationControl.Error	400	A field is invalid, including a repeated document id or identities not accepted for a new person's country.
Document.AccessDenied	403	A document id belongs to another customer.
Document.NotFound	404	A document id does not exist.
Customer.NoProfile	404	The customer has no business profile. Contact support.
Customer.AlreadySubmitted	409	An analyst is reviewing or has decided.
OwnershipDetails.DuplicateEmail	409	A new person's email is already on this customer.

Request

curl -X PATCH \
  https://gateway.sandbox.rynopay.io/api/partner/v1/business-profiles/b3f1c2d4-... \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "website": "https://acme.global",
    "businessDocumentIdList": ["d4e5f6a7-..."]
  }'

Response

200

{
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN...",
  "value": {
    "customerId": "b3f1c2d4-...",
    "partnerCustomerId": "cust-001",
    "businessDocuments": [
      { "documentId": "d4e5f6a7-...", "documentType": "BusinessDocument" }
    ],
    "addedBusinessPersons": []
  }
}

409

{
  "value": null,
  "isSuccess": false,
  "isFailure": true,
  "error": {
    "code": "Customer.AlreadySubmitted",
    "name": "Onboarding has already been submitted for verification"
  },
  "title": "Conflict",
  "traceId": "0HN..."
}