The Natural User object
Caution - Deprecated endpoints
The legacy User endpoints are deprecated. These endpoints will stop working and return an error after Dec 15, 2025.
These endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA.
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 theKYCLevelofREGULARand the ability to request payouts.
Attributes
Min. length: 1; max. length: 100
The first name of the individual.
Min. length: 1; max. length: 100
The last name of the individual.
Returned null if UserCategory is PAYER.
The date of birth of the individual.
Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.
Returned null if UserCategory is PAYER.
The nationality of the individual.
Returned null if UserCategory is PAYER.
The country of residence of the individual.
Max. length: 255 characters
The occupation of the individual.
Returned null if UserCategory is PAYER.
Returned null if UserCategory is PAYER.
The bracket indicating the income of the individual. The brackets are:
- 1: < 18K
- 2: 18K - 30K
- 3: 30K - 50K
- 4: 50K - 80K
- 5: 80K - 120K
- 6: > 120K
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.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
Unix timestamp (UTC) of the date and time 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 whoseUserCategoryisOWNERcan submit verification documents for validation. Only users whoseKYCLevelisREGULARcan request payouts.
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.
Unix timestamp (UTC) of the date and time the TermsAndConditionsAccepted value was set to true.
Returned null if UserCategory is PAYER.
Possible values: PAYER, OWNER, PLATFORM
The 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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
Returned values: ACTIVE, CLOSED
Internal use only. This field can only be used and updated by Mangopay teams.