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
View a User
Path parameters
The unique identifier of the user.
Responses
The postal address of the user.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Max. length: 100 characters
The first name of the individual.
Max. length: 100 characters
The last name of the individual.
Returned null if UserCategory is PAYER.
The date of birth of the individual.
Note: Ensure this Unix timestamp accounts for your timezone to avoid midnight being interpreted as the day before.
Returned null if UserCategory is PAYER.
The nationality of the individual.
Returned null if UserCategory is PAYER.
The country of residence of the individual.
Max. length: 255 characters
The occupation of the individual.
Returned null if UserCategory is PAYER.
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
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.
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.
This is a deprecated parameter.
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 whoseUserCategoryisOWNERcan submit verification documents for validation. Only users whoseKYCLevelisREGULARcan 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’sKYCLevelmust 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.
The legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
The address of the entity’s legal representative.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Returned values: Two-letter country code (ISO 3166-1 alpha-2 format).
The country of the address.
Max. length: 255 characters
The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.
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.
Max. length: 100 characters
The first name of the entity’s legal representative.
Max. length: 100 characters
The last name of the entity’s legal representative.
Format: A valid email address
The email address of the entity’s legal representative.
Returned null if UserCategory is PAYER.
The date of birth of the entity’s legal representative.
Returned null if UserCategory is PAYER.
Note: Ensure this Unix timestamp accounts for your timezone to avoid midnight being interpreted as the day before.
Returned null if UserCategory is PAYER.
The nationality of the entity’s legal representative.
Returned null if UserCategory is PAYER.
The country of residence of the entity’s legal representative.
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.
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.
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.
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.
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.
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 for the entity.
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 whoseUserCategoryisOWNERcan submit verification documents for validation. Only users whoseKYCLevelisREGULARcan 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’sKYCLevelmust 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?