View a User

Deprecated

GET

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

GET

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

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

1 {
2   "Address": {
3     "AddressLine1": "3 rue des Plantes",
4     "AddressLine2": "Appartement 7",
5     "City": "Paris",
6     "Region": "Île-de-France",
7     "PostalCode": "75001",
8     "Country": "FR"
9   },
10   "FirstName": "Sophia",
11   "LastName": "Garnier",
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   "Id": "user_m_01J87ZBSP8FCVDSCB8PGWQHZPF",
21   "Tag": "Created using MANGOPAY API Collection Postman",
22   "CreationDate": 1670861981,
23   "PersonType": "NATURAL",
24   "Email": "sophia.garnier@test.com",
25   "KYCLevel": "LIGHT",
26   "TermsAndConditionsAccepted": false,
27   "TermsAndConditionsAcceptedDate": null,
28   "UserCategory": "PAYER",
29   "UserStatus": "ACTIVE"
30 }

Caution - Deprecated endpoint

The legacy User endpoints are deprecated. This endpoint will stop working and return an error after Dec 15, 2025.

These endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA.

Instead of calling this endpoint to retrieve key details of a user, your platform must call the GET View a User (SCA) endpoint.

View a User

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution - Deprecated endpoint** The legacy User endpoints are deprecated. This endpoint will stop working and return an error after **Dec 15, 2025**. These endpoints were made redundant by the equivalent SCA-enabled endpoints during the introduction of SCA. Instead of calling this endpoint to retrieve key details of a user, your platform must call the [GET View a User (SCA)](/api-reference/users/view-user-sca) endpoint. </Warning> View a User

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

Addressobject

The postal address.

FirstNamestring

Min. length: 1; max. length: 100

The first name of the individual.

LastNamestring

Min. length: 1; max. length: 100

The last name of the individual.

Birthdayinteger

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.

Nationalitystring

Returned null if UserCategory is PAYER.

The nationality of the individual.

CountryOfResidencestring

Returned null if UserCategory is PAYER.

The country of residence of the individual.

Occupationstring

Max. length: 255 characters

The occupation of the individual. Returned null if UserCategory is PAYER.

IncomeRangeinteger

Returned null if UserCategory is PAYER.

The bracket indicating the income of the individual. The brackets are:

1: < 18K
2: 18K - 30K
3: 30K - 50K
4: 50K - 80K
5: 80K - 120K
6: > 120K

ProofOfIdentitystring

The 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.

ProofOfAddressstring

The 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.

Capacitystring

This is a deprecated parameter.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

PersonTypestring

Returned values: NATURAL, LEGAL

The type of the user:

NATURAL – Natural users are individuals (natural persons).
LEGAL – Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.

The PersonType is defined by the endpoint used to create the user and can’t be modified.

Emailstring

The email address for the entity.

KYCLevelstring

Default value: 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.

TermsAndConditionsAcceptedboolean

Whether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).

Must be true if UserCategory is OWNER.

TermsAndConditionsAcceptedDateinteger

Unix timestamp (UTC) of the date and time the TermsAndConditionsAccepted value was set to true.

Returned null if UserCategory is PAYER.

UserCategorystring

Possible values: 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.

UserStatusstring

Returned values: ACTIVE, CLOSED

Internal use only. This field can only be used and updated by Mangopay teams.

HeadquartersAddressobject

The postal address.

LegalRepresentativeAddressobject

The postal address.

Namestring

Max. length: 255 characters

The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.

LegalPersonTypestring

Returned values: BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADER

The type of legal user. For information on which LegalPersonType to use for a particular local legal structure, see the verification requirements.

Caution: Modification of the LegalPersonType may result in a verification downgrade.

LegalRepresentativeFirstNamestring

Min. length: 1; max. length: 100

The first name of the entity’s legal representative.

LegalRepresentativeLastNamestring

Min. length: 1; max. length: 100

The last name of the entity’s legal representative.

LegalRepresentativeEmailstring

Format: A valid email address

The email address of the entity’s legal representative. Returned null if UserCategory is PAYER.

LegalRepresentativeBirthdayinteger

The date of birth of the entity’s legal representative.

Returned null if UserCategory is PAYER.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

LegalRepresentativeNationalitystring

Returned null if UserCategory is PAYER.

The nationality of the entity’s legal representative.

LegalRepresentativeCountryOfResidencestring

Returned null if UserCategory is PAYER.

The country of residence of the entity’s legal representative.

ProofOfRegistrationstring

The 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.

ShareholderDeclarationstring

The 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.

Statutestring

The 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.

LegalRepresentativeProofOfIdentitystring

The 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.

CompanyNumberstring

Required if 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.