v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB

KYB > Related Entities V2 (Recommended)

Update Related Company V2

Update a related company's information using the V2 format

put/verify/related_company_v2

Request body

business_profile_idstring required

The business profile ID

company_reference_idstring required

The company reference ID to update

ownership_percentnumber nullable

Percentage of ownership in the business

shares_allocatedinteger nullable

Number of shares allocated to this company

additional_fieldsobject

Additional custom fields for the relationship

relationship_type'PARENT' | 'CHILD' | 'SIBLING' | 'UNKNOWN' nullable

Example request

{
  "business_profile": {
    "name": "AiPrise",
    "alternate_name": "AiPrise Inc",
    "website": "www.aiprise.com",
    "formation_date": "1999-03-21",
    "country_code": "US",
    "addresses": [
      {
        "address_street_1": "222 Palm Street",
        "address_city": "Santa Monica",
        "address_state": "CA",
        "address_zip_code": "93251",
        "address_country": "US"
      }
    ],
    "phone_numbers": [
      "+13334445555"
    ],
    "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810",
    "callback_url": "https://yourwebsite.com/aiprise-callback",
    "events_callback_url": "https://yourwebsite.com/aiprise-callback"
  }
}

Response

Successful operation

business_profile_idstring

company_reference_idstring