Overview
User management
- The Natural User object (SCA)
- POSTCreate a Natural User (SCA)
- PUTUpdate a Natural User (SCA)
- PUTCategorize a Natural User
- The Legal User object (SCA)
- POSTCreate a Legal User (SCA)
- PUTUpdate a Legal User (SCA)
- PUTCategorize a Legal User
- POSTEnroll a User in SCA
- POSTManage proxy consent for a User
- GETView a User (SCA)
- GETList all Users
- DELClose a Natural User
- DELClose a Legal User
User verification
Wallets
Cards
Card pay-ins
Banking pay-ins
APM pay-ins
Transfers
Refunds
Disputes
Payouts
FX conversions
Transactions
Echo
Helpers
Platform account
Copy
// GET has no body parameters
Copy
[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "[email protected]",
"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 protected]",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "[email protected]",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
Users
List all Users
List User objects and key details
GET
/
v2.01
/
{ClientId}
/
users
Copy
// GET has no body parameters
Copy
[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "[email protected]",
"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 protected]",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "[email protected]",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
This endpoint returns key information for each user created by the platform.
Query parameters
Start value:
1Default value: 1Indicates the index of the page for the pagination.Min. value:
1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.Possible values:
CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:ASCIndicates the direction in which to sort the list.Responses
200
200
The list of users created by the platform.
Show properties
Show properties
The key information on the user created by the platform.
Show properties
Show properties
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom data that you can add to this object.
The date and time at which the object was created.
Returned values: NATURAL, LEGALThe 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.
PersonType is defined by the endpoint used to create the user and can’t be modified.Format: A valid email addressThe email address of the user.
Default value:
LIGHTReturned values: LIGHT, REGULARThe 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 whoseUserCategoryisOWNERcan submit verification documents for validation. Only users whoseKYCLevelisREGULARcan request payouts.
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.Possible values:
PAYER, OWNER, PLATFORMThe 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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
Returned values: ACTIVE, CLOSEDInternal use only. This field can only be used and updated by Mangopay teams.
Copy
[
{
"Id": "158026537",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670863988,
"PersonType": "LEGAL",
"Email": "[email protected]",
"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 protected]",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670862022,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
},
{
"Id": "158026721",
"Tag": "Created using MANGOPAY API Collection Postman",
"CreationDate": 1670864174,
"PersonType": "LEGAL",
"Email": "[email protected]",
"KYCLevel": "REGULAR",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1670864174,
"UserCategory": "OWNER",
"UserStatus": "ACTIVE"
}
]
Copy
// GET has no body parameters
Was this page helpful?
⌘I