Create new user

For Partners, using BTS “Investment as a Service” solution:

The endpoint allows to create a new user in Bitpanda system. The parameters in the query body can contain:

  • Customer master data
  • KYC/verification data
  • Accepted Terms & Conditions

If the user has more than one first name or first and middle name, send all names in first_name field separated by a space. The success response returns the ID of the newly created user.

For Partners, using BTS “Bring Your Own License” solution:

The only parameter, which must be sent in the request, is external_id.

The value of this parameter must be unique for each account (user)

SecuritybearerAuth
Request
Request Body schema: application/json

The user to create.

email
required
string
phone
required
string

Phone number in E.164 standard format

first_name
required
string

Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space

last_name
required
string

Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space

language
required
string

ISO 639-1 language code for user account

country
required
string

Alpha-2 ISO 3166 country code. Represents user's citizenship.

terms
required
Array of integers

The IDs of the accepted terms and conditions and privacy policy

required
Array of objects
Array of objects

Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs

required
object
object
object

Compliance information, provided by the Partner

account_level_id
string

User account level ID

external_id
string

User’s identifier at the partner side. Case insensitive

object

Set of key-value pairs, allowing Partner to provide additional information, as agreed during the integration process

Responses
201

New user has been created

400

Error

401

Unauthorized

404

Invalid language

409

Duplicate external_id

422

Error

429

Too Many Requests

500

Error

503

Maintenance or Service unavailable

post/v2/users
Request samples
application/json
{
  • "email": "username@domain.com",
  • "phone": "+33123123412",
  • "first_name": "Jean",
  • "last_name": "Pascal",
  • "language": "en",
  • "country": "FR",
  • "terms": [
    ],
  • "aml": [
    ],
  • "appropriateness": [
    ],
  • "verification": {
    },
  • "tax": {
    },
  • "ext_compliance": {
    },
  • "account_level_id": "1",
  • "external_id": "Ext-Id-1",
  • "external_meta": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}