// GET has no body parameters
[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "richard.moulin@email.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": false,
"TermsAndConditionsAcceptedDate": null,
"UserCategory": "PAYER",
"UserStatus": "ACTIVE"
},
{
"Id": "158025445",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670862022,
"PersonType": "NATURAL",
"Email": "email@test.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "cortney_douglas@yahoo.com",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
List User objects and key details
// GET has no body parameters
[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "richard.moulin@email.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": false,
"TermsAndConditionsAcceptedDate": null,
"UserCategory": "PAYER",
"UserStatus": "ACTIVE"
},
{
"Id": "158025445",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670862022,
"PersonType": "NATURAL",
"Email": "email@test.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "cortney_douglas@yahoo.com",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
1
Default value: 1
Indicates the index of the page for the pagination.1
; max. value: 100
Default value: 10
Indicates the number of items returned for each page of the pagination.CreationDate:ASC
, CreationDate:DESC
Indicates the direction in which to sort the list.200
Show properties
Show properties
NATURAL
– Natural users are individuals (natural persons).LEGAL
– Legal users are legal entities (legal persons) like companies, non-profits, and sole proprietors.PersonType
is defined by the endpoint used to create the user and can’t be modified.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.true
if UserCategory
is OWNER
.TermsAndConditionsAccepted
value was set to true
.Returned null
if UserCategory
is PAYER
.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.[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "richard.moulin@email.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": false,
"TermsAndConditionsAcceptedDate": null,
"UserCategory": "PAYER",
"UserStatus": "ACTIVE"
},
{
"Id": "158025445",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670862022,
"PersonType": "NATURAL",
"Email": "email@test.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "cortney_douglas@yahoo.com",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
// GET has no body parameters
Was this page helpful?