Overview
User management
- Users
- The Natural User object (SCA)
- POSTCreate a Natural User (SCA)
- PUTUpdate a Natural User (SCA)
- PUTCategorize a Natural User
- The Legal User object (SCA)
- POSTCreate a Legal User (SCA)
- PUTUpdate a Legal User (SCA)
- PUTCategorize a Legal User
- POSTEnroll a User in SCA
- GETView a User (SCA)
- GETList all Users
- Non-SCA endpoints
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Categorize a Legal User
Transition a Legal Payer to Owner and enroll them in SCA
{
"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.
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 users
Due to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
LegalRepresentative.NationalityLegalRepresentative.CountryOfResidence
Body parameters
Allowed values: OWNER
The new category of the user, which must be OWNER.
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).
Information about the legal representative declared for the user.
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: A valid email address
The individual’s email address.
Format: International E.164 standard (prefixed 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.
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 legally registered address of the entity’s administrative center.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
Required if Country is US, CA, or MX.
The region of the address.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
The country of the address.
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
Max. length: 255 characters
The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
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.
Information about the legal representative declared for the user.
Min. length: 1; max. length: 100
The first name of the individual.
Min. length: 1; max. length: 100
The last name of the individual.
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.
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.
Format: A valid email address
The individual’s email address.
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.
Format: International E.164 standard (prefixed 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.
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.
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.
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.
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.
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
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.
The legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The address of the entity’s legal representative.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
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.
Format: A valid email address
The email address for the entity.
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 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.
Returned 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.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– Value assigned only by Mangopay.
Returned values: PENDING_USER_ACTION, ACTIVE, CLOSED
The 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.
{
"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"
}
Was this page helpful?
{
"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"
}