PUT
/
v2.01
/
{ClientId}
/
users
/
natural
/
{UserId}

Read more about the Natural User object →

Caution – Modification may cause verification downgrade

Modification of some values may cause an Owner user to have a verification document marked as outdated, which may lead to their KYCLevel being downgraded from REGULAR to LIGHT

The impacted parameters are:

  • FirstName
  • LastName
  • Birthday
  • Nationality

For more information, see the Verification downgrade article.

Note – Country-based restrictions apply to users

Due to Mangopay’s , it is not possible to create or modify users using blocked countries.

For Natural Users, the following parameters are concerned:

  • Nationality
  • CountryOfResidence
  • Country of the Address

For more information, see the Country restrictions article.

Path parameters

UserId
string
required

The unique identifier of the user.

Body parameters

Address
object

The postal address of the user.

FirstName
string
required

Max. length: 100 characters

The first name of the user.

LastName
string
required

Max. length: 100 characters

The last name of the user.

Birthday
timestamp

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The date of birth of the user.

Nationality
string

Allowed values: Two-letter country code (ISO 3166-1 alpha-2 format).

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The nationality of the user.

CountryOfResidence
string

Allowed values: Two-letter country code (ISO 3166-1 alpha-2 format).

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The country of residence of the user.

Occupation
string

Max. length: 255 characters

The occupation of the user.

Returned null if UserCategory is PAYER.

IncomeRange
integer

Allowed values: 1, 2, 3, 4, 5, 6

The bracket indicating the income of the user. The brackets are:

  • 1: < 18K
  • 2: 18K - 30K
  • 3: 30K - 50K
  • 4: 50K - 80K
  • 5: 80K - 120K
  • 6: > 120K

Returned null if UserCategory is PAYER.

Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

Email
string
required

Format: A valid email address

The email address of the user.

TermsAndConditionsAccepted
boolean
required

Default value: false

Whether the user has accepted Mangopay’s terms and conditions (as defined by your contract).
If this value is not true, Owners will be limited in their use of Mangopay.

UserCategory
string
required

Default value: PAYER

Allowed values: PAYER, OWNER

The category of the user:

  • PAYER – User who can only make pay-ins to their wallet and transfers to other wallets.
  • OWNER – User who can do everything a Payer can, plus receive transfers to their wallet. To request payouts, an Owner user’s KYCLevel must be REGULAR. For more information, see the Verification section.

Responses