Skip to main content
The Natural User object represents an individual (natural person). Mangopay users have one of two categories, indicated by UserCategory:
  • PAYER – User who can only make pay-ins to their wallets and transfers to other wallets.
  • OWNER – User who can also receive transfers to their wallets. Owners are able to request KYC verification, which if successful gives them the KYCLevel of REGULAR and the ability to request payouts.

​
Attributes

​
Address
object
The postal address of the user.
​
FirstName
string
Min. length: 1; max. length: 100The first name of the individual.
​
LastName
string
Min. length: 1; max. length: 100The last name of the user.
​
Birthday
Unix timestamp
The date of birth of the user.Returned null if UserCategory is PAYER.Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.
​
Nationality
string
The nationality of the user. Returned null if UserCategory is PAYER.
​
CountryOfResidence
string
Returned null if UserCategory is PAYER.The country of residence of the user.
​
Occupation
string
Max. length: 255 charactersThe occupation of the user.Returned null if UserCategory is PAYER.
​
IncomeRange
integer
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.
​
ProofOfIdentity
string
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.
​
ProofOfAddress
string
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.
​
Capacity
string
This is a deprecated parameter.
​
Id
string
The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
PersonType
string
Returned values: NATURAL, LEGALThe 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.
​
Email
string
Format: A valid email addressThe email address of the user.
​
KYCLevel
string
Default value: LIGHTReturned values: LIGHT, REGULARThe 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 whose UserCategory is OWNER can submit verification documents for validation. Only users whose KYCLevel is REGULAR can request payouts.
​
TermsAndConditionsAccepted
boolean
Whether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).Must be true if UserCategory is OWNER.
​
TermsAndConditionsAcceptedDate
Unix timestamp
The date and time at which the TermsAndConditionsAccepted value was set to true.Returned null if UserCategory is PAYER.
​
UserCategory
string
Possible values: PAYER, OWNER, PLATFORMThe category of the user:
  • PAYER – User who can only make pay-ins to their wallets and transfers to other wallets (as well as refunds for pay-ins and transfers).
  • OWNER – User who can also receive transfers to their wallets. Owners are able to request KYC verification, which if successful gives them the KYCLevel of REGULAR and the ability to request payouts.
  • PLATFORM – Single specific user that represents the platform. The PLATFORM value is only assigned by Mangopay and may be used as part of the approved and validated workflow implemented by the platform.
​
UserStatus
string
Returned values: ACTIVE, CLOSEDInternal use only. This field can only be used and updated by Mangopay teams.

Guide

Users – Introduction and types

Guide

Users – Categories