View a User (SCA)

Min. length: 1; max. length: 100

The first name of the individual.

Min. length: 1; max. length: 100

The last name of the individual.

Returned null if UserCategory is PAYER.

The date of birth of the individual.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC 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.

Format: International E.164 standard (prefixed by plus sign and country code) or local format

The individual’s phone number. The local format (recommended) requires PhoneNumberCountry to ensure correct formatting.

If present, the phone number forms part of card transaction data that is passed to issuers to improve authentication rates.

For users with UserCategory OWNER , the phone number is used to pre-populate the SCA session for them to confirm and receive an SMS OTP. If the individual modifies the phone number during the session, this data is not updated in the API.

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

Required if the PhoneNumber is provided in local format (recommended), to render the value in the E.164 standard.

The postal address of the user.

Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).

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 individual’s email address.

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 whose UserCategory is OWNER can submit verification documents for validation. Only users whose KYCLevel is REGULAR can 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.

Returned values: PAYER, OWNER, PLATFORM

The category of the user:

• PAYER – User who can only make pay-ins to their wallets and transfers to other wallets.
• 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 – Value assigned only by Mangopay.

Returned values: PENDING_USER_ACTION, ACTIVE, CLOSED

The status of the user:

• PENDING_USER_ACTION – The user must enroll in SCA before they can become ACTIVE.
• ACTIVE – The user account is active and the user can access Mangopay features.
• CLOSED – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions.

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.

Information about the legal representative declared for the user.

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.

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.

Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).

The legally registered address of the entity’s administrative center.
This object’s sub-parameters are null if the UserCategory is PAYER.

The address of the entity’s legal representative.

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 whose UserCategory is OWNER can submit verification documents for validation. Only users whose KYCLevel is REGULAR can 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.

Returned values: PAYER, OWNER, PLATFORM

The category of the user:

• PAYER – User who can only make pay-ins to their wallets and transfers to other wallets.
• 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 – Value assigned only by Mangopay.

Returned values: PENDING_USER_ACTION, ACTIVE, CLOSED

The status of the user:

• PENDING_USER_ACTION – The user must enroll in SCA before they can become ACTIVE.
• ACTIVE – The user account is active and the user can access Mangopay features.
• CLOSED – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions.