​
Description

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 the KYCLevel of REGULAR and the ability to request payouts.
To enable OWNER users to enroll in SCA, Mangopay released new versions of the user objects and new endpoints.

Guides

Read more about SCA on Owner users

​
Changes from non-SCA object

The changes to the Legal User object are:
  • New UserStatus value PENDING_USER_ACTION indicating that the user must enroll in SCA
  • New response parameter PendingUserAction.RedirectUrl containing the SCA session URL to which the individual must be redirected (after adding an encoded returnUrl query parameter)
  • New LegalRepresentative object to group parameters related to the declared legal representative. This object includes the new LegalRepresentative.PhoneNumber and LegalRepresentative.PhoneNumberCountry, which may be used to pre-populate the user’s phone number in the SCA session
Caution – Legal representative’s email requiredFor OWNER users, the LegalRepresentative.Email address is required.SCA uses this email address to build a behavioral biometrics profile and as a backup communication channel.Prior to SCA, it was possible to create a Legal OWNER without the LegalRepresentativeEmail, so this data may be missing. Calling the POST Enroll a User in SCA endpoint without this data will return an error.
{
    "HeadquartersAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "LegalRepresentativeAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "Name": "Best Business",
    "LegalPersonType": "BUSINESS",
    "LegalRepresentativeFirstName": "Alex",
    "LegalRepresentativeLastName": "Smith",
    "LegalRepresentativeEmail": null,
    "LegalRepresentativeBirthday": null,
    "LegalRepresentativeNationality": null,
    "LegalRepresentativeCountryOfResidence": null,
    "ProofOfRegistration": null,
    "ShareholderDeclaration": null,
    "Statute": null,
    "LegalRepresentativeProofOfIdentity": null,
    "CompanyNumber": null,
    "PhoneNumber": null,
    "PhoneNumberCountry": null,
    "Id": "user_m_01JHX3FQ7K0WB275T1BZ1SPZMF",
    "Tag": "Legal User v2.01 example",
    "CreationDate": 1737217268,
    "PersonType": "LEGAL",
    "Email": "best.business@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}

​
Attributes

​
Name
string
Max. length: 255 charactersThe registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
​
LegalPersonType
string
Returned values: BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADERThe 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.
​
LegalRepresentative
object
Information about the legal representative declared for the user.
​
ProofOfRegistration
string
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.
​
ShareholderDeclaration
string
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.
​
Statute
string
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.
​
CompanyNumber
string
Required if UserCategory is OWNER and LegalPersonType is BUSINESS. Returned null if UserCategory is PAYER.The registration number of the entity, assigned by the relevant national authority. For information on the expected format for a specific country, see the Company number guide. To validate the format of a number before submitting documents for verification, use POST Validate the format of User data.
​
PendingUserAction
object
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
​
HeadquartersAddress
object
The legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.
​
LegalRepresentativeAddress
object
The address of the entity’s legal representative.
​
Id
string
Max length: 128 characters (see data formats for details)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 for the entity.
​
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 validated workflow implemented by the platform.
​
UserStatus
string
Returned values: PENDING_USER_ACTION, ACTIVE, CLOSEDThe status of the user:
  • PENDING_USER_ACTION – The user must enroll in SCA before they can become ACTIVE.
  • ACTIVE – The user account is active and the user can access Mangopay features.
  • CLOSED – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions.

Guide

Users – Categories

Guide

Owner SCA