Users

Create a Legal User (SCA)

Changed on

Register a Legal Payer or Owner (with SCA enrollment).

<Note icon="fa-regular fa-circle-info"> **Note – SCA triggered for Owners**

If UserCategory is OWNER, this endpoint triggers SCA enrollment. SCA applies to all LegalPersonType.

Your platform needs to use the returned PendingUserAction.RedirectUrl (and add an encoded returnUrl query parameter) to redirect the user so they can enroll. Read more about how to redirect them in the SCA session guide.

In Sandbox, you can bypass SCA by including the word accept in the Legal User's LegalRepresentative.Email – for example accept@example.com or john.doe+accept@example.com. </Note>

<Note icon="fa-regular fa-circle-info"> **Note – Legal representative's email required for Owners**

If UserCategory is OWNER, the LegalRepresentative.Email address is required.

SCA uses this email address for the individual who will complete SCA to build a behavioral biometrics profile and as a backup communication channel. Prior to SCA, it was possible to create a Legal OWNER without the LegalRepresentativeEmail. </Note>

<Note icon="fa-regular fa-circle-info"> **Note – Country-based restrictions apply to users**

Due to Mangopay's country restrictions, it is not possible to use blocked countries as the following:

  • HeadquartersAddress.Country
  • LegalRepresentative.Nationality
  • LegalRepresentative.CountryOfResidence
  • LegalRepresentativeAddress.Country
</Note>
post/v2.01/{ClientId}/sca/users/legal

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/sca/users/legal
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Request body

OR

Response

Success

Namestring

Max. length: 255 characters

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

LegalPersonTypestring

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

ProofOfRegistrationstring nullable

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.

ShareholderDeclarationstring nullable

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.

Statutestring nullable

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.

CompanyNumberstring nullable

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.

Idstring

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

The unique identifier of the object.

Tagstring

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}".

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

PersonTypestring

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.

Emailstring

Format: A valid email address

The email address for the entity.

KYCLevelstring

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

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.

TermsAndConditionsAcceptedDateinteger nullable

The date and time at which the TermsAndConditionsAccepted value was set to true.

Returned null if UserCategory is PAYER.

UserCategorystring

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

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.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_legal_user_sca removed and replaced with users_create_legal_user_sca