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:
NationalityCountryOfResidence
Body parameters
Allowed values:
OWNERThe new category of the user, which must be OWNER.Allowed values:
trueWhether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).Format: A valid email addressThe individual’s email address.
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.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The nationality of the individual.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of residence of the individual.
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.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.Responses
200
200
Min. length: 1; max. length: 100The first name of the individual.
Min. length: 1; max. length: 100The last name of the individual.
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.Returned
null if UserCategory is PAYER.The nationality of the individual.Returned
null if UserCategory is PAYER.The country of residence of the individual.Max. length: 255 charactersThe occupation of the individual.Returned
null if UserCategory is PAYER.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
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.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.This is a deprecated parameter.
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.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.The postal address of the user.
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned
null).Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom data that you can add to this object.
The date and time at which the object was created.
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.
PersonType is defined by the endpoint used to create the user and can’t be modified.Format: A valid email addressThe individual’s email address.
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 whoseUserCategoryisOWNERcan submit verification documents for validation. Only users whoseKYCLevelisREGULARcan request payouts.
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.The date and time at which the
TermsAndConditionsAccepted value was set to true.Returned null if UserCategory is PAYER.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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
Returned values:
PENDING_USER_ACTION, ACTIVE, CLOSEDThe status of the user:PENDING_USER_ACTION– The user must enroll in SCA before they can becomeACTIVE.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
400 - Endpoint not allowed if category already OWNER
UserCategory is OWNER, use the POST Enroll a User in SCA endpoint to obtain an SCA session link.