View a User (SCA)

GET

/v2.01/:ClientId/sca/users/:UserId

GET

/v2.01/:ClientId/sca/users/:UserId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/sca/users/{UserId} \
>      -H "Authorization: Bearer <token>"

1 {
2   "Address": {
3     "AddressLine1": "3 rue de la Cité",
4     "AddressLine2": "Appartement 7",
5     "City": "Paris",
6     "Country": "FR",
7     "PostalCode": "75004",
8     "Region": "Ile-de-France"
9   },
10   "Birthday": null,
11   "Capacity": "NORMAL",
12   "CountryOfResidence": null,
13   "CreationDate": 1734339135,
14   "Email": "alex.smith@example.com",
15   "FirstName": "Ruby",
16   "Id": "user_m_01JF7AP1M46TR0JH7WBGPWK7D7",
17   "IncomeRange": null,
18   "KYCLevel": "LIGHT",
19   "LastName": "Reinger",
20   "Nationality": null,
21   "Occupation": null,
22   "PendingUserAction": null,
23   "PersonType": "NATURAL",
24   "PhoneNumber": null,
25   "PhoneNumberCountry": null,
26   "ProofOfAddress": null,
27   "ProofOfIdentity": null,
28   "Tag": "Created using the Mangopay API Postman collection",
29   "TermsAndConditionsAccepted": false,
30   "TermsAndConditionsAcceptedDate": null,
31   "UserCategory": "PAYER",
32   "UserStatus": "ACTIVE"
33 }

Retrieve a Natural or Legal User.

This endpoint returns the same data as the legacy GET View a User, including the new PENDING_USER_ACTION value for UserStatus, with two minor changes:

The PendingUserAction field, which is always null on this endpoint
For Legal users, the LegalRepresentative object, which contains the data for the legal representative

Note – RedirectUrl not available on this endpoint

The RedirectUrl is only returned on API calls that trigger SCA.

To obtain a new session link for an Owner, call the POST Enroll a User in SCA endpoint.

Retrieve a Natural or Legal User. This endpoint returns the same data as the legacy [GET View a User](/api-reference/users/view-user), including the new `PENDING_USER_ACTION` value for `UserStatus`, with two minor changes: - The `PendingUserAction` field, which is always `null` on this endpoint - For Legal users, the `LegalRepresentative` object, which contains the data for the legal representative <Note icon="fa-regular fa-circle-info"> **Note – `RedirectUrl` not available on this endpoint** The `RedirectUrl` is only returned on API calls that trigger SCA. To obtain a new session link for an Owner, call the [POST Enroll a User in SCA](/api-reference/users/enroll-user) endpoint. </Note> [Read more](/guides/sca/users#view-and-list-users) **→**

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

UserIdstringRequired

The unique identifier of the user.

Response

Success

Natural Userobject

Response body for a Natural User. The same schema is returned for PAYER and OWNER users.

If UserCategory is PAYER, the following are returned null:

Birthday
Nationality
CountryOfResidence
Occupation
IncomeRange
TermsAndConditionsAcceptedDate

Legal Userobject

Response body for a Legal User. The same schema is returned for PAYER and OWNER users.

If UserCategory is PAYER, the following are returned null:

LegalRepresentative.Birthday
LegalRepresentative.Nationality
LegalRepresentative.CountryOfResidence
LegalRepresentative.Email
All HeadquartersAddress sub-properties
CompanyNumber
TermsAndConditionsAcceptedDate