Create a Legal User

Allowed values: PAYER, OWNER

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.

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.

Allowed 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 <a href="/guides/users/verification/requirements" target="_blank">verification requirements</a>.

Caution: Modification of the LegalPersonType may result in a <a href="/guides/users/verification/downgrade" target="_blank">verification downgrade</a>.

Max. length: 255 characters

The registered legal name of the entity. The Name value should be the one registered with the relevant national authority.

Format: A valid email address

The email address for the entity.

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.

Min length: 1; max. length: 100

The first name of the entity's legal representative.

Min length: 1; max. length: 100

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.

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The date of birth of the entity's legal representative.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

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

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The nationality of the entity's legal representative.

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

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The country of residence of the entity's legal representative.

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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 <a href="/guides/users/verification/requirements" target="_blank">verification requirements</a>.

Caution: Modification of the LegalPersonType may result in a <a href="/guides/users/verification/downgrade" target="_blank">verification downgrade</a>.

Min. length: 1; max. length: 100

The first name of the entity's legal representative.

Min. length: 1; max. length: 100

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: 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 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.

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Unix timestamp (UTC) of the date and time 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.

Unix timestamp (UTC) of the date and time the TermsAndConditionsAccepted value was set to true.

Returned null if UserCategory is PAYER.

Possible 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 (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.

Returned values: ACTIVE, CLOSED

Internal use only. This field can only be used and updated by Mangopay teams.