v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB

KYB > Related Entities V2 (Recommended)

Add Related Person V2

Add a related person to a business profile using the V2 format

post/verify/related_person_v2

Request body

business_profile_idstring required

The business profile ID to which the related person will be added

ownership_percentnumber nullable

Percentage of ownership in the business

shares_allocatedinteger nullable

Number of shares allocated to this person

additional_fieldsobject

Additional custom fields for the relationship

Example request

{
  "user_profile": {
    "address": {
      "address_street_1": "222 Palm Street",
      "address_city": "Santa Monica",
      "address_state": "CA",
      "address_zip_code": "93251",
      "address_country": "US"
    },
    "date_of_birth": "1984-01-21",
    "email_address": "johnsmith@aiprise.com",
    "phone_number": "+13334445555",
    "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810",
    "user_profile_result": "APPROVED",
    "events_callback_url": "https://yourwebsite.com/aiprise-callback"
  }
}

Response

Successful operation

business_profile_idstring

person_reference_idstring