Categorize a Legal User

PUT

/v2.01/:ClientId/sca/users/legal/:UserId/category

PUT

/v2.01/:ClientId/sca/users/legal/:UserId/category

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/sca/users/legal/UserId/category \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "UserCategory": "string",
>   "TermsAndConditionsAccepted": true,
>   "LegalRepresentative": {
>     "Birthday": 1,
>     "Nationality": "string",
>     "CountryOfResidence": "string"
>   },
>   "HeadquartersAddress": {
>     "AddressLine1": "string",
>     "City": "string",
>     "PostalCode": "string",
>     "Country": "string"
>   }
> }'

1 {
2   "Name": "string",
3   "LegalPersonType": "string",
4   "LegalRepresentative": {
5     "FirstName": "string",
6     "LastName": "string",
7     "ProofOfIdentity": "string",
8     "Birthday": 1,
9     "Nationality": "string",
10     "CountryOfResidence": "string",
11     "Email": "string",
12     "PhoneNumberCountry": "string",
13     "PhoneNumber": "string"
14   },
15   "ProofOfRegistration": "string",
16   "ShareholderDeclaration": "string",
17   "Statute": "string",
18   "CompanyNumber": "string",
19   "PendingUserAction": {
20     "RedirectUrl": "string"
21   },
22   "HeadquartersAddress": {
23     "AddressLine1": "string",
24     "AddressLine2": "string",
25     "City": "string",
26     "Region": "string",
27     "PostalCode": "string",
28     "Country": "string"
29   },
30   "LegalRepresentativeAddress": {
31     "AddressLine1": "string",
32     "AddressLine2": "string",
33     "City": "string",
34     "Region": "string",
35     "PostalCode": "string",
36     "Country": "string"
37   },
38   "Id": "string",
39   "Tag": "string",
40   "CreationDate": 1,
41   "PersonType": "LEGAL",
42   "Email": "string",
43   "KYCLevel": "string",
44   "TermsAndConditionsAccepted": true,
45   "TermsAndConditionsAcceptedDate": 1,
46   "UserCategory": "string",
47   "UserStatus": "string"
48 }

Transition a Legal Payer to Owner and enroll them in SCA

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.

SCA applies to all LegalPersonType: BUSINESS, ORGANIZATION, PARTNERSHIP, and SOLETRADER. In Sandbox the RedirectUrl is returned for all legal user types (see legal user integration and SCA triggers in Sandbox).

Optionally, you can update the LegalRepresentative.Email (in not already present) 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

UserIdstringRequired

Request

This endpoint expects an object.

UserCategorystringRequired

Allowed values: OWNER

The new category of the user, which must be OWNER.

TermsAndConditionsAcceptedbooleanRequired

Allowed values: true

Whether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).

LegalRepresentativeobjectRequired

Information about the legal representative declared for the user.

HeadquartersAddressobjectRequired

The postal address.

CompanyNumberstringOptional

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.

ScaContextstringOptional

Possible values: USER_PRESENT, USER_NOT_PRESENT

Default value: USER_PRESENT

The SCA context of the request, which is required if the OWNER value is being assigned for UserCategory:

USER_PRESENT – The user is on session during OWNER account creation and can enroll in SCA at the same time. The platform must redirect the user using the PendingUserAction.RedirectUrl returned so that the user can complete the SCA session.
USER_NOT_PRESENT – The platform has explicit permission from Mangopay to create the OWNER user account without simultaneous SCA enrollment.

Read more about asynchronous SCA enrollment →

Note: On User endpoints, ScaContext is not returned in the API response as it does not form part of the User data – it’s only related to the action being performed on the user.

Response

Success

Namestring

Max. length: 255 characters

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

LegalPersonTypestring

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

LegalRepresentativeobject

Information about the legal representative declared for the user.

ProofOfRegistrationstring or null

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.

ShareholderDeclarationstring or 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.

Statutestring or 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.

CompanyNumberstring or null

Required if UserCategory is OWNER and LegalPersonType is BUSINESS. Returned null if UserCategory is PAYER.

PendingUserActionobject or null

Object containing the RedirectUrl needed for SCA redirection if triggered by the API call (otherwise returned null).

HeadquartersAddressobject

The legally registered address of the entity’s administrative center. This object’s sub-parameters are null if the UserCategory is PAYER.

LegalRepresentativeAddressobject

The address of the entity’s legal representative.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

PersonTypeenum

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.

Emailstring

Format: A valid email address

The email address for the entity.

KYCLevelstring

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 whose UserCategory is OWNER can submit verification documents for validation. Only users whose KYCLevel is REGULAR can request payouts.

TermsAndConditionsAcceptedboolean

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.

TermsAndConditionsAcceptedDateinteger or null

The date and time at which the TermsAndConditionsAccepted value was set to true.

Returned null if UserCategory is PAYER.

UserCategorystring

Possible values: PAYER, OWNER, PLATFORM

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

UserStatusstring

Returned values: PENDING_USER_ACTION, ACTIVE, CLOSED

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

Errors

400

Bad Request Error