The Natural User object (SCA)

Description

The Natural User object represents an individual (natural person).

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.

Changes from non-SCA object

The changes to the Natural 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 PhoneNumber and PhoneNumberCountry parameters which may be used to pre-populate the user’s phone number in the SCA session

1
{
2
    "Address": {
3
        "AddressLine1": null,
4
        "AddressLine2": null,
5
        "City": null,
6
        "Region": null,
7
        "PostalCode": null,
8
        "Country": null
9
    },
10
    "FirstName": "Alex",
11
    "LastName": "Smith",
12
    "Birthday": null,
13
    "Nationality": null,
14
    "CountryOfResidence": null,
15
    "Occupation": null,
16
    "IncomeRange": null,
17
    "ProofOfIdentity": null,
18
    "ProofOfAddress": null,
19
    "Capacity": "NORMAL",
20
    "PhoneNumber": null,
21
    "PhoneNumberCountry": null,
22
    "Id": "user_m_01JK5MJ4Q0DM6YSH7BGKBE5CDY",
23
    "Tag": "Natural User v2.01 example on non-SCA endpoint",
24
    "CreationDate": 1738577351,
25
    "PersonType": "NATURAL",
26
    "Email": "alex.smith@example.com",
27
    "KYCLevel": "LIGHT",
28
    "TermsAndConditionsAccepted": false,
29
    "TermsAndConditionsAcceptedDate": null,
30
    "UserCategory": "PAYER",
31
    "UserStatus": "ACTIVE"
32
}

Attributes

Related resources