Update a Natural User (SCA)

Modify details for a Natural Payer or Owner without changing category

PUT /v2.01/{ClientId}/sca/users/natural/{UserId}

REST - Payer

{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}

REST - Payer

{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Birthday": null,
    "Nationality": null,
    "CountryOfResidence": null,
    "Occupation": null,
    "IncomeRange": null,
    "ProofOfIdentity": null,
    "ProofOfAddress": null,
    "Capacity": "NORMAL",
    "PhoneNumber": null,
    "PhoneNumberCountry": null,
    "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": "New tag",
    "CreationDate": 1734339135,
    "PersonType": "NATURAL",
    "Email": "[e-mail]",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}

Caution – Modification may trigger SCA re-enrollment

If UserCategory is OWNER, modifying the following values changes UserStatus to PENDING_USER_ACTION and requires re-enrollment in SCA using the returned PendingUserAction.RedirectUrl:

• Email
• PhoneNumber
• PhoneNumberCountry

In Sandbox, you can bypass SCA by including the word accept in the Natural User’s Email – for example [e-mail] or [e-mail].

Caution – Modification may cause KYC/B verification downgrade

If KYCLevel is REGULAR, modifying the following values triggers a verification downgrade to LIGHT:

• FirstName
• LastName
• Birthday
• Nationality

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
• Address.Country

Body parameters

ScaContext · string

Possible values: USER_PRESENT, USER_NOT_PRESENT

Default value: USER_PRESENT

The SCA context of the request, which is required if the user’s UserCategory is OWNER:

• USER_PRESENT – The user is taking the SCA-triggering action of updating account information and must re-enroll in SCA . 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 is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then USER_NOT_PRESENT returns a 403 error.

Read more about managing proxy and user consent →

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.

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.

FirstName · string

Min. length: 1; max. length: 100

The first name of the individual.

LastName · string

Min. length: 1; max. length: 100

The 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 characters

Returned null if UserCategory is PAYER.

The occupation of the individual.

IncomeRange · integer

Allowed values: 1, 2, 3, 4, 5, 6, null

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

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

Email · string

Format: A valid email address

The individual’s email address.

Caution: If UserCategory is OWNER, modifying this value means the user will be required to re-enroll the new value in SCA via the PendingUserAction.RedirectUrl. For more details see the SCA guides.

PhoneNumber · string

Format: International E.164 standard (preceded 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.

Address · object

The postal address of the user.

Show properties

AddressLine1 · string · required

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string · required

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string · required

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string · required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

Responses

200

FirstName · string

Min. length: 1; max. length: 100

The first name of the individual.

LastName · string

Min. length: 1; max. length: 100

The 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 characters

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

Address · object

The postal address of the user.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

PendingUserAction · object

Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).

Hide properties

RedirectUrl · string

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.

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom 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, 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.

Email · string

Format: A valid email address

The individual’s email address.

KYCLevel · string

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 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, PLATFORM

The 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, CLOSED

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

400 - Data doesn't comply with anti-fraud policy

{
    "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 rules on user data →

400 - Invalid email

{
    "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])?'."
    }
}  

400 - Restricted country

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

403 - TermsAndConditionsAccepted must be true if OWNER

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

403 - Consent not given for proxy when USER_NOT_PRESENT sent

403 - Forbidden

{
    "Message": "You are not authorized to perform this action. The user has not provided consent to the requested proxy",
    "Type": "sca_proxy_missing",
    "Id": "bbf56cc0-079d-44fd-9e23-53bdb3e283e5#1762177336",
    "Date": 1762177337,
    "errors": null
}

The 403 error above occurs when your platform has proxy management activated and sends USER_NOT_PRESENT for ScaContext with new values for Email, PhoneNumber or PhoneNumberCountry, but the user has not given (or has revoked) their consent for your platform to update SCA contact information in their absence.

There are two ways to resolve this:

1. Ask the user to consent to your use of USER_NOT_PRESENT for this action by ticking the checkbox returned on the POST Manage proxy consent for a User endpoint
2. Send the API call to update SCA contact information again but with ScaContext set to USER_PRESENT, and redirect the user to authenticate the action

400 - Birthday can't indicate an age older than 120 years

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "741b5be7-a34c-4fd4-abb5-75b23d0b1cec",
    "Date": 1776242161.0,
    "errors": {
        "Birthday": "The Birthday value indicates an age over 120 years, which is not allowed."
    }
}

REST - Payer

{
    "FirstName": "Alex",
    "LastName": "Smith",
    "Birthday": null,
    "Nationality": null,
    "CountryOfResidence": null,
    "Occupation": null,
    "IncomeRange": null,
    "ProofOfIdentity": null,
    "ProofOfAddress": null,
    "Capacity": "NORMAL",
    "PhoneNumber": null,
    "PhoneNumberCountry": null,
    "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": "New tag",
    "CreationDate": 1734339135,
    "PersonType": "NATURAL",
    "Email": "[e-mail]",
    "KYCLevel": "LIGHT",
    "TermsAndConditionsAccepted": false,
    "TermsAndConditionsAcceptedDate": null,
    "UserCategory": "PAYER",
    "UserStatus": "ACTIVE"
}

REST - Payer

{
    "UserCategory": "PAYER",
    "TermsAndConditionsAccepted": false,
    "Tag": "New tag"
}