---
title: "[DEPRECATED] Create User Onboarding"
method: POST
path: "/user_onboardings"
---

# \[DEPRECATED\] Create User Onboarding

`POST /user_onboardings`

## Request

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

Create a User Onboarding

## Request body

- object
  - `flow_alias` string, 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](https://docs.moderntreasury.com/docs/customize-flow).
  - `verified_email` string: Verified email address of the end user.
  - `verified_phone` string: 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).
  - `metadata` string, json: Metadata to be added to the User Onboarding object. Must be a JSON object.
  - `counterparty_id` string: The ID of the associated counterparty. If this field is not provided, it will be updated if the User Onboarding is `approved`.
  - `data` string, json: Prefill the user onboarding form with known information.
  - `status` string: 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_metadata` object: Additional data represented as key-value pairs specifically for Compliance rules. Both the key and value must be strings.
  - `session_key` string: A unique session key. Required when using the [Device & Behavior Risk SDK](https://docs.moderntreasury.com/reference/device-behavior-risk-sdk) to ensure collected information is included during KYC.

## Changes

- **2026-11-03** `e31c6638c72e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/modern-treasury/apis/modern-treasury-api/changes/user_onboardings/post.md)

---

[API](https://skmtc.dev/modern-treasury/apis/modern-treasury-api.md) - [All operations](https://skmtc.dev/modern-treasury/apis/modern-treasury-api/llms.txt) - [OpenAPI document](https://skmtc.dev/modern-treasury/apis/modern-treasury-api/revisions/e31c6638c72e?raw)