The Legal 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 Legal User object represents a legal entity (legal person) like a company, non-profit or sole proprietor (read more about user types).
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
The address of the platform operator’s headquarters. This parameter must be provided for the platform’s payouts to be processed.
properties
Max. length: 255 characters The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters The city of the address.
Max. length: 255 characters
Required if Country is US, CA, or MX.
The region of the address.
Max. length: 255 characters
Required if HeadquarterAddress is sent.
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The address of the entity’s legal representative.
properties
Max. length: 255 characters The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters The city of the address.
Max. length: 255 characters
Required if Country is US, CA, or MX.
The region of the address.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
Max. length: 255 characters
The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
Allowed values: BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER
The type of legal user. For information on which LegalPersonType to use for a particular local legal structure, see the verification requirements.
Caution: Modification of the LegalPersonType may result in a verification downgrade.
Min length: 1; max. length: 100
The first name of the entity’s legal representative.
Min length: 1; max. length: 100
The last name of the entity’s legal representative.
Format: A valid email address
The email address of the entity’s legal representative.
Returned null if UserCategory is PAYER.
Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.
The date of birth of the entity’s legal representative.
Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.
Format: 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 entity’s legal representative.
Format: 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 entity’s legal representative.
The Id of the KYC Document whose Type is REGISTRATION_PROOF if validated for the user. If no registration proof is validated, then this value is null.
The Id of the KYC Document whose Type is SHAREHOLDERS_DECLARATION if validated for the user. If no Shareholder Declaration is validated, then this value is null.
The Id of the KYC Document whose Type is ARTICLES_OF_ASSOCIATION if validated for the user. If no articles of association document is validated, then this value is null.
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 registration number of a legal entity, assigned by the relevant national authority.
Note: Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules.
The unique identifier of the object.
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.
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 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.
The date and time at which the TermsAndConditionsAccepted value was set to true.
Returned null if UserCategory is PAYER.
Allowed values: PAYER, OWNER
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.
Returned values: ACTIVE, CLOSED
Internal use only. This field can only be used and updated by Mangopay teams.