Register a Legal Payer or Owner (with SCA enrollment)
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.The RedirectUrl
is currently only returned if LegalPersonType
is SOLETRADER
, but the endpoint should be integrated for the other types.HeadquartersAddress.Country
LegalRepresentative.Nationality
LegalRepresentative.CountryOfResidence
LegalRepresentativeAddress.Country
Name
value should be the one registered with the relevant national authority.LegalPersonType
to use for a particular local legal structure, see the verification requirements.Caution: Modification of the LegalPersonType
may result in a verification downgrade.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.UserCategory
is OWNER
. Child parameters returned null
if UserCategory
is PAYER
.The legally registered address of the entity’s administrative center.true
if UserCategory
is OWNER
.PAYER
, OWNER
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.200
Name
value should be the one registered with the relevant national authority.LegalPersonType
to use for a particular local legal structure, see the verification requirements.Caution: Modification of the LegalPersonType
may result in a verification downgrade.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
.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
.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
.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.null
).null
if the UserCategory
is PAYER
.NATURAL
– Natural users are individuals (natural persons).LEGAL
– Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.PersonType
is defined by the endpoint used to create the user and can’t be modified.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.true
if UserCategory
is OWNER
.TermsAndConditionsAccepted
value was set to true
.Returned null
if UserCategory
is PAYER
.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.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 - First name or last name identified as fake
400 - Restricted country
400 - Invalid email
400 - LegalRepresentative.Email required if OWNER
403 - TermsAndConditionsAccepted must be true if OWNER