Users

Create a user

Changed on

Creates a user.

The user must complete identity checks and provide any required identifiers before their role for an account group or business becomes active.

See the Creating a user guide (TOL / BYOL) for the full onboarding flow.

post/users

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/users
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: users:admin)

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

OR

Response

User created.

OR

Changes

  • 9a5a2a64d218Revision changes
    • info

      response property anyOf[subschema #1: User (BYOL)]/status deprecated

    • info

      response property anyOf[subschema #2: User (TOL)]/status deprecated

  • 725dd12761d9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status