{"id":16494,"date":"2025-06-30T11:58:30","date_gmt":"2025-06-30T09:58:30","guid":{"rendered":"https:\/\/docs.centralpay.com\/documentation\/enrollment-request\/"},"modified":"2026-08-26T16:26:29","modified_gmt":"2026-08-26T14:26:29","slug":"enrollment-request","status":"publish","type":"docs","link":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/","title":{"rendered":"Enrollment request"},"content":{"rendered":"\n

1. Methods for creating an enrollment request<\/h2>\n\n

1.1. From the CentralPay Merchant Portal<\/h3>\n\n

A user logged into the CentralPay portal can initiate an enrollment request from the menu: Plateform > Enrollments > Create<\/strong><\/p>\n\n

\n
Recette<\/code> Merchent Portal – Onboarding<\/a><\/div>\n<\/div>\n\n
<\/div>\n\n
\n
Production<\/code> Merchent Portal – Onboarding<\/a><\/div>\n<\/div>\n\n
<\/div>\n\n

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: <\/p>\n\n

    \n
  • Sent automatically via email through the CentralPay Mailer (select \u201cYES\u201d in the \u201cSend emails to the address above\u201d field)<\/li>\n\n\n\n
  • Or copied manually to be sent via another channel (chat, text message, etc.)<\/li>\n<\/ul>\n\n

    1.2. From the API: POST \/merchant-enrollments<\/h3>\n\n

    Enrollment can also be initiated automatically via the API by calling: POST \/merchant-enrollments<\/code><\/p>\n\n

    This call generates an enrollment ID (UUID) and initiates a complete onboarding process, which can be continued:<\/p>\n\n

      \n
    • Either via the Merchant Portal<\/li>\n\n\n\n
    • Either entirely via API endpoints (see the \u201cComplete an Enrollment via API\u201d section)<\/li>\n<\/ul>\n\n
      If no direct link (enrollment_url<\/code>) 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\": falseIf 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.<\/pre>\n\n
      2. Create an enrollment request via the API (Merchant Enrollment)<\/h2>\n\n
      \ud83c\uddeb\ud83c\uddf7 Simplified enrollment via SIREN (France only)<\/strong>CentralPay automatically pre-fills certain information for French companies with a SIREN number:1. Call the endpoint: POST \/api\/legal-entity\/siren2. Provide the following: { \"siren\": \"123456789\" }3. If the information is valid, a UUID is returned. It must be used as identityBadge<\/code> in the registration creation process to trigger the simplified workflow. <\/pre>\n\n
      2.1. Required fields<\/h3>\n\n
      Field<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
      profile[firstname][value]<\/code><\/td>string (255)<\/td>\u2705 Yes<\/td>Account holder’s first name. Validation: alphabetic characters and hyphens (-<\/code>). Since version 1.15.0<\/em> <\/td><\/tr>
      profile[lastname][value]<\/code><\/td>string (255)<\/td>\u2705 Yes<\/td>Account holder’s last name. Validation: alphabetic characters and hyphens (-<\/code>). Since version 1.15.0<\/em> <\/td><\/tr>
      profile[email][value]<\/code><\/td>string (255)<\/td>\u2705 Yes<\/td>Contact email address. Since version 1.15.0<\/em><\/td><\/tr>
      profile[phone][value]<\/code><\/td>string<\/td>\u2705 Yes<\/td>International phone number. Since version 1.15.0<\/em><\/td><\/tr>
      language<\/code><\/td>string<\/td>\u2705 Yes<\/td>Merchant’s preferred language. Note<\/strong>: Use GET \/api\/locale<\/code> for the available values.<\/td><\/tr>
      accountType<\/code><\/td>enum<\/td>\u2705 Yes<\/td>Type of merchant profile to create. Note<\/strong>: Use GET \/api\/merchant-enrollment\/account-type<\/code>.<\/td><\/tr>
      activitySector<\/code><\/td>UUID (36)<\/td>\u2705 Yes<\/td>Merchant’s industry sector. Note<\/strong>: Use GET \/api\/nauth\/enrollment-claim\/activity-sector<\/code>.<\/td><\/tr>
      activityAge<\/code><\/td>UUID (36)<\/td>\u2705 Yes, if type = LEGAL_ENTITY ou INDIVIDUAL_WITH_STATUS<\/td>Length of time in business. Note:<\/strong> Use GET \/api\/nauth\/enrollment-claim\/activity-age<\/code>.<\/td><\/tr>
      feeSchedule<\/code><\/td>UUID (36)<\/td>\u2705 Yes<\/td>Pricing schedule to be applied. Note:<\/strong> Obtain the login credentials via POST \/api\/merchant-enrollment\/fee-schedule<\/code>.<\/td><\/tr>
      identityBadge<\/code><\/td>UUID<\/td>\u2705 Yes, if enrolled via SIREN<\/td>SIREN ID (which activates the simplified process).<\/td><\/tr>
      contract<\/code><\/td>UUID<\/td>\u2705 Yes, if accountType = STANDARD<\/td>Contract to be applied. Note<\/strong>: Use GET \/api\/merchant-enrollment\/contract<\/code>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
      2.2. Advanced fields (optional)<\/h3>\n\n
      Customizing the experience<\/h4>\n\n
      Field<\/th>Default value<\/th>Description<\/th><\/tr><\/thead>
      workflowMode<\/code><\/td>SEQUENTIAL<\/td>Course mode (only mode SEQUENTIAL<\/code> is now available).Note:<\/strong> Valid values: SEQUENTIAL<\/code><\/td><\/tr>
      type<\/code><\/td>\u2014<\/td>Legal type: INDIVIDUAL<\/code>, INDIVIDUAL_WITH_STATUS<\/code>, LEGAL_ENTITY<\/code>.Note:<\/strong> Determines the structure of the process.<\/td><\/tr>
      subType<\/code><\/td>\u2014<\/td>Recommended subtype according to type<\/code>.Note:<\/strong>For INDIVIDUAL_WITH_STATUS<\/code> : SOLE_TRADER<\/code>, MERCHANT<\/code>, ARTISAN<\/code>For LEGAL_ENTITY<\/code> : ASSOCIATION<\/code>, PUBLIC<\/code>, COMMERCIAL<\/code>, EIG<\/code>, CIVIL<\/code><\/td><\/tr>
      turnoverIsFixed<\/code><\/td>false<\/code><\/td>If true<\/code>, locks the revenue report.Note<\/strong>: optional<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
      Communication settings<\/h4>\n\n
      Field<\/th>Default value<\/th>Description<\/th><\/tr><\/thead>
      sendClaimEmail<\/code><\/td>true<\/code><\/td>Send the registration email with the portal link.<\/td><\/tr>
      allowedEmailCommunication<\/code><\/td>true<\/code><\/td>If false<\/code>, disable all email sends during the onboarding process.<\/td><\/tr>
      sendProfileCreationEmail<\/code><\/td>false<\/code><\/td>Send an email to the user once the profile is completed.<\/td><\/tr>
      sendAccountCreationEmail<\/code><\/td>true<\/code><\/td>Send an email once the CentralPay Merchant profile has been activated.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
      Personal data<\/h4>\n\n
      All of the fields below are optional<\/strong>, but they allow you to pre-fill the user profile for the future account holder.<\/p>\n\n
      Field<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
      profile[nationality][country]<\/code><\/td>string (3)<\/td>Nationality (ISO 3166-1 alpha-3 format).<\/td><\/tr>
      profile[birthday][value]<\/code><\/td>date<\/td>Date of birth.Validation: \u2265 18 years old, \u2264 110 years old<\/td><\/tr>
      profile[place_of_birth][value]<\/code><\/td>string<\/td>Birthplace.<\/td><\/tr>
      profile[country_of_birth][country]<\/code><\/td>string (3)<\/td>Country of birth (ISO 3166-1 alpha-3).<\/td><\/tr>
      birthdayConfirmation[value]<\/code><\/td>date<\/td>Required only if the merchant is affiliated with an agent.Format: YYYY-MM-DD<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n
      Address (optional)<\/h4>\n\n
      These fields can be filled in to pre-fill the account owner’s address.<\/p>\n\n
      Field<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
      profile[address][nameLine1]<\/code><\/td>string(255)<\/td>Line 1 of the address.Constraints<\/strong>: ^[a-zA-Z0-9\\\\p{L} \u00b4'\\\\-]{1,255}$<\/code><\/td><\/tr>
      profile[address][locality]<\/code><\/td>string(255)<\/td>City.<\/td><\/tr>
      profile[address][postalCode]<\/code><\/td>string(20)<\/td>Postal code.<\/td><\/tr>
      profile[address][country]<\/code><\/td>string(3)<\/td>Country (ISO 3166-1 alpha-3).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
      Other options<\/h4>\n\n
      Field<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
      contract<\/code><\/td>UUID (36)<\/td>Contract to be applied.Required<\/strong> if accountType = STANDARD<\/code>.Note:<\/strong> GET \/api\/merchant-enrollment\/contract<\/code><\/td><\/tr>
      cgu<\/code><\/td>UUID (36)<\/td>Terms of Service apply.Note:<\/strong> POST \/api\/merchant-enrollment\/cgu<\/code>Since version 1.18.0<\/td><\/tr>
      customReference<\/code><\/td>string (100)<\/td>Custom reference (for internal use).<\/td><\/tr>
      payoutProfile<\/code><\/td>UUID (36)<\/td>Payment profile to be linked.Note<\/strong>: POST \/api\/merchant-enrollment\/payout-profile<\/code><\/td><\/tr>
      administrativeContact<\/code><\/td>string (255)<\/td>Primary administrative reference.Since version 1.18.0<\/em><\/td><\/tr>
      technicalContact<\/code><\/td>string (255)<\/td>Technical contact.Since version 1.18.0<\/em><\/td><\/tr>
      financialContact<\/code><\/td>string (255)<\/td>Financial contact.Since version 1.18.0<\/em><\/td><\/tr>
      addSecurityReference<\/code><\/td>bool<\/td>Displays a security reference when the contract is approved.Valid only for<\/strong>: STANDARD<\/code>, PARTNER<\/code>, RESELLER<\/code>.Default: false<\/code><\/td><\/tr>
      hook<\/code><\/td>UUID<\/td>Webhook ID to be notified.Note<\/strong>: See the \u201cFull API Reference<\/em>\u201d tab for possible values.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
      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 […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":16512,"menu_order":2,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"doc_badge":[149],"class_list":["post-16494","docs","type-docs","status-publish","hentry","doc_badge-merchant-enrollment","no-post-thumbnail"],"acf":[],"yoast_head":"\nEnrollment request - CentralPay Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Enrollment request - CentralPay Documentation\" \/>\n<meta property=\"og:description\" content=\"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 […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/\" \/>\n<meta property=\"og:site_name\" content=\"CentralPay Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-08-26T14:26:29+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/enrollment-request\\\/\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/enrollment-request\\\/\",\"name\":\"Enrollment request - CentralPay Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#website\"},\"datePublished\":\"2025-06-30T09:58:30+00:00\",\"dateModified\":\"2026-08-26T14:26:29+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/enrollment-request\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/enrollment-request\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/enrollment-request\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/home\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Merchant management\",\"item\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/documentation\\\/documentation\\\/merchant-management\\\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Enrollment request\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/\",\"name\":\"CentralPay Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#organization\",\"name\":\"CentralPay Documentation\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2023\\\/07\\\/logo-centralpay-2023.png\",\"contentUrl\":\"https:\\\/\\\/docs.centralpay.com\\\/wp-content\\\/uploads\\\/2023\\\/07\\\/logo-centralpay-2023.png\",\"width\":2382,\"height\":370,\"caption\":\"CentralPay Documentation\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.centralpay.com\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Enrollment request - CentralPay Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/","og_locale":"en_US","og_type":"article","og_title":"Enrollment request - CentralPay Documentation","og_description":"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 […]","og_url":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/","og_site_name":"CentralPay Documentation","article_modified_time":"2026-08-26T14:26:29+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/","url":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/","name":"Enrollment request - CentralPay Documentation","isPartOf":{"@id":"https:\/\/docs.centralpay.com\/en\/#website"},"datePublished":"2025-06-30T09:58:30+00:00","dateModified":"2026-08-26T14:26:29+00:00","breadcrumb":{"@id":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/enrollment-request\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/docs.centralpay.com\/en\/home\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/"},{"@type":"ListItem","position":3,"name":"Merchant management","item":"https:\/\/docs.centralpay.com\/en\/documentation\/documentation\/merchant-management\/"},{"@type":"ListItem","position":4,"name":"Enrollment request"}]},{"@type":"WebSite","@id":"https:\/\/docs.centralpay.com\/en\/#website","url":"https:\/\/docs.centralpay.com\/en\/","name":"CentralPay Documentation","description":"","publisher":{"@id":"https:\/\/docs.centralpay.com\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.centralpay.com\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.centralpay.com\/en\/#organization","name":"CentralPay Documentation","url":"https:\/\/docs.centralpay.com\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.centralpay.com\/en\/#\/schema\/logo\/image\/","url":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2023\/07\/logo-centralpay-2023.png","contentUrl":"https:\/\/docs.centralpay.com\/wp-content\/uploads\/2023\/07\/logo-centralpay-2023.png","width":2382,"height":370,"caption":"CentralPay Documentation"},"image":{"@id":"https:\/\/docs.centralpay.com\/en\/#\/schema\/logo\/image\/"}}]}},"author_avatar":"https:\/\/secure.gravatar.com\/avatar\/f26ba73d1afc0520e4b1044ff088c0eda58eeaf8c325f16e76f4f944099091cc?s=96&d=mm&r=g","author_name":"Victor","_links":{"self":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16494","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/comments?post=16494"}],"version-history":[{"count":4,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16494\/revisions"}],"predecessor-version":[{"id":16574,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16494\/revisions\/16574"}],"up":[{"embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/docs\/16512"}],"wp:attachment":[{"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/media?parent=16494"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_tag?post=16494"},{"taxonomy":"doc_badge","embeddable":true,"href":"https:\/\/docs.centralpay.com\/en\/wp-json\/wp\/v2\/doc_badge?post=16494"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}