Skip to main content
PUT
/
v2.01
/
{ClientId}
/
sca
/
users
/
legal
/
{UserId}
/
category
{
    "UserCategory": "OWNER",
    "TermsAndConditionsAccepted": true,
    "LegalRepresentative": {
        // "Email": "alex.smith@example.com",
        // "PhoneNumber": "0611111111",
        // "PhoneNumberCountry": "FR",
        "Birthday": 652117514,
        "Nationality": "FR",
        "CountryOfResidence": "FR",
    },
    "HeadquartersAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "CompanyNumber": "123456789"
}

{
    "Name": "Alex Smith",
    "LegalPersonType": "SOLETRADER",
    "LegalRepresentative": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "ProofOfIdentity": null,
        "Birthday": 652117514,
        "Nationality": "FR",
        "CountryOfResidence": "FR",
        "Email": "alex.smith@example.com",
        "PhoneNumber": "0611111111",
        "PhoneNumberCountry": "FR"
    },
    "ProofOfRegistration": null,
    "ShareholderDeclaration": null,
    "Statute": null,
    "CompanyNumber": "123456789",
    "PendingUserAction": {
        "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193cef9efe7782881459b02bed1986c"
    },
    "HeadquartersAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "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": "Created using Mangopay API Collection Postman",
    "CreationDate": 1734344306,
    "PersonType": "LEGAL",
    "Email": "alex.smith.services@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": true,
    "TermsAndConditionsAcceptedDate": 1734344306,
    "UserCategory": "OWNER",
    "UserStatus": "PENDING_USER_ACTION"
}
This endpoint allows you to transition a user whose UserCategory is PAYER into an OWNER by providing the required information and redirecting them on the PendingUserAction.RedirectUrl response value to complete SCA enrollment. The RedirectUrl is currently only returned if LegalPersonType is SOLETRADER, but the endpoint should be integrated for the other types. Optionally, you can update the LegalRepresentative.Email and provide or update the LegalRepresentative.PhoneNumber and LegalRepresentative.PhoneNumberCountry before SCA redirection. If the user’s UserCategory is already OWNER, use the POST Enroll a User in SCA endpoint to obtain an SCA session link. Read more about SCA redirection →
Note – Country-based restrictions apply to usersDue to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
  • LegalRepresentative.Nationality
  • LegalRepresentative.CountryOfResidence

​
Body parameters

​
UserCategory
string
required
Allowed values: OWNERThe new category of the user, which must be OWNER.
​
TermsAndConditionsAccepted
boolean
required
Allowed values: trueWhether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).
​
LegalRepresentative
object
required
Information about the legal representative declared for the user.
​
HeadquartersAddress
object
required
The legally registered address of the entity’s administrative center.
​
CompanyNumber
string
Required if LegalPersonType is BUSINESS.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.

​
Responses

​
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.
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "939c4b8c-3e82-4012-a5bd-a3aa2727432a",
    "Date": 1751881519.0,
    "errors": {
        "LegalRepresentative.Email": "'Email' must not be empty."
    }
}

{
    "Message": "This endpoint is not allowed for User categorized as OWNER",
    "Type": "not_allowed_for_user_category_owner",
    "Id": "68d1c3e0-ea28-465b-9ef1-36f388fc896d",
    "Date": 1734348365.0,
    "errors": null
}
If the user’s UserCategory is OWNER, use the POST Enroll a User in SCA endpoint to obtain an SCA session link.
{
    "Name": "Alex Smith",
    "LegalPersonType": "SOLETRADER",
    "LegalRepresentative": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "ProofOfIdentity": null,
        "Birthday": 652117514,
        "Nationality": "FR",
        "CountryOfResidence": "FR",
        "Email": "alex.smith@example.com",
        "PhoneNumber": "0611111111",
        "PhoneNumberCountry": "FR"
    },
    "ProofOfRegistration": null,
    "ShareholderDeclaration": null,
    "Statute": null,
    "CompanyNumber": "123456789",
    "PendingUserAction": {
        "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193cef9efe7782881459b02bed1986c"
    },
    "HeadquartersAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "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": "Created using Mangopay API Collection Postman",
    "CreationDate": 1734344306,
    "PersonType": "LEGAL",
    "Email": "alex.smith.services@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": true,
    "TermsAndConditionsAcceptedDate": 1734344306,
    "UserCategory": "OWNER",
    "UserStatus": "PENDING_USER_ACTION"
}

{
    "UserCategory": "OWNER",
    "TermsAndConditionsAccepted": true,
    "LegalRepresentative": {
        // "Email": "alex.smith@example.com",
        // "PhoneNumber": "0611111111",
        // "PhoneNumberCountry": "FR",
        "Birthday": 652117514,
        "Nationality": "FR",
        "CountryOfResidence": "FR",
    },
    "HeadquartersAddress": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "CompanyNumber": "123456789"
}
⌘I