Skip to main content
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.
​
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

​
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
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.
​
PendingUserAction
object
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
​
Id
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.
​
Email
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.
{
    "Message": "The data you provided does not comply with our anti-fraud policy",
    "Type": "fraud_policy",
    "Id": "51876239-4814-422e-8f4b-6986520414bb#1750420019",
    "Date": 1750420020,
    "errors": null
}
Read more about Mangopay’s AML rule preventing fake names →
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "864a164a-cbb9-4e9d-b140-2b83c720e729",
    "Date": 1690291065.0,
    "errors": {
        "Email": "The field Email must match the regular expression '([a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*)@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?'."
    }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "31746ec8-51e6-4cd3-bf35-339b6646f3f4#1750669238",
    "Date": 1750669239,
    "errors": {
        "CountryOfResidence": "The CountryOfResidence used is blocked"
    }
}
Read more about country restrictions →
{
    "Message": "User must accept the terms and conditions before account creation or modification.",
    "Type": "user_hasnt_accepted_terms_and_conditions",
    "Id": "dbbc752b-6f9f-4248-a4bb-04ee0ba7b4b7",
    "Date": 1730810728,
    "errors": null
}  

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