Overview
User management
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
List all Users
This endpoint returns key information for each user created by the platform.
Query parameters
Start value: 1
Default value: 1
Indicates the index of the page for the pagination.
Max. value: 100
Default value: 10
Indicates the number of items returned for each page of the pagination.
Allowed values: CreationDate:ASC
, CreationDate:DESC
Indicates the direction in which to sort the list.
Responses
The list of users created by the platform.
The key information on the user created by the platform.
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
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.
Format: A valid email address
The email address of the user.
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 whoseUserCategory
isOWNER
can submit verification documents for validation. Only users whoseKYCLevel
isREGULAR
can request payouts.
Default value: false
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
.
The date and time at which the TermsAndConditionsAccepted
value was set to true
.
Returned null
if UserCategory
is PAYER
.
Default value: PAYER
Returned values: PAYER, OWNER, PLATFORM
The category of the user:
PAYER
– User who can only make pay-ins to their wallet and transfers to other wallets.OWNER
– User who can do everything a Payer can, plus receive transfers to their wallet. To request payouts, an Owner user’sKYCLevel
must beREGULAR
. For more information, see the Verification section.
Returned values: ACTIVE, CLOSED
Internal use only. This field can only be used and updated by Mangopay teams.
Was this page helpful?