Categorize a Natural User

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

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

string

Format: A valid email addressThe individual’s email address.

Birthday

Unix timestamp

required

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.

Nationality

string

required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The nationality of the individual.

CountryOfResidence

string

required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of residence of the individual.

PhoneNumber

string

Format: International E.164 standard (preceded by plus sign and country code) or local formatThe 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.

PhoneNumberCountry

string

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.

ScaContext

string

Possible values: USER_PRESENT, USER_NOT_PRESENTDefault value: USER_PRESENTThe 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.

Responses

200

FirstName

string

Min. length: 1; max. length: 100The first name of the individual.

LastName

string

Min. length: 1; max. length: 100The last name of the individual.

Birthday

Unix timestamp

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.

Nationality

string

Returned null if UserCategory is PAYER.The nationality of the individual.

CountryOfResidence

string

Returned null if UserCategory is PAYER.The country of residence of the individual.

Occupation

string

Max. length: 255 charactersThe occupation of the individual.Returned null if UserCategory is PAYER.

IncomeRange

integer

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

ProofOfIdentity

string

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.

ProofOfAddress

string

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.

Capacity

string

This is a deprecated parameter.

PhoneNumber

string

PhoneNumberCountry

string

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.

Address

object

The postal address of the user.

Show properties

AddressLine1

string

Max. length: 255 charactersThe first line of the address.

AddressLine2

string

Max. length: 255 charactersThe second line of the address.

City

string

Max. length: 255 charactersThe city of the address.

Region

string

Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode

string

Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country

string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.

PendingUserAction

object

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

Hide properties

RedirectUrl

string

The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.The SCA session link expires 10 minutes after it’s generated.Caution: Before redirecting the user on this URL, you must add the query parameter ReturnUrl with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).For more details, see How to redirect a user for an SCA session.

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.

string

Format: A valid email addressThe individual’s email address.

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.

400 - Endpoint not allowed if category already OWNER

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

{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Birthday": 652117514,
    "Nationality": "FR",
    "CountryOfResidence": "FR",
    "Occupation": null,
    "IncomeRange": null,
    "ProofOfIdentity": null,
    "ProofOfAddress": null,
    "Capacity": "NORMAL",
    "PhoneNumber": "0611111111",
    "PhoneNumberCountry": "FR",
    "Address": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "PendingUserAction": {
        "RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193ceab0948799a9af9726fb852fb98"
    },
    "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1734339135,
    "PersonType": "NATURAL",
    "Email": "[email protected]",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": true,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "OWNER",
    "UserStatus": "PENDING_USER_ACTION"
}

{
    "UserCategory": "OWNER",
    "TermsAndConditionsAccepted": true,
    // "Email": "[email protected]",
    // "PhoneNumber": "0611111111",
    // "PhoneNumberCountry": "FR",
    "Birthday": 652117514,
    "Nationality": "FR",
    "CountryOfResidence": "FR"
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

Categorize a Natural User

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Echo

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses