Enrollment request

1. Methods for creating an enrollment request

1.1. From the CentralPay Merchant Portal

A user logged into the CentralPay portal can initiate an enrollment request from the menu: Plateform > Enrollments > Create

They can then manually fill in the fields described below (in the API call details). Once the request is saved, a redirect link to the onboarding portal is automatically generated and can be:

• Sent automatically via email through the CentralPay Mailer (select “YES” in the “Send emails to the address above” field)
• Or copied manually to be sent via another channel (chat, text message, etc.)

1.2. From the API: POST /merchant-enrollments

Enrollment can also be initiated automatically via the API by calling: POST /merchant-enrollments

This call generates an enrollment ID (UUID) and initiates a complete onboarding process, which can be continued:

• Either via the Merchant Portal
• Either entirely via API endpoints (see the “Complete an Enrollment via API” section)

If no direct link (enrollment_url) is returned by the API, by default, the CentralPay platform sends an email to the address specified in profile[email][value].
To disable this email: "sendClaimEmail": false

If you disable this email, you can manually provide the URL to access the onboarding interface by constructing it as follows:
- In Sandbox: https://test-onboarding.centralpay.net/token/profile/[UUID]
- En LIVE: https://onboarding.centralpay.net/token/profile/[UUID]

Note: [UUID] is the identifier returned in the response to POST /merchant-enrollments.

2. Create an enrollment request via the API (Merchant Enrollment)

🇫🇷 Simplified enrollment via SIREN (France only)
CentralPay automatically pre-fills certain information for French companies with a SIREN number:
1. Call the endpoint: POST /api/legal-entity/siren
2. Provide the following: { "siren": "123456789" }
3. If the information is valid, a UUID is returned. It must be used as identityBadge in the registration creation process to trigger the simplified workflow. 

2.1. Required fields

Field	Type	Required	Description
profile[firstname][value]	string (255)	✅ Yes	Account holder’s first name. Validation: alphabetic characters and hyphens (-). Since version 1.15.0
profile[lastname][value]	string (255)	✅ Yes	Account holder’s last name. Validation: alphabetic characters and hyphens (-). Since version 1.15.0
profile[email][value]	string (255)	✅ Yes	Contact email address. Since version 1.15.0
profile[phone][value]	string	✅ Yes	International phone number. Since version 1.15.0
language	string	✅ Yes	Merchant’s preferred language. Note: Use GET /api/locale for the available values.
accountType	enum	✅ Yes	Type of merchant profile to create. Note: Use GET /api/merchant-enrollment/account-type.
activitySector	UUID (36)	✅ Yes	Merchant’s industry sector. Note: Use GET /api/nauth/enrollment-claim/activity-sector.
activityAge	UUID (36)	✅ Yes, if type = LEGAL_ENTITY ou INDIVIDUAL_WITH_STATUS	Length of time in business. Note: Use GET /api/nauth/enrollment-claim/activity-age.
feeSchedule	UUID (36)	✅ Yes	Pricing schedule to be applied. Note: Obtain the login credentials via POST /api/merchant-enrollment/fee-schedule.
identityBadge	UUID	✅ Yes, if enrolled via SIREN	SIREN ID (which activates the simplified process).
contract	UUID	✅ Yes, if accountType = STANDARD	Contract to be applied. Note: Use GET /api/merchant-enrollment/contract.

2.2. Advanced fields (optional)

Customizing the experience

Field	Default value	Description
workflowMode	SEQUENTIAL	Course mode (only mode SEQUENTIAL is now available). Note: Valid values: SEQUENTIAL
type	—	Legal type: INDIVIDUAL, INDIVIDUAL_WITH_STATUS, LEGAL_ENTITY. Note: Determines the structure of the process.
subType	—	Recommended subtype according to type. Note: For INDIVIDUAL_WITH_STATUS : SOLE_TRADER, MERCHANT, ARTISAN For LEGAL_ENTITY : ASSOCIATION, PUBLIC, COMMERCIAL, EIG, CIVIL
turnoverIsFixed	false	If true, locks the revenue report. Note: optional

Communication settings

Field	Default value	Description
sendClaimEmail	true	Send the registration email with the portal link.
allowedEmailCommunication	true	If false, disable all email sends during the onboarding process.
sendProfileCreationEmail	false	Send an email to the user once the profile is completed.
sendAccountCreationEmail	true	Send an email once the CentralPay Merchant profile has been activated.

Personal data

All of the fields below are optional, but they allow you to pre-fill the user profile for the future account holder.

Field	Type	Description
profile[nationality][country]	string (3)	Nationality (ISO 3166-1 alpha-3 format).
profile[birthday][value]	date	Date of birth. Validation: ≥ 18 years old, ≤ 110 years old
profile[place_of_birth][value]	string	Birthplace.
profile[country_of_birth][country]	string (3)	Country of birth (ISO 3166-1 alpha-3).
birthdayConfirmation[value]	date	Required only if the merchant is affiliated with an agent. Format: YYYY-MM-DD

Address (optional)

These fields can be filled in to pre-fill the account owner’s address.

Field	Type	Description
profile[address][nameLine1]	string(255)	Line 1 of the address. Constraints: ^[a-zA-Z0-9\\p{L} ´'\\-]{1,255}$
profile[address][locality]	string(255)	City.
profile[address][postalCode]	string(20)	Postal code.
profile[address][country]	string(3)	Country (ISO 3166-1 alpha-3).

Other options

Field	Type	Description
contract	UUID (36)	Contract to be applied. Required if accountType = STANDARD. Note: GET /api/merchant-enrollment/contract
cgu	UUID (36)	Terms of Service apply. Note: POST /api/merchant-enrollment/cgu Since version 1.18.0
customReference	string (100)	Custom reference (for internal use).
payoutProfile	UUID (36)	Payment profile to be linked. Note: POST /api/merchant-enrollment/payout-profile
administrativeContact	string (255)	Primary administrative reference. Since version 1.18.0
technicalContact	string (255)	Technical contact. Since version 1.18.0
financialContact	string (255)	Financial contact. Since version 1.18.0
addSecurityReference	bool	Displays a security reference when the contract is approved. Valid only for: STANDARD, PARTNER, RESELLER. Default: false
hook	UUID	Webhook ID to be notified. Note: See the “Full API Reference” tab for possible values.