The Natural User object
Description
The Natural User object represents an individual (natural person).
The actions a user can take are defined by the UserCategory
and KYCLevel
. For more information, see the Categories article.
Attributes
The postal address of the user.
Max. length: 100 characters
The first name of the user.
Max. length: 100 characters
The last name of the user.
The date of birth of the user.
Returned null
if UserCategory
is PAYER
.
The nationality of the user.
Returned null
if UserCategory
is PAYER
.
Returned null
if UserCategory
is PAYER
.
The country of residence of the user.
Max. length: 255 characters
The occupation of the user.
Returned null
if UserCategory
is PAYER
.
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
.
The Id
of the KYC Document whose Type
is IDENTITY_PROOF
if validated for the user. If no identity proof is validated, then this value is null
.
The Id
of the KYC Document whose Type
is ADDRESS_PROOF
if validated for the user. If no address proof is validated, then this value is null
.
This is a deprecated parameter.
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
Returned values: NATURAL, LEGAL
The type of the user:
NATURAL
– Natural users are individuals (natural persons).LEGAL
– Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.
The PersonType
is defined by the endpoint used to create the user and can’t be modified.
Format: A valid email address
The email address of the user.
Default value: LIGHT
Returned values: LIGHT
, REGULAR
The verification status of the user set by Mangopay:
LIGHT
– Unverified, assigned by default to all users.REGULAR
– Verified, meaning the user has successfully completed the verification process and had the necessary documents validated by Mangopay. Only users whoseUserCategory
isOWNER
can submit verification documents for validation. Only users whoseKYCLevel
isREGULAR
can request payouts.
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.
The date and time at which the TermsAndConditionsAccepted
value was set to true
.
Returned null
if UserCategory
is PAYER
.
Default value: PAYER
Returned values: PAYER, OWNER, PLATFORM
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’sKYCLevel
must beREGULAR
. For more information, see the Verification section.
Returned values: ACTIVE, CLOSED
Internal use only. This field can only be used and updated by Mangopay teams.
Related resources
Was this page helpful?