POST
/
v2.01
/
{ClientId}
/
sca
/
users
/
natural
{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "FirstName": "Alex",
    "LastName": "Smith",
    "Email": "alex.smith@example.com",
    "Address": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "Tag": "Created using the Mangopay API Postman collection",
    "PhoneNumber": "0611111111",
    "PhoneNumberCountry": "FR"
}
{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Birthday": null,
    "Nationality": null,
    "CountryOfResidence": null,
    "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": null,
    "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1734339135,
    "PersonType": "NATURAL",
    "Email": "alex.smith@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}
Note – SCA triggered for OwnersIf UserCategory is OWNER, this endpoint triggers SCA enrollment. Your platform needs to use the returned PendingUserAction.RedirectUrl (and add an encoded returnUrl query parameter) to redirect the user so they can enroll.Read more about how to redirect them in the SCA session guide.
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
  • Address.Country

Body parameters

FirstName
string
required
Min. length: 1; max. length: 100The first name of the individual.
LastName
string
required
Min. length: 1; max. length: 100The last name of the individual.
Birthday
Unix timestamp
Required if UserCategory is OWNER. 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
Format: Two-letter country code (ISO 3166-1 alpha-2 format)Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.The nationality of the individual.
CountryOfResidence
string
Format: Two-letter country code (ISO 3166-1 alpha-2 format)Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.The country of residence of the individual.
Occupation
string
Max. length: 255 charactersReturned null if UserCategory is PAYER.The occupation of the individual.
IncomeRange
integer
Allowed values: 1, 2, 3, 4, 5, 6, nullReturned 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
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
Email
string
required
Format: A valid email addressThe individual’s email address.
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.
Address
object
The postal address of the user.
TermsAndConditionsAccepted
boolean
required
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.
UserCategory
string
required
Allowed values: PAYER, OWNERThe 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.

Responses

{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Birthday": null,
    "Nationality": null,
    "CountryOfResidence": null,
    "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": null,
    "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1734339135,
    "PersonType": "NATURAL",
    "Email": "alex.smith@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}
{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "FirstName": "Alex",
    "LastName": "Smith",
    "Email": "alex.smith@example.com",
    "Address": {
        "AddressLine1": "3 rue de la Cité",
        "AddressLine2": "Appartement 7",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75004",
        "Country": "FR"
    },
    "Tag": "Created using the Mangopay API Postman collection",
    "PhoneNumber": "0611111111",
    "PhoneNumberCountry": "FR"
}