User Onboardings

A User Onboarding stores information that a user enters during the hosted onboarding flow. When a User Onboarding form is completed by a user, 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.

party_type
string

The party type of the end user. One of individual, business. Currently, KYC checks can only be done for individuals.

status
string

The current status of the User Onboarding session.

pending: The user has not filled out the form.
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 session is approved.

{
  "id": "e640a26e-4289-4799-b991-e5a136b94428",
  "object": "user_onboarding",
  "live_mode": true,
  "metadata": {},
  "party_type": "individual",
  "status": "approved",
  "verified_phone": null,
  "verified_email": null,
  "counterparty_id": "0e7f73bd-d449-4a30-8f52-6322bed44e8e",
  "decision_id": "08d9b87d-67a2-4234-a6d0-e8fec11ebb4f",
  "created_at": "2022-05-16T05:14:02Z",
  "updated_at": "2022-05-16T05:14:02Z"
}