Categorize a Natural User

PUT

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

PUT

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

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/sca/users/natural/UserId/category \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "Birthday": 652117514,
>     "CountryOfResidence": "FR",
>     "Email": "alex.smith@example.com",
>     "Nationality": "FR",
>     "PhoneNumber": "0611111111",
>     "PhoneNumberCountry": "FR",
>     "TermsAndConditionsAccepted": true,
>     "UserCategory": "OWNER"
>   }
> }'

1 {
2   "FirstName": "Alex",
3   "LastName": "Smith",
4   "Birthday": 652117514,
5   "Nationality": "FR",
6   "CountryOfResidence": "FR",
7   "Occupation": null,
8   "IncomeRange": null,
9   "ProofOfIdentity": null,
10   "ProofOfAddress": null,
11   "Capacity": "NORMAL",
12   "PhoneNumber": "0611111111",
13   "PhoneNumberCountry": "FR",
14   "Address": {
15     "AddressLine1": "3 rue de la Cité",
16     "AddressLine2": "Appartement 7",
17     "City": "Paris",
18     "Region": "Île-de-France",
19     "PostalCode": "75004",
20     "Country": "FR"
21   },
22   "PendingUserAction": {
23     "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193ceab0948799a9af9726fb852fb98"
24   },
25   "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
26   "Tag": "Created using Mangopay API Postman Collection",
27   "CreationDate": 1734339135,
28   "PersonType": "NATURAL",
29   "Email": "alex.smith@example.com",
30   "KYCLevel": "LIGHT",
31   "TermsAndConditionsAccepted": true,
32   "TermsAndConditionsAcceptedDate": null,
33   "UserCategory": "OWNER",
34   "UserStatus": "PENDING_USER_ACTION"
35 }

Transition a Natural 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.

Optionally, you can update the Email and provide or update the PhoneNumber and 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).

BirthdayintegerRequired

The date of birth of the individual.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

NationalitystringRequired

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The nationality of the individual.

CountryOfResidencestringRequired

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of residence of the individual.

EmailstringOptional

Format: A valid email address

The individual’s email address.

PhoneNumberstringOptional

Format: International E.164 standard (preceded by plus sign and country code) or local format

The individual’s phone number. The local format (recommended) requires PhoneNumberCountry to ensure correct formatting.

If present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.

For users with UserCategory OWNER , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API.

PhoneNumberCountrystringOptional

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

Required if the PhoneNumber is provided in local format (recommended), to render the value in the E.164 standard.

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

FirstNamestring

Min. length: 1; max. length: 100

The first name of the individual.

LastNamestring

Min. length: 1; max. length: 100

The last name of the individual.

Birthdayinteger or null

Returned null if UserCategory is PAYER.

The date of birth of the individual.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

Nationalitystring or null

Returned null if UserCategory is PAYER.

The nationality of the individual.

CountryOfResidencestring or null

Returned null if UserCategory is PAYER.

The country of residence of the individual.

Occupationstring or null

Max. length: 255 characters

The occupation of the individual.

Returned null if UserCategory is PAYER.

IncomeRangeinteger or null

Returned null if UserCategory is PAYER.

The bracket indicating the income of the individual. The brackets are:

1: < 18K
2: 18K - 30K
3: 30K - 50K
4: 50K - 80K
5: 80K - 120K
6: > 120K

ProofOfIdentitystring or null

The Id of the KYC Document whose Type is IDENTITY_PROOF if validated for the user. If no identity proof is validated, then this value is null.

ProofOfAddressstring or null

The Id of the KYC Document whose Type is ADDRESS_PROOF if validated for the user. If no address proof is validated, then this value is null.

Capacitystring

This is a deprecated parameter.

PhoneNumberstring or null

Format: International E.164 standard (preceded by plus sign and country code) or local format

The individual’s phone number. The local format (recommended) requires PhoneNumberCountry to ensure correct formatting.

If present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.

PhoneNumberCountrystring or null

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

Required if the PhoneNumber is provided in local format (recommended), to render the value in the E.164 standard.

Addressobject

The postal address.

PendingUserActionobject or null

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

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.

PersonTypestring

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 individual’s email address.

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