MOmodern-treasury

[DEPRECATED] Create User Onboarding

Changed on

Create a User Onboarding

post/user_onboardings

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/user_onboardings
  • Auth
    HTTP basic

Request body

flow_aliasstring required

Controls what fields are collected by embeddable onboarding flows and what checks are run. Pass in default-individual or default-business for defaults or customize them.

verified_emailstring

Verified email address of the end user.

verified_phonestring

Verified phone number of the end user. Please include the country code (e.g. +1 for US-based phone numbers) and format the number without hyphens (e.g. +11234567890).

metadatastring json

Metadata to be added to the User Onboarding object. Must be a JSON object.

counterparty_idstring

The ID of the associated counterparty. If this field is not provided, it will be updated if the User Onboarding is approved.

datastring json

Prefill the user onboarding form with known information.

statusstring

Specify a value of processing to trigger automatic processing of the user onboarding (i.e. when not using Modern Treasury's pre-built UI)

compliance_rule_metadataobject

Additional data represented as key-value pairs specifically for Compliance rules. Both the key and value must be strings.

session_keystring

A unique session key. Required when using the Device & Behavior Risk SDK to ensure collected information is included during KYC.

Changes