User managementUsers

The Legal User object (SCA)

Description

The Legal User object represents a legal entity (legal person) like a company, non-profit or sole proprietor (read more about user types).

Mangopay users have one of two categories, indicated by UserCategory:

  • PAYER – User who can only make pay-ins to their wallets and transfers to other wallets.
  • 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.

To enable OWNER users to enroll in SCA, Mangopay released new versions of the user objects and new endpoints.

Guides

Read more about SCA on Owner users

Changes from non-SCA object

The changes to the Legal User object are:

  • New UserStatus value PENDING_USER_ACTION indicating that the user must enroll in SCA
  • New response parameter PendingUserAction.RedirectUrl containing the SCA session URL to which the individual must be redirected (after adding an encoded returnUrl query parameter)
  • New LegalRepresentative object to group parameters related to the declared legal representative. This object includes the new LegalRepresentative.PhoneNumber and LegalRepresentative.PhoneNumberCountry, which may be used to pre-populate the user’s phone number in the SCA session

Caution – Legal representative’s email required

For OWNER users, the LegalRepresentative.Email address is required.

SCA uses this email address to build a behavioral biometrics profile and as a backup communication channel.

Prior to SCA, it was possible to create a Legal OWNER without the LegalRepresentativeEmail, so this data may be missing. Calling the POST Enroll a User in SCA endpoint without this data will return an error.

1{
2    "HeadquartersAddress": {
3        "AddressLine1": null,
4        "AddressLine2": null,
5        "City": null,
6        "Region": null,
7        "PostalCode": null,
8        "Country": null
9    },
10    "LegalRepresentativeAddress": {
11        "AddressLine1": null,
12        "AddressLine2": null,
13        "City": null,
14        "Region": null,
15        "PostalCode": null,
16        "Country": null
17    },
18    "Name": "Best Business",
19    "LegalPersonType": "BUSINESS",
20    "LegalRepresentativeFirstName": "Alex",
21    "LegalRepresentativeLastName": "Smith",
22    "LegalRepresentativeEmail": null,
23    "LegalRepresentativeBirthday": null,
24    "LegalRepresentativeNationality": null,
25    "LegalRepresentativeCountryOfResidence": null,
26    "ProofOfRegistration": null,
27    "ShareholderDeclaration": null,
28    "Statute": null,
29    "LegalRepresentativeProofOfIdentity": null,
30    "CompanyNumber": null,
31    "PhoneNumber": null,
32    "PhoneNumberCountry": null,
33    "Id": "user_m_01JHX3FQ7K0WB275T1BZ1SPZMF",
34    "Tag": "Legal User v2.01 example",
35    "CreationDate": 1737217268,
36    "PersonType": "LEGAL",
37    "Email": "best.business@example.com",
38    "KYCLevel": "LIGHT",
39    "TermsAndConditionsAccepted": false,
40    "TermsAndConditionsAcceptedDate": null,
41    "UserCategory": "PAYER",
42    "UserStatus": "ACTIVE"
43}

Attributes

NamestringOptional
LegalPersonTypestringOptional
LegalRepresentativeobjectOptional
Information about the legal representative declared for the user.
ProofOfRegistrationstring or nullOptional
ShareholderDeclarationstring or nullOptional
Statutestring or nullOptional
CompanyNumberstring or nullOptional
PendingUserActionobject or nullOptional
HeadquartersAddressobjectOptional
LegalRepresentativeAddressobjectOptional
IdstringOptional
TagstringOptional
CreationDateintegerOptional
PersonTypestringOptional
EmailstringOptional
KYCLevelstringOptional
TermsAndConditionsAcceptedbooleanOptional
TermsAndConditionsAcceptedDateinteger or nullOptional
UserCategorystringOptional
UserStatusstringOptional
Guide

Users – Categories

Guide

Owner SCA