API Reference

User Creation

Registers a new user on a platform.


👤 User Creation — Important Notes

🔑 Roles

  • The payer role (0) is deprecated and must not be used anymore.
  • Always create users with the owner role (1). ✅

📝 Person object requirements

When creating a user, you must provide a person object.

  • The fields required depend on the person type (Persons::Natural, Persons::Legal, Persons::Group).
  • Each field in the schema explicitly mentions if it applies to Natural or Legal persons.

📌 Best practice: Always fill the person object as completely as possible, even if not all fields are strictly mandatory.


🧍 Persons::Natural

A Natural person (individual) requires:

  • first_name
  • last_name
  • birth_date
  • nationality
  • address_attributes (including country)

🏢 Persons::Legal

A Legal person (company, association, etc.) requires:

  • category (business category)
  • business_entity (company / association name)
  • nationality
  • address_attributes

⚠️ Important: If you create a user represented by a Persons::Legal,
you must also attach at least one childPersons::Natural that represents the legal representative.

Inside this child object, set:

"user_representative": true



Language
Credentials
Bearer
JWT