PUT
/
v2.01
/
{ClientId}
/
sca
/
users
/
natural
/
{UserId}
/
category
{
    "UserCategory": "OWNER",
    "TermsAndConditionsAccepted": true,
    // "Email": "alex.smith@example.com",
    // "PhoneNumber": "0611111111",
    // "PhoneNumberCountry": "FR",
    "Birthday": 652117514,
    "Nationality": "FR",
    "CountryOfResidence": "FR"
}

{
    "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": "alex.smith@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": true,
    "TermsAndConditionsAcceptedDate": null,
    "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 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 users

Due 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: OWNER

The new category of the user, which must be OWNER.

​
TermsAndConditionsAccepted
boolean
required

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

​
Email
string

Format: A valid email address

The individual’s email address.

​
Birthday
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 (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.

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

​
Responses

{
    "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": "alex.smith@example.com",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": true,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "OWNER",
    "UserStatus": "PENDING_USER_ACTION"
}

{
    "UserCategory": "OWNER",
    "TermsAndConditionsAccepted": true,
    // "Email": "alex.smith@example.com",
    // "PhoneNumber": "0611111111",
    // "PhoneNumberCountry": "FR",
    "Birthday": 652117514,
    "Nationality": "FR",
    "CountryOfResidence": "FR"
}

Was this page helpful?

Update a Natural User (SCA)The Legal User object (SCA)