[DEPRECATED] User Onboardings

A user_onboarding is an object that stores information a user enters during the pre-built onboarding flow. When a user_onboarding is completed, downstream actions like creating a Counterparty and running compliance and fraud checks can occur.

Related Guides: Onboarding Users.

Attribute	Description
id string	Unique identifier for the User Onboarding session. This id is used to start the embedded onboarding flow.
live_mode boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
metadata jsonb	Additional data represented as key-value pairs. Both the key and value must be strings.
flow_alias string	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.
status string	The current status of the User Onboarding session. `pending`: The user has not filled out the form. `processing`: The user's compliance decision is being processed. `approved`: The user has been approved. `denied`: The user has been denied. `needs_approval`: The user needs manual approval. `expired`: The User Onboarding session has been expired before being completed by the user.
verified_email string	Verified email of the end user. This field is compared with the email address entered by the user, and is an input to KYC checks.
verified_phone string	Verified phone number of the end user. This field is compared with the phone number entered by the user, and is an input to KYC checks.
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`.
external_account_id string	The ID of the associated external account. This will be updated if the User Onboarding is `approved`.
data jsonb	Prefill the embeddable user onboarding flows with known information or submit data via API.
compliance_rule_metadata object	Pass in additional data for use in Compliance rules. Data must be represented as key-value pairs, where the key and value are strings. See Metadata.
session_key string	A unique session key. Required when using the Device & Behavior Risk SDK to ensure collected information is included during Transaction Monitoring.

{
  "id": "e640a26e-4289-4799-b991-e5a136b94428",
  "object": "user_onboarding",
  "live_mode": true,
  "metadata": {},
  "flow_alias": "default-individual",
  "status": "approved",
  "counterparty_id": "0e7f73bd-d449-4a30-8f52-6322bed44e8e",
  "external_account_id": "4c95964e-c9d4-4102-9183-2c8ae39e2c1d",
  "decision_id": "08d9b87d-67a2-4234-a6d0-e8fec11ebb4f",
  "created_at": "2022-05-16T05:14:02Z",
  "updated_at": "2022-05-16T05:14:02Z",
  "compliance_rule_metadata": {}
}