Default callback url used when creating business profiles
Default callback url used when creating user profiles
Optionaladditional_information?: {Optionaladdresses?: {Optionalalternate_name?: stringOptionalbusiness_entity_id?: stringOptionalcallback_url?: stringOptionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionalcountry_code?: stringOptionalemail_addresses?: string[]Optionalevents_callback_url?: stringOptionalformation_date?: stringOptionalphone_numbers?: string[]Optionalstate_code?: stringOptionaltags?: string[]Optionaltax_identification_number?: stringOptionalwebsite?: stringOptionaladdress?: {Optionaladdress_city?: stringOptionaladdress_country?: stringOptionaladdress_state?: stringOptionaladdress_street_1?: stringOptionaladdress_street_2?: stringOptionaladdress_zip_code?: stringOptionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionaldate_of_birth?: stringFormat: date
Optionalemail_address?: stringFormat: email
Optionalevents_callback_url?: stringOptionalfirst_name?: stringOptionalfull_name?: stringOptionallast_name?: stringOptionalmiddle_name?: stringOptionalphone_number?: stringOptionalsecond_last_name?: stringOptionaltags?: string[]Optionaladditional_info?: {Optionalassociated_email?: stringOptionalbusiness_data?: {Optionalbusiness_profile_id?: stringOptionalcallback_url?: stringOptionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionalevents_callback_url?: stringOptionaltheme_options?: {Optionalbackground?: "light" | "dark" | nullOptionalbutton_border_radius?: string | nullOptionalbutton_font_size?: string | nullOptionalbutton_font_weight?: string | nullOptionalbutton_padding?: string | nullOptionalcolor_brand?: string | nullOptionalcolor_brand_overlay?: string | nullOptionalcolor_page?: string | nullOptionalfont_name?: string | nullOptionalfont_weights?: string | nullOptionalimage_border_radius?: string | nullOptionalinput_border_radius?: string | nullOptionalinput_font_size?: string | nullOptionalinput_font_weight?: string | nullOptionalinput_label_font_size?: string | nullOptionalinput_label_font_weight?: string | nullOptionalinput_padding?: string | nullOptionallayout_border_radius?: string | nullOptionalmodal_border_radius?: string | nullOptionalui_options?: {Optionalcommon?: { default_language?: string }Optionaldefault_language?: stringOptionaldynamic_business_document_module?: {Optionaldynamic_business_question_group_module?: {Optionalquestions?: {{
* "Q01": {
* "type": "SINGLE_CHOICE",
* "title": {
* "en": "What is your business type?"
* },
* "subtitle": {
* "en": "Select one"
* },
* "required": true,
* "order": 0,
* "options": [
* {
* "en": "Retail",
* "fr": "Vente au détail"
* },
* {
* "en": "Wholesale",
* "fr": "Vente en gros"
* }
* ]
* },
* "Q02": {
* "type": "TEXT",
* "title": {
* "en": "Describe your services"
* },
* "subtitle": {
* "en": ""
* },
* "required": false,
* "order": 1
* }
* }
Optionalverification_options?: {Optionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionaltheme_options?: {Optionalbackground?: "light" | "dark" | nullOptionalbutton_border_radius?: string | nullOptionalbutton_font_size?: string | nullOptionalbutton_font_weight?: string | nullOptionalbutton_padding?: string | nullOptionalcolor_brand?: string | nullOptionalcolor_brand_overlay?: string | nullOptionalcolor_page?: string | nullOptionalfont_name?: string | nullOptionalfont_weights?: string | nullOptionalimage_border_radius?: string | nullOptionalinput_border_radius?: string | nullOptionalinput_font_size?: string | nullOptionalinput_font_weight?: string | nullOptionalinput_label_font_size?: string | nullOptionalinput_label_font_weight?: string | nullOptionalinput_padding?: string | nullOptionallayout_border_radius?: string | nullOptionalmodal_border_radius?: string | nullOptionalui_options?: {Optionalcommon?: { default_language?: string }Optionaldefault_language?: stringOptionalid_verification_module?: { allowed_country_code?: string; allowed_document_type?: string | string[] }Optionalallowed_country_code?: stringOptionalallowed_document_type?: string | string[]A list of document types that will be pre-selected in the onboarding UI. Type string is deprecated, please use array of string(s). Check the country-wise supported documents list here: https://docs.aiprise.com/docs/supported-documents
Optionalverification_options?: {Links an existing user profile to a business profile as a related person
(control person or beneficial owner), attaching ownership/role metadata.
Returns the AiPrise person_reference_id used to reference the association
on update/delete (equal to the linked user profile ID).
Optionaladditional_fields?: Record<string, never>Optionalownership_percent?: number | nullOptionalroles?: {Optionalshares_allocated?: number | nullOptionaladditional_information?: {Optionaladdresses?: {Optionalalternate_name?: stringOptionalbusiness_entity_id?: stringOptionalcallback_url?: stringOptionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionalcountry_code?: stringOptionalemail_addresses?: string[]Optionalevents_callback_url?: stringOptionalformation_date?: stringOptionalname?: stringOptionalphone_numbers?: string[]Optionalstate_code?: stringOptionaltags?: string[]Optionaltax_identification_number?: stringOptionalwebsite?: stringOptionaladditional_fields?: Record<string, never>Optionalownership_percent?: number | nullOptionalrelationship_type?: "UNKNOWN" | "PARENT" | "CHILD" | "SIBLING" | nullOptionalroles?: {Optionalshares_allocated?: number | nullOptionaladdress?: Optionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionaldate_of_birth?: stringOptionalemail_address?: stringOptionalevents_callback_url?: stringOptionalfirst_name?: string | nullOptionalfull_name?: string | nullOptionallast_name?: string | nullOptionalmiddle_name?: string | nullOptionalphone_number?: stringOptionalphone_number_parts?: Optionalquestions_response?: {Optionalsecond_last_name?: string | nullOptionaluser_profile_id?: stringOptionaluser_profile_result?: "APPROVED" | "DECLINED" | "REVIEW" | "UNKNOWN" | "DEACTIVATED"Optionalverification_session_ids?: string[]Optionaladdress?: {Optionaladdress_city?: stringOptionaladdress_country?: stringOptionaladdress_state?: stringOptionaladdress_street_1?: stringOptionaladdress_street_2?: stringOptionaladdress_zip_code?: stringOptionalclient_reference_data?: Record<string, never>Optionalclient_reference_id?: stringOptionaldate_of_birth?: stringFormat: date
Optionalemail_address?: stringFormat: email
Optionalevents_callback_url?: stringOptionalfirst_name?: stringOptionalfull_name?: stringOptionallast_name?: stringOptionalmiddle_name?: stringOptionalphone_number?: stringOptionalsecond_last_name?: stringOptionaltags?: string[]
See
https://docs.aiprise.com/reference