PUT
/
v2.01
/
{ClientId}
/
sca
/
users
/
legal
/
{UserId}
{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}

{
    "Name": "Alex Smith",
    "LegalPersonType": "SOLETRADER",
    "LegalRepresentative": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "ProofOfIdentity": null,
        "Birthday": null,
        "Nationality": null,
        "CountryOfResidence": null,
        "Email": null,
        "PhoneNumber": null,
        "PhoneNumberCountry": null
    },
    "ProofOfRegistration": null,
    "ShareholderDeclaration": null,
    "Statute": null,
    "CompanyNumber": null,
    "PendingUserAction": null,
    "HeadquartersAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "LegalRepresentativeAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "Id": "user_m_01JF7FKVP51PS3TYKCN79VZZ8M",
    "Tag": "Updated using the Mangopay API Postman collection",
    "CreationDate": 1734344306,
    "PersonType": "LEGAL",
    "Email": "alex.smith.services@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}

Caution – Modification may trigger SCA re-enrollment

If UserCategory is OWNER, modifying the following values changes UserStatus to PENDING_USER_ACTION and requires re-enrollment in SCA using the returned PendingUserAction.RedirectUrl:

  • LegalRepresentative.Email
  • LegalRepresentative.PhoneNumber
  • LegalRepresentative.PhoneNumberCountry

Caution – Modification may cause KYC/B verification downgrade

If 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 users

Due to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:

  • HeadquartersAddress.Country
  • LegalRepresentative.Nationality
  • LegalRepresentative.CountryOfResidence
  • LegalRepresentativeAddress.Country

​
Body parameters

​
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.

​
Name
string

Max. length: 255 characters

The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.

​
LegalPersonType
string

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.

​
LegalRepresentative
object

Information about the legal representative declared for the user.

​
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.

​
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.

​
LegalRepresentativeAddress
object

The address of the entity’s legal representative.

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

​
Email
string

Format: A valid email address

The email address for the entity.

​
Responses

{
    "Name": "Alex Smith",
    "LegalPersonType": "SOLETRADER",
    "LegalRepresentative": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "ProofOfIdentity": null,
        "Birthday": null,
        "Nationality": null,
        "CountryOfResidence": null,
        "Email": null,
        "PhoneNumber": null,
        "PhoneNumberCountry": null
    },
    "ProofOfRegistration": null,
    "ShareholderDeclaration": null,
    "Statute": null,
    "CompanyNumber": null,
    "PendingUserAction": null,
    "HeadquartersAddress": {
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "Region": null,
        "PostalCode": null,
        "Country": null
    },
    "LegalRepresentativeAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "Id": "user_m_01JF7FKVP51PS3TYKCN79VZZ8M",
    "Tag": "Updated using the Mangopay API Postman collection",
    "CreationDate": 1734344306,
    "PersonType": "LEGAL",
    "Email": "alex.smith.services@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}

{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}

Was this page helpful?

Create a Legal User (SCA)Categorize a Legal User