Register a Natural 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.Nationality
CountryOfResidence
Address.Country
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.UserCategory
is OWNER
. Returned null
if UserCategory
is PAYER
.The nationality of the individual.UserCategory
is OWNER
. Returned null
if UserCategory
is PAYER
.The country of residence of the individual.null
if UserCategory
is PAYER
.The occupation of the individual.1
, 2
, 3
, 4
, 5
, 6
, null
Returned null
if UserCategory
is PAYER
.The bracket indicating the income of the individual. The brackets are: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.PhoneNumber
is provided in local format (recommended), to render the value in the E.164 standard.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
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.null
if UserCategory
is PAYER
.The nationality of the individual.null
if UserCategory
is PAYER
.The country of residence of the individual.null
if UserCategory
is PAYER
.null
if UserCategory
is PAYER
.The bracket indicating the income of the individual. The brackets are: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
.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
.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.PhoneNumber
is provided in local format (recommended), to render the value in the E.164 standard.null
).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 - Invalid email
400 - Restricted country
403 - TermsAndConditionsAccepted must be true if OWNER