The User object

A User can be "Natural" or "Legal". With a UserId, you are able to:

  • Fetch a user and get their details
  • List all the wallets of a user
  • Get all your users in a list

Due to anti-money laundering policy, we don’t accept the creation of users residing in some countries. Please refer to the Restrictions by country documentation for more information.

Parameters

PersonType
PersonType

PersonType:

NATURAL, LEGAL

Type of user

Email
string

string:

Maximum length is 255 characters

The person's email address (not more than 12 consecutive numbers) - must be a valid email

KYCLevel
KYCLevel

KYCLevel:

LIGHT, REGULAR

Indicates whether or not the user is KYC validated. Please refer to the User verification article for more information.

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

CreationDate
timestamp

timestamp

When the item was created

Id
string

string:

Maximum length is 255 characters

The item's ID

The User object will also include further parameters depending on the "PersonType" (see below).

{
"PersonType": "NATURAL",
"Email": "support@mangopay.com",
"KYCLevel": "REGULAR",
"Tag": "This is a tag",
"CreationDate": 12926321,
"Id": "8494514"
}

The Natural User object

A Natural User is a person whereas a legal user represents a business or an organisation.

Depending on the UserCategory parameter, users can perform a variety of actions.

User category Possible actions
“Payer”
  • Process payments (pay-ins)
  • Transfer e-money from their e-wallet to another (to another user (owner) or to themselves)
  • Create wallets, etc.
“Owner” (not KYC validated) Everything a payer can do and:
  • Receive transfers from another user to their e-wallet
Please note that actions specific to owners require the TermsAndConditionsAccepted parameter to be set to “true”.
“Owner” (KYC validated) Everything a not KYC validated owner can do and:
  • Withdraw money from their wallet to their bank account
Please note that actions specific to owners require the TermsAndConditionsAccepted parameter to be set to “true”.

Please refer to the KYC Limits article to find out more about procedures and verification levels.

E-Money Issuer (EMi) platforms can only create users whose UserCategory is “Owner” because in this specific case, all users receive a payment service.

Parameters

FirstName
string

string:

Maximum length is 100 characters

The name of the user

LastName
string

string:

Maximum length is 100 characters

The last name of the user

Address
Address

Address:

View Sub-parameters

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Address.City
string

string:

Maximum length is 255 characters

The city of the address

Address.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

Address.PostalCode
string

string:

Maximum length is 50 characters

The postal code of the address - can be alphanumeric, dashes or spaces

Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

Birthday
timestamp

timestamp

The date of birth of the user – make sure to set the right timezone (UTC) to avoid midnight becoming 11 p.m (and hence interpreted as the day before)

Nationality
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters

User’s occupation, ie. Work

IncomeRange
int

int

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

ProofOfAddress
string

string:

Maximum length is 255 characters

ProofOfIdentity
string

string:

Maximum length is 255 characters

TermsAndConditionsAccepted
bool

bool:

true, false

Whether or not the user has accepted the MANGOPAY Terms and Conditions.

TermsAndConditionsAcceptedDate
timestamp

timestamp

The date on which the user has accepted the MANGOPAY Terms and Conditions.

{
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"ProofOfAddress": "752nsyuTAns9",
"ProofOfIdentity": "jsg9h628Nsuha",
"TermsAndConditionsAccepted": false,
"TermsAndConditionsAcceptedDate": 1463494366
}

Create a Natural User (Payer)

Please note that the Birthday field is a timestamp, so you need to make sure that the timezone is set to UTC. If not, midnight local time could be interpreted as 11 p.m. UTC (hence the day before), which would create a gap with declarative data and result in the refusal of KYC validation.

POST .../v2.01/ClientId

The ID of your client account

/users/natural/

Parameters

FirstName
string

string:

Maximum length is 100 characters

required

The name of the user

LastName
string

string:

Maximum length is 100 characters

required

The last name of the user

Email
string

string:

Maximum length is 255 characters

required

The person's email address (not more than 12 consecutive numbers) - must be a valid email

Address
Address

Address:

View Sub-parameters

optional

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

UserCategory
UserCategory

UserCategory:

Payer, Owner

required

Category of the user. May take one of the following values:

  • Payer: Users who only use MANGOPAY to give money to other users (i.e., only pay).
  • Owner: Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts.

While the parameter is indicated as “required”, please note it remains technically optional for a few months for existing platforms so that they have time to adapt.

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

TermsAndConditionsAccepted
bool

bool:

true, false

optional

Whether or not the user has accepted the MANGOPAY Terms and Conditions.

  • View
  • Code
  • Run
  • View
  • Code
  • Run
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"FirstName": "Joe",
"LastName": "Blogs",
"Email": "support@mangopay.com",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"UserCategory": "Payer",
"Tag": "custom meta",
"TermsAndConditionsAccepted": false
}
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"FirstName": "",
"LastName": "",
"Email": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"UserCategory": "",
"Tag": "",
"TermsAndConditionsAccepted": ""
}

Create a Natural User (Owner)

Please note that the Birthday field is a timestamp, so you need to make sure that the timezone is set to UTC. If not, midnight local time could be interpreted as 11 p.m. UTC (hence the day before), which would create a gap with declarative data and result in the refusal of KYC validation.

POST .../v2.01/ClientId

The ID of your client account

/users/natural/

Parameters

FirstName
string

string:

Maximum length is 100 characters

required

The name of the user

LastName
string

string:

Maximum length is 100 characters

required

The last name of the user

Email
string

string:

Maximum length is 255 characters

required

The person's email address (not more than 12 consecutive numbers) - must be a valid email

Address
Address

Address:

View Sub-parameters

optional

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

Birthday
timestamp

timestamp

required

The date of birth of the user – make sure to set the right timezone (UTC) to avoid midnight becoming 11 p.m (and hence interpreted as the day before)

Nationality
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters

optional

User’s occupation, ie. Work

IncomeRange
int

int

optional

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

TermsAndConditionsAccepted
bool

bool:

true, false

required

Whether or not the user has accepted the MANGOPAY Terms and Conditions.

UserCategory
UserCategory

UserCategory:

Payer, Owner

required

Category of the user. May take one of the following values:

  • Payer: Users who only use MANGOPAY to give money to other users (i.e., only pay).
  • Owner: Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts.

While the parameter is indicated as “required”, please note it remains technically optional for a few months for existing platforms so that they have time to adapt.

  • View
  • Code
  • Run
  • View
  • Code
  • Run
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"FirstName": "Joe",
"LastName": "Blogs",
"Email": "support@mangopay.com",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"Tag": "custom meta",
"TermsAndConditionsAccepted": false,
"UserCategory": "Owner"
}
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"FirstName": "",
"LastName": "",
"Email": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"Birthday": ,
"Nationality": "",
"CountryOfResidence": "",
"Occupation": "",
"IncomeRange": ,
"Tag": "",
"TermsAndConditionsAccepted": "",
"UserCategory": ""
}

Update a Natural User

Please note that some parameters listed below might not be relevant depending on the UserCategory.

PUT .../v2.01/ClientId

The ID of your client account

/users/natural/UserId

A Mangopay user's ID

/

Parameters

FirstName
string

string:

Maximum length is 100 characters

optional

The name of the user

LastName
string

string:

Maximum length is 100 characters

optional

The last name of the user

Address
Address

Address:

View Sub-parameters

optional

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

Address.City
string

string:

Maximum length is 255 characters

required

The city of the address

Address.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

Address.PostalCode
string

string:

Maximum length is 50 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

Address.Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

required

The Country of the Address

Birthday
timestamp

timestamp

optional

The date of birth of the user – make sure to set the right timezone (UTC) to avoid midnight becoming 11 p.m (and hence interpreted as the day before)

Nationality
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

optional

The user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

optional

The user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters

optional

User’s occupation, ie. Work

IncomeRange
int

int

optional

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

Email
string

string:

Maximum length is 255 characters

optional

The person's email address (not more than 12 consecutive numbers) - must be a valid email

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

TermsAndConditionsAccepted
bool

bool:

true, false

optional

Whether or not the user has accepted the MANGOPAY Terms and Conditions.

UserCategory
UserCategory

UserCategory:

Payer, Owner

optional

Category of the user. May take one of the following values:

  • Payer: Users who only use MANGOPAY to give money to other users (i.e., only pay).
  • Owner: Users who use MANGOPAY to receive funds. Please note that a user needs to be KYC validated to perform payouts.

While the parameter is indicated as “required”, please note it remains technically optional for a few months for existing platforms so that they have time to adapt.

  • View
  • Code
  • Run
  • View
  • Code
  • Run
PUT .../users/natural/:UserId/ HTTP/1.1
Body Parameters :
{
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"Email": "support@mangopay.com",
"Tag": "custom meta",
"TermsAndConditionsAccepted": false,
"UserCategory": "Owner"
}
PUT .../users/natural// HTTP/1.1
Body Parameters :
{
"FirstName": "",
"LastName": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"Birthday": ,
"Nationality": "",
"CountryOfResidence": "",
"Occupation": "",
"IncomeRange": ,
"Email": "",
"Tag": "",
"TermsAndConditionsAccepted": "",
"UserCategory": ""
}

View a User

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/
  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../users/:UserId/ HTTP/1.1
GET .../users// HTTP/1.1

List all Users

GET .../v2.01/ClientId

The ID of your client account

/users/
  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../users/ HTTP/1.1
GET .../users/ HTTP/1.1
Share feedback
Live chat
No agent is free at the moment please send us a request through our contact form