{
"UserCategory": "OWNER",
"TermsAndConditionsAccepted": true,
"LegalRepresentative": {
// "Email": "alex.smith@example.com",
// "PhoneNumber": "0611111111",
// "PhoneNumberCountry": "FR",
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"CompanyNumber": "123456789"
}
using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities.PUT;
using Newtonsoft.Json;
public class CategorizeUser
{
public void Run()
{
Task.Run(async () =>
{
MangoPayApi api = new MangoPayApi();
api.Config.ClientId = "your-client-id";
api.Config.ClientPassword = "your-api-key";
var categorizeLegal = new CategorizeUserLegalPutDTO
{
HeadquartersAddress = new Address
{
AddressLine1 = "17 Rue de la République",
City = "Paris",
Region = "Ile-de-France",
PostalCode = "75001",
Country = CountryIso.FR
},
CompanyNumber = "325698745",
LegalRepresentative = new LegalRepresentative
{
Birthday = new DateTime(1980, 3, 15),
Nationality = CountryIso.FR,
CountryOfResidence = CountryIso.FR,
},
TermsAndConditionsAccepted = true,
UserCategory = UserCategory.OWNER
};
var categorized =
await api.Users.CategorizeLegalAsync(categorizeLegal, "user_m_01K8B28H25JBHX1QFVC0T54S1Q");
string prettyPrint = JsonConvert.SerializeObject(categorized, Formatting.Indented);
Console.WriteLine(prettyPrint);
}).GetAwaiter().GetResult();
}
}
require 'mangopay'
MangoPay.configure do |client|
client.preproduction = true
client.client_id = 'your-mangopay-client-id'
client.client_apiKey = 'your-mangopay-api-key'
client.log_file = File.join(Dir.pwd, 'mangopay.log')
end
def categorizeLegalUser(userId, params)
begin
response = MangoPay::LegalUserSca.categorize(userId, params)
puts response
return response
rescue MangoPay::ResponseError => error
puts "Failed to categorize User: #{error.message}"
puts "Error details: #{error.details}"
return false
end
end
myLegalUserSca = {
UserCategory: 'OWNER',
TermsAndConditionsAccepted: true,
LegalRepresentative: {
Birthday: 652117514,
Nationality: 'FR',
CountryOfResidence: 'FR',
Email: 'name@example.com'
},
HeadquartersAddress: {
AddressLine1: '3 rue de la Cité',
AddressLine2: 'Appartement 7',
City: 'Paris',
Region: 'Île-de-France',
PostalCode: '75004',
Country: 'FR'
},
}
categorizeLegalUser('user_m_01K85X5HKK3YD61Y3YXD9FHV7H', myLegalUserSca)
<?php
require_once 'vendor/autoload.php';
use MangoPay\Libraries\Exception as MGPException;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\MangoPayApi;
use MangoPay\UserCategory;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-mangopay-api-key';
$api->Config->TemporaryFolder = 'tmp/';
$api->Config->DebugMode = true;
try {
$user = $api->Users->GetLegalSca('user_m_01K8932FJ54AF8BY7PY80G0JG1');
$legalRepresentative = new LegalRepresentative();
$legalRepresentative->Email = "john.sca@example.com";
$legalRepresentative->Birthday = mktime(0, 0, 0, 12, 21, 1975);
$legalRepresentative->Nationality = 'FR';
$legalRepresentative->CountryOfResidence = 'FR';
$legalRepresentative->PhoneNumber = "+33611111111";
$legalRepresentative->PhoneNumberCountry = "FR";
$user->LegalRepresentative = $legalRepresentative;
$user->UserCategory = UserCategory::Owner;
$user->CompanyNumber = "LU123456";
$user->TermsAndConditionsAccepted = true;
$address = new \MangoPay\Address();
$address->AddressLine1 = 'Rue des plantes';
$address->AddressLine2 = '2nd floor';
$address->City = 'Paris';
$address->Country = 'FR';
$address->PostalCode = '75000';
$address->Region = 'IDF';
$user->HeadquartersAddress = $address;
$response = $api->Users->Categorize($user);
print_r($response);
} catch (MGPResponseException $e) {
print_r($e);
} catch (MGPException $e) {
print_r($e);
}
{
"Name": "Alex Smith",
"LegalPersonType": "SOLETRADER",
"LegalRepresentative": {
"FirstName": "Alex",
"LastName": "Smith",
"ProofOfIdentity": null,
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
"Email": "alex.smith@example.com",
"PhoneNumber": "0611111111",
"PhoneNumberCountry": "FR"
},
"ProofOfRegistration": null,
"ShareholderDeclaration": null,
"Statute": null,
"CompanyNumber": "123456789",
"PendingUserAction": {
"RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193cef9efe7782881459b02bed1986c"
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"LegalRepresentativeAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"Id": "user_m_01JF7FKVP51PS3TYKCN79VZZ8M",
"Tag": "Created using Mangopay API Collection Postman",
"CreationDate": 1734344306,
"PersonType": "LEGAL",
"Email": "alex.smith.services@example.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1734344306,
"UserCategory": "OWNER",
"UserStatus": "PENDING_USER_ACTION"
}
Users
Categorize a Legal User
Transition a Legal Payer to Owner and enroll them in SCA
PUT
/
v2.01
/
{ClientId}
/
sca
/
users
/
legal
/
{UserId}
/
category
{
"UserCategory": "OWNER",
"TermsAndConditionsAccepted": true,
"LegalRepresentative": {
// "Email": "alex.smith@example.com",
// "PhoneNumber": "0611111111",
// "PhoneNumberCountry": "FR",
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"CompanyNumber": "123456789"
}
using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities.PUT;
using Newtonsoft.Json;
public class CategorizeUser
{
public void Run()
{
Task.Run(async () =>
{
MangoPayApi api = new MangoPayApi();
api.Config.ClientId = "your-client-id";
api.Config.ClientPassword = "your-api-key";
var categorizeLegal = new CategorizeUserLegalPutDTO
{
HeadquartersAddress = new Address
{
AddressLine1 = "17 Rue de la République",
City = "Paris",
Region = "Ile-de-France",
PostalCode = "75001",
Country = CountryIso.FR
},
CompanyNumber = "325698745",
LegalRepresentative = new LegalRepresentative
{
Birthday = new DateTime(1980, 3, 15),
Nationality = CountryIso.FR,
CountryOfResidence = CountryIso.FR,
},
TermsAndConditionsAccepted = true,
UserCategory = UserCategory.OWNER
};
var categorized =
await api.Users.CategorizeLegalAsync(categorizeLegal, "user_m_01K8B28H25JBHX1QFVC0T54S1Q");
string prettyPrint = JsonConvert.SerializeObject(categorized, Formatting.Indented);
Console.WriteLine(prettyPrint);
}).GetAwaiter().GetResult();
}
}
require 'mangopay'
MangoPay.configure do |client|
client.preproduction = true
client.client_id = 'your-mangopay-client-id'
client.client_apiKey = 'your-mangopay-api-key'
client.log_file = File.join(Dir.pwd, 'mangopay.log')
end
def categorizeLegalUser(userId, params)
begin
response = MangoPay::LegalUserSca.categorize(userId, params)
puts response
return response
rescue MangoPay::ResponseError => error
puts "Failed to categorize User: #{error.message}"
puts "Error details: #{error.details}"
return false
end
end
myLegalUserSca = {
UserCategory: 'OWNER',
TermsAndConditionsAccepted: true,
LegalRepresentative: {
Birthday: 652117514,
Nationality: 'FR',
CountryOfResidence: 'FR',
Email: 'name@example.com'
},
HeadquartersAddress: {
AddressLine1: '3 rue de la Cité',
AddressLine2: 'Appartement 7',
City: 'Paris',
Region: 'Île-de-France',
PostalCode: '75004',
Country: 'FR'
},
}
categorizeLegalUser('user_m_01K85X5HKK3YD61Y3YXD9FHV7H', myLegalUserSca)
<?php
require_once 'vendor/autoload.php';
use MangoPay\Libraries\Exception as MGPException;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\MangoPayApi;
use MangoPay\UserCategory;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-mangopay-api-key';
$api->Config->TemporaryFolder = 'tmp/';
$api->Config->DebugMode = true;
try {
$user = $api->Users->GetLegalSca('user_m_01K8932FJ54AF8BY7PY80G0JG1');
$legalRepresentative = new LegalRepresentative();
$legalRepresentative->Email = "john.sca@example.com";
$legalRepresentative->Birthday = mktime(0, 0, 0, 12, 21, 1975);
$legalRepresentative->Nationality = 'FR';
$legalRepresentative->CountryOfResidence = 'FR';
$legalRepresentative->PhoneNumber = "+33611111111";
$legalRepresentative->PhoneNumberCountry = "FR";
$user->LegalRepresentative = $legalRepresentative;
$user->UserCategory = UserCategory::Owner;
$user->CompanyNumber = "LU123456";
$user->TermsAndConditionsAccepted = true;
$address = new \MangoPay\Address();
$address->AddressLine1 = 'Rue des plantes';
$address->AddressLine2 = '2nd floor';
$address->City = 'Paris';
$address->Country = 'FR';
$address->PostalCode = '75000';
$address->Region = 'IDF';
$user->HeadquartersAddress = $address;
$response = $api->Users->Categorize($user);
print_r($response);
} catch (MGPResponseException $e) {
print_r($e);
} catch (MGPException $e) {
print_r($e);
}
{
"Name": "Alex Smith",
"LegalPersonType": "SOLETRADER",
"LegalRepresentative": {
"FirstName": "Alex",
"LastName": "Smith",
"ProofOfIdentity": null,
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
"Email": "alex.smith@example.com",
"PhoneNumber": "0611111111",
"PhoneNumberCountry": "FR"
},
"ProofOfRegistration": null,
"ShareholderDeclaration": null,
"Statute": null,
"CompanyNumber": "123456789",
"PendingUserAction": {
"RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193cef9efe7782881459b02bed1986c"
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"LegalRepresentativeAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"Id": "user_m_01JF7FKVP51PS3TYKCN79VZZ8M",
"Tag": "Created using Mangopay API Collection Postman",
"CreationDate": 1734344306,
"PersonType": "LEGAL",
"Email": "alex.smith.services@example.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1734344306,
"UserCategory": "OWNER",
"UserStatus": "PENDING_USER_ACTION"
}
This endpoint allows you to transition a user whose
If the user’s
UserCategory is PAYER into an OWNER by providing the required information and redirecting them on the PendingUserAction.RedirectUrl response value to complete SCA enrollment.
SCA applies to all LegalPersonType: BUSINESS, ORGANIZATION, PARTNERSHIP, and SOLETRADER. In Sandbox the RedirectUrl is returned for all legal user types (see legal user integration and SCA triggers in Sandbox).
Optionally, you can update the LegalRepresentative.Email (in not already present) and provide or update the LegalRepresentative.PhoneNumber and LegalRepresentative.PhoneNumberCountry before SCA redirection.
If the user’s UserCategory is already OWNER, use the POST Enroll a User in SCA endpoint to obtain an SCA session link.
Read more about SCA redirection →
Note – Country-based restrictions apply to usersDue to Mangopay’s country restrictions, it is not possible to use blocked countries as the following:
LegalRepresentative.NationalityLegalRepresentative.CountryOfResidence
Body parameters
string
required
Allowed values:
OWNERThe new category of the user, which must be OWNER.boolean
required
Allowed values:
trueWhether the user has accepted Mangopay’s terms and conditions (as defined by your contract, see the T&Cs guide for details).object
required
Information about the legal representative declared for the user.
Show properties
Show properties
Unix timestamp
required
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.
string
required
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The nationality of the individual.
string
required
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of residence of the individual.
string
required
Format: A valid email addressThe individual’s email address. For
OWNER users, SCA uses this email address to build a behavioral biometrics profile and as a backup communication channel.string
Format: International E.164 standard (preceded by plus sign and country code) or local formatThe 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.string
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.object
required
The legally registered address of the entity’s administrative center.
Show properties
Show properties
string
required
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
required
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersRequired if
Country is US, CA, or MX.The region of the address.string
required
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
string
required
The country of the address.
string
Required if
LegalPersonType is BUSINESS.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.string
Possible values:
USER_PRESENT, USER_NOT_PRESENTDefault value: USER_PRESENTThe SCA context of the request, which is required if the OWNER value is being assigned for UserCategory:USER_PRESENT– The user is on session duringOWNERaccount creation and can enroll in SCA at the same time. The platform must redirect the user using thePendingUserAction.RedirectUrlreturned so that the user can complete the SCA session.USER_NOT_PRESENT– The platform has explicit permission from Mangopay to create theOWNERuser account without simultaneous SCA enrollment.
ScaContext is not returned in the API response as it does not form part of the User data – it’s only related to the action being performed on the user.Responses
200
200
string
Max. length: 255 charactersThe registered legal name of the entity. The
Name value should be the one registered with the relevant national authority.string
Returned values: BUSINESS, PARTNERSHIP, ORGANIZATION, SOLETRADERThe 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.object
Information about the legal representative declared for the user.
Show properties
Show properties
string
Min. length: 1; max. length: 100The first name of the individual.
string
Min. length: 1; max. length: 100The last name of the individual.
string
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.Unix timestamp
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.string
Returned
null if UserCategory is PAYER.The nationality of the individual.string
Returned
null if UserCategory is PAYER.The country of residence of the individual.string
Format: A valid email addressRequired if
UserCategory is OWNER. Returned null if UserCategory is PAYER.The individual’s email address. For OWNER users, SCA uses this email address to build a behavioral biometrics profile and as a backup communication channel.string
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.string
Format: International E.164 standard (preceded by plus sign and country code) or local formatThe 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.string
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.string
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.string
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.string
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
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned
null).Hide properties
Hide properties
string
The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.The SCA session link expires 10 minutes after it’s generated.Caution: Before redirecting the user on this URL, you must add the query parameter
ReturnUrl with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).For more details, see How to redirect a user for an SCA session.object
The legally registered address of the entity’s administrative center.
This object’s sub-parameters are
This object’s sub-parameters are
null if the UserCategory is PAYER.Show properties
Show properties
string
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country is US, CA, or MX.string
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
string
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
object
The address of the entity’s legal representative.
Show properties
Show properties
string
Max. length: 255 charactersThe first line of the address.
string
Max. length: 255 charactersThe second line of the address.
string
Max. length: 255 charactersThe city of the address.
string
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country is US, CA, or MX.string
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
string
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
string
Max. length: 255 charactersCustom data that you can add to this object.
Unix timestamp
The date and time at which the object was created.
string
Returned values: NATURAL, LEGALThe 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.
PersonType is defined by the endpoint used to create the user and can’t be modified.string
Format: A valid email addressThe email address for the entity.
string
Default value:
LIGHTReturned values: LIGHT, REGULARThe 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.
boolean
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
The date and time at which the
TermsAndConditionsAccepted value was set to true.Returned null if UserCategory is PAYER.string
Possible values:
PAYER, OWNER, PLATFORMThe 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 theKYCLevelofREGULARand the ability to request payouts.PLATFORM– Single specific user that represents the platform. ThePLATFORMvalue is only assigned by Mangopay and may be used as part of the validated workflow implemented by the platform.
string
Returned values:
PENDING_USER_ACTION, ACTIVE, CLOSEDThe status of the user:PENDING_USER_ACTION– The user must enroll in SCA before they can becomeACTIVE.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.
400 - LegalRepresentative.Email required
400 - LegalRepresentative.Email required
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "939c4b8c-3e82-4012-a5bd-a3aa2727432a",
"Date": 1751881519.0,
"errors": {
"LegalRepresentative.Email": "'Email' must not be empty."
}
}
400 - Endpoint not allowed if category already OWNER
400 - Endpoint not allowed if category already OWNER
{
"Message": "This endpoint is not allowed for User categorized as OWNER",
"Type": "not_allowed_for_user_category_owner",
"Id": "68d1c3e0-ea28-465b-9ef1-36f388fc896d",
"Date": 1734348365.0,
"errors": null
}
UserCategory is OWNER, use the POST Enroll a User in SCA endpoint to obtain an SCA session link.{
"Name": "Alex Smith",
"LegalPersonType": "SOLETRADER",
"LegalRepresentative": {
"FirstName": "Alex",
"LastName": "Smith",
"ProofOfIdentity": null,
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
"Email": "alex.smith@example.com",
"PhoneNumber": "0611111111",
"PhoneNumberCountry": "FR"
},
"ProofOfRegistration": null,
"ShareholderDeclaration": null,
"Statute": null,
"CompanyNumber": "123456789",
"PendingUserAction": {
"RedirectUrl": "https://sca.sandbox.mangopay.com/?token=0193cef9efe7782881459b02bed1986c"
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"LegalRepresentativeAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"Id": "user_m_01JF7FKVP51PS3TYKCN79VZZ8M",
"Tag": "Created using Mangopay API Collection Postman",
"CreationDate": 1734344306,
"PersonType": "LEGAL",
"Email": "alex.smith.services@example.com",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1734344306,
"UserCategory": "OWNER",
"UserStatus": "PENDING_USER_ACTION"
}
{
"UserCategory": "OWNER",
"TermsAndConditionsAccepted": true,
"LegalRepresentative": {
// "Email": "alex.smith@example.com",
// "PhoneNumber": "0611111111",
// "PhoneNumberCountry": "FR",
"Birthday": 652117514,
"Nationality": "FR",
"CountryOfResidence": "FR",
},
"HeadquartersAddress": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75004",
"Country": "FR"
},
"CompanyNumber": "123456789"
}
using MangoPay.SDK;
using MangoPay.SDK.Core.Enumerations;
using MangoPay.SDK.Entities.PUT;
using Newtonsoft.Json;
public class CategorizeUser
{
public void Run()
{
Task.Run(async () =>
{
MangoPayApi api = new MangoPayApi();
api.Config.ClientId = "your-client-id";
api.Config.ClientPassword = "your-api-key";
var categorizeLegal = new CategorizeUserLegalPutDTO
{
HeadquartersAddress = new Address
{
AddressLine1 = "17 Rue de la République",
City = "Paris",
Region = "Ile-de-France",
PostalCode = "75001",
Country = CountryIso.FR
},
CompanyNumber = "325698745",
LegalRepresentative = new LegalRepresentative
{
Birthday = new DateTime(1980, 3, 15),
Nationality = CountryIso.FR,
CountryOfResidence = CountryIso.FR,
},
TermsAndConditionsAccepted = true,
UserCategory = UserCategory.OWNER
};
var categorized =
await api.Users.CategorizeLegalAsync(categorizeLegal, "user_m_01K8B28H25JBHX1QFVC0T54S1Q");
string prettyPrint = JsonConvert.SerializeObject(categorized, Formatting.Indented);
Console.WriteLine(prettyPrint);
}).GetAwaiter().GetResult();
}
}
require 'mangopay'
MangoPay.configure do |client|
client.preproduction = true
client.client_id = 'your-mangopay-client-id'
client.client_apiKey = 'your-mangopay-api-key'
client.log_file = File.join(Dir.pwd, 'mangopay.log')
end
def categorizeLegalUser(userId, params)
begin
response = MangoPay::LegalUserSca.categorize(userId, params)
puts response
return response
rescue MangoPay::ResponseError => error
puts "Failed to categorize User: #{error.message}"
puts "Error details: #{error.details}"
return false
end
end
myLegalUserSca = {
UserCategory: 'OWNER',
TermsAndConditionsAccepted: true,
LegalRepresentative: {
Birthday: 652117514,
Nationality: 'FR',
CountryOfResidence: 'FR',
Email: 'name@example.com'
},
HeadquartersAddress: {
AddressLine1: '3 rue de la Cité',
AddressLine2: 'Appartement 7',
City: 'Paris',
Region: 'Île-de-France',
PostalCode: '75004',
Country: 'FR'
},
}
categorizeLegalUser('user_m_01K85X5HKK3YD61Y3YXD9FHV7H', myLegalUserSca)
<?php
require_once 'vendor/autoload.php';
use MangoPay\Libraries\Exception as MGPException;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\MangoPayApi;
use MangoPay\UserCategory;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-mangopay-api-key';
$api->Config->TemporaryFolder = 'tmp/';
$api->Config->DebugMode = true;
try {
$user = $api->Users->GetLegalSca('user_m_01K8932FJ54AF8BY7PY80G0JG1');
$legalRepresentative = new LegalRepresentative();
$legalRepresentative->Email = "john.sca@example.com";
$legalRepresentative->Birthday = mktime(0, 0, 0, 12, 21, 1975);
$legalRepresentative->Nationality = 'FR';
$legalRepresentative->CountryOfResidence = 'FR';
$legalRepresentative->PhoneNumber = "+33611111111";
$legalRepresentative->PhoneNumberCountry = "FR";
$user->LegalRepresentative = $legalRepresentative;
$user->UserCategory = UserCategory::Owner;
$user->CompanyNumber = "LU123456";
$user->TermsAndConditionsAccepted = true;
$address = new \MangoPay\Address();
$address->AddressLine1 = 'Rue des plantes';
$address->AddressLine2 = '2nd floor';
$address->City = 'Paris';
$address->Country = 'FR';
$address->PostalCode = '75000';
$address->Region = 'IDF';
$user->HeadquartersAddress = $address;
$response = $api->Users->Categorize($user);
print_r($response);
} catch (MGPResponseException $e) {
print_r($e);
} catch (MGPException $e) {
print_r($e);
}
Was this page helpful?