Update a Legal User (SCA)
Modify details for a Legal Payer or Owner without changing category
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:
LegalRepresentative.EmailLegalRepresentative.PhoneNumberLegalRepresentative.PhoneNumberCountry
The RedirectUrl is currently only returned if LegalPersonType is SOLETRADER, but the endpoint should be integrated for the other types.
Caution – Modification may cause KYC/B verification downgrade
If KYCLevel is REGULAR, modifying the following values triggers a verification downgrade to LIGHT:
LegalRepresentative.FirstNameLegalRepresentative.LastNameLegalRepresentative.BirthdayLegalRepresentative.NationalityLegalPersonType
Note – Country-based restrictions apply to users
Due to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
HeadquartersAddress.CountryLegalRepresentative.NationalityLegalRepresentative.CountryOfResidenceLegalRepresentativeAddress.Country
Body parameters
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.
Max. length: 255 characters
The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
Allowed 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.
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.
Required if UserCategory is OWNER. Child parameters returned null if UserCategory is PAYER.
The legally registered address of the entity’s administrative center.
The address of the entity’s legal representative.
Max. length: 255 characters
Custom data that you can add to this object.
Format: A valid email address
The email address for the entity.
Responses
200
200
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.
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 legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.
The address of the entity’s legal representative.
Max length: 128 characters (see data formats for details)
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.
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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
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.
400 - First name or last name identified as fake
400 - First name or last name identified as fake
Read more about Mangopay’s AML rule preventing fake names →
400 - Invalid email
400 - Invalid email
400 - Restricted country
400 - Restricted country
Read more about country restrictions →
Update a Legal User (SCA)
Modify details for a Legal Payer or Owner without changing category
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:
LegalRepresentative.EmailLegalRepresentative.PhoneNumberLegalRepresentative.PhoneNumberCountry
The RedirectUrl is currently only returned if LegalPersonType is SOLETRADER, but the endpoint should be integrated for the other types.
Caution – Modification may cause KYC/B verification downgrade
If KYCLevel is REGULAR, modifying the following values triggers a verification downgrade to LIGHT:
LegalRepresentative.FirstNameLegalRepresentative.LastNameLegalRepresentative.BirthdayLegalRepresentative.NationalityLegalPersonType
Note – Country-based restrictions apply to users
Due to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
HeadquartersAddress.CountryLegalRepresentative.NationalityLegalRepresentative.CountryOfResidenceLegalRepresentativeAddress.Country
Body parameters
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.
Max. length: 255 characters
The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
Allowed 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.
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.
Required if UserCategory is OWNER. Child parameters returned null if UserCategory is PAYER.
The legally registered address of the entity’s administrative center.
The address of the entity’s legal representative.
Max. length: 255 characters
Custom data that you can add to this object.
Format: A valid email address
The email address for the entity.
Responses
200
200
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.
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 legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.
The address of the entity’s legal representative.
Max length: 128 characters (see data formats for details)
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.
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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
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.
400 - First name or last name identified as fake
400 - First name or last name identified as fake
Read more about Mangopay’s AML rule preventing fake names →
400 - Invalid email
400 - Invalid email
400 - Restricted country
400 - Restricted country
Read more about country restrictions →