PUT
/
v2.01
/
{ClientId}
/
users
/
legal
/
{UserId}
{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}
{
    "HeadquartersAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "LegalRepresentativeAddress": {
        "AddressLine1": "34 rue des Entreprises",
        "AddressLine2": "Appartement 14",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "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,
    "Id": "user_m_01JHX2YFX51HSR8R2HJ8ABSEFF",
    "Tag": "New tag",
    "CreationDate": 1670863988,
    "PersonType": "LEGAL",
    "Email": "best.business@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}  
Caution – Modification may cause KYC/B verification downgradeIf KYCLevel is REGULAR, modifying the following values triggers a verification downgrade to LIGHT:
  • LegalRepresentative.FirstName
  • LegalRepresentative.LastName
  • LegalRepresentative.Birthday
  • LegalRepresentative.Nationality
  • LegalPersonType
Note – Country-based restrictions apply to usersDue to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
  • HeadquartersAddress.Country
  • LegalRepresentativeNationality
  • LegalRepresentativeCountryOfResidence
  • LegalRepresentativeAddress.Country

Path parameters

UserId
string
required
The unique identifier of the user.

Body parameters

UserCategory
string
required
Allowed values: PAYER, OWNERThe 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.
TermsAndConditionsAccepted
boolean
required
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.
Allowed 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.
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.
Email
string
Format: A valid email addressThe email address for the entity.
HeadquartersAddress
object
Required if UserCategory is OWNER. Child parameters returned null if UserCategory is PAYER.The legally registered address of the entity’s administrative center.
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.
The address of the entity’s legal representative.
Min length: 1; max. length: 100The first name of the entity’s legal representative.
Min length: 1; max. length: 100The last name of the entity’s legal representative.
Format: A valid email addressThe 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.
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.

Responses

{
    "HeadquartersAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "LegalRepresentativeAddress": {
        "AddressLine1": "34 rue des Entreprises",
        "AddressLine2": "Appartement 14",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "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,
    "Id": "user_m_01JHX2YFX51HSR8R2HJ8ABSEFF",
    "Tag": "New tag",
    "CreationDate": 1670863988,
    "PersonType": "LEGAL",
    "Email": "best.business@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}  
{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}