> For the complete documentation index, see [llms.txt](https://dev.ropo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ropo.com/guides/general-add-ons/onboarding.md). # Onboarding Create a new customer profile in Ropo One via the REST API. ### Prerequisites * You have an API token. See [Authentication](/guides/basics/authentication.md). * Your contract enables `create_customer_api`. ### Create a customer profile Send a `POST` request with the customer payload. When creating a new profile through the Ropo One REST API, **only two data fields are mandatory** * **customer\_info.business\_id** * **contact\_person.email** With these two data fields, Ropo One can initiate the **onboarding process**. In this process: 1\. An **onboarding link** is sent to the contact person’s email address. 2\. When the link is opened, the user is guided to an **onboarding wizard**, where all remaining required information is collected. Ropo One requires several mandatory data fields to create a new profile and the first admin user for that profile. If all required fields are provided through the REST API, the onboarding process is skipped entirely. ## Create a new Ropo one Profile > Creates a new Ropo One profile if the contract 'create\_customer\_api' is active for the authenticated user. ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"profile","description":"Customer profile"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"CreateProfileRequest":{"title":"CreateProfileRequest","description":"Profile creation payload","properties":{"allowIncompleteData":{"description":"Whether incomplete data is allowed. When true and required fields are missing, the profile is stored for later completion instead of created.","type":["boolean","null"]},"customer_info":{"$ref":"#/components/schemas/CreateProfileCustomerInfo","description":"Customer (company) information"},"customer_service_contact":{"$ref":"#/components/schemas/CreateCustomerServiceContact","description":"Customer service contact information"},"contact_person":{"$ref":"#/components/schemas/CreateCustomerContactPerson","description":"Contact person"},"agreement_acceptor":{"$ref":"#/components/schemas/CreateCustomerAgreementAcceptor","description":"Agreement acceptor"},"money_laundering_acceptor":{"$ref":"#/components/schemas/CreateCustomerMoneyLaunderingAcceptor","description":"Money laundering acceptor"},"services":{"$ref":"#/components/schemas/CreateProfileServices","description":"Services information"},"invoicing_service_settings":{"$ref":"#/components/schemas/CreateProfileInvoicingServiceSettings","description":"Invoicing service settings"},"reminder_service_settings":{"$ref":"#/components/schemas/CreateProfileReminderServiceSettings","description":"Reminder service settings"},"settlement_settings":{"$ref":"#/components/schemas/CreateCustomerSettlementSettings","description":"Settlement settings"},"ropo_service_fees":{"$ref":"#/components/schemas/CreateProfileRopoServiceFees","description":"Ropo service fees"},"additional_information":{"$ref":"#/components/schemas/CreateCustomerAdditionalInformation","description":"Additional information"},"users":{"description":"Users","type":["array","null"],"items":{"$ref":"#/components/schemas/CreateCustomerUser"}},"primary_contact_same":{"description":"Use the admin user as the contact person","type":["mixed","null"]},"agreement_approver_same":{"description":"Use the admin user as the agreement acceptor","type":["mixed","null"]},"kyc_contact_same":{"description":"Use the admin user as the money laundering acceptor","type":["mixed","null"]}},"type":"object"},"CreateProfileCustomerInfo":{"title":"CreateProfileCustomerInfo","description":"Customer (company) information","properties":{"business_id":{"description":"Business ID / Personal identification number","type":["string","null"]},"name":{"description":"Name","type":["string","null"]},"street_address":{"description":"Street address","type":["string","null"]},"street_address2":{"description":"Street address 2","type":["string","null"]},"postal_code":{"description":"Postal code","type":["string","null"]},"town_or_city":{"description":"Town or city","type":["string","null"]},"country":{"description":"Country","type":["string","null"]},"language":{"description":"Language","type":["string","null"]},"currency":{"description":"Currency","type":["string","null"]},"turnonver_per_year":{"description":"Turnover per year","type":["integer","null"]},"liable_to_pay_vat":{"description":"Is the customer liable to pay VAT","type":["boolean","null"]},"vat_number":{"description":"VAT number","type":["string","null"]},"customer_company_type":{"description":"Customer type","type":["integer","null"]},"service_model":{"description":"Service model","type":["string","null"]}},"type":"object"},"CreateCustomerServiceContact":{"title":"CustomerServiceContact","properties":{"telephone":{"description":"Telephone","type":["string","null"]},"email":{"description":"Email","type":["string","null"]}},"type":"object"},"CreateCustomerContactPerson":{"title":"ContactPerson","properties":{"name":{"description":"Name","type":["string","null"]},"telephone":{"description":"Telephone","type":["string","null"]},"email":{"description":"Email","type":["string","null"]}},"type":"object"},"CreateCustomerAgreementAcceptor":{"title":"AgreementAcceptor","properties":{"verification_method":{"description":"Verification method","type":["string","null"]},"email":{"description":"Email","type":["string","null"]}},"type":"object"},"CreateCustomerMoneyLaunderingAcceptor":{"title":"MoneyLaunderingAcceptor","properties":{"verification_method":{"description":"Verification method","type":["string","null"]},"name":{"description":"Name","type":["string","null"]},"ssn":{"description":"Social Security Number","type":["string","null"]},"telephone":{"description":"Telephone","type":["string","null"]},"email":{"description":"Email","type":["string","null"]},"aml_is_authorized":{"description":"AML is authorized. If true, agreement acceptor and kyc verifier are the same person.","type":["string","null"]}},"type":"object"},"CreateProfileServices":{"title":"Services","properties":{"service_types":{"description":"Service types to activate","type":"array","items":{"type":"integer"}}},"type":"object"},"CreateProfileInvoicingServiceSettings":{"title":"InvoicingServiceSettings","properties":{"terms_of_payment_days":{"description":"Terms of payment in days","type":["integer","null"]},"notice_period_days":{"description":"Notice period in days","type":["integer","null"]},"notice_text":{"description":"Notice text","type":["string","null"]}},"type":"object"},"CreateProfileReminderServiceSettings":{"title":"ReminderServiceSettings","properties":{"number_of_reminders":{"description":"Number of reminders","type":["integer","null"]},"reminder_layout":{"description":"Reminder layout","type":["mixed","null"]},"due_date_text":{"description":"Due date text","type":["mixed","null"]}},"type":"object"},"CreateCustomerSettlementSettings":{"title":"SettlementSettings","properties":{"settlement_cycle":{"description":"Settlement cycle","type":["integer","null"]},"bank_account_type":{"description":"Bank account type","type":["integer","null"]},"bank_account_number":{"description":"Bank account number","type":["string","null"]},"bic":{"description":"Bic","type":["string","null"]},"bank_account_owner":{"description":"Bank account owner","type":["string","null"]},"reference_length":{"description":"Reference length (SE & NO only)","type":["integer","null"]}},"type":"object"},"CreateProfileRopoServiceFees":{"title":"RopoServiceFees","properties":{"payer_is_this_company":{"description":"Payer is this company","type":["boolean","null"]},"invoicing_method":{"description":"Invoicing method (1=post, 2=email, 3=B2B e-invoice, 4=Peppol)","type":["integer","null"]},"invoicing_email_address":{"description":"Invoicing email address","type":["string","null"]},"evoice_address":{"description":"E-invoice address","type":["string","null"]},"broker_id":{"description":"E-invoice broker id","type":["string","null"]}},"type":"object"},"CreateCustomerAdditionalInformation":{"title":"AdditionalInformation","properties":{"customer_group":{"description":"Customer group","type":["string","null"]},"operator_id":{"description":"Operator ID","type":["string","null"]},"profile_uuid":{"description":"Profile UUID","type":["string","null"]}},"type":"object"},"CreateCustomerUser":{"title":"User","properties":{"first_name":{"description":"First name","type":["string","null"]},"last_name":{"description":"Last name","type":["string","null"]},"street_address":{"description":"Street address","type":["string","null"]},"postal_code":{"description":"Postal code","type":["string","null"]},"town_or_city":{"description":"Town or city","type":["string","null"]},"country":{"description":"Country","type":["string","null"]},"nationality":{"description":"Nationality","type":["string","null"]},"ssn":{"description":"Social Security Number","type":["string","null"]},"phone_number":{"description":"Phone number","type":["string","null"]},"email":{"description":"Email","type":["string","null"]},"language":{"description":"Language","type":["string","null"]},"user_level":{"description":"User level","type":["string","null"]}},"type":"object"},"NewCustomerResultRest":{"title":"NewCustomerResultRest","description":"NewCustomerResultRest","properties":{"customerId":{"description":"Customer ID of the newly created customer","type":["string","null"]},"message":{"description":"Message regarding the creation result","type":["string","null"]},"status":{"description":"Status of the customer creation process","type":["string","null"]}},"type":"object"},"IncompleteCustomerResult":{"title":"IncompleteCustomerResult","description":"Response object for incomplete customer creation operations","properties":{"uuid":{"description":"Unique identifier for the incomplete customer record","type":["string","null"]},"status":{"description":"HTTP status code or operation status","type":["string","null"]},"message":{"description":"Human-readable message describing the result","type":["string","null"]},"wizard_url":{"description":"Ropo One URL where to continue the onboarding process","type":["string","null"]}},"type":"object"},"HttpApiProblem":{"title":"HttpApiProblem","description":"HttpApiProblem","properties":{"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem","type":["integer","null"]},"type":{"description":"A URI reference that identifies the problem type","type":["string","null"]},"title":{"description":"A short, human-readable summary of the problem type","type":["string","null"]},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem","type":["string","null"]}},"type":"object"}}},"paths":{"/profile/createprofile":{"post":{"tags":["profile"],"summary":"Create a new Ropo one Profile","description":"Creates a new Ropo One profile if the contract 'create_customer_api' is active for the authenticated user.","operationId":"createCustomerAction","requestBody":{"description":"Profile creation payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileRequest"}}}},"responses":{"200":{"description":"Customer created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCustomerResultRest"}}}},"201":{"description":"Incomplete customer data added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncompleteCustomerResult"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HttpApiProblem"},{"$ref":"#/components/schemas/NewCustomerResultRest"}]}}}},"403":{"description":"Create customer contract not active","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}}}}}}} ``` #### All mandatory and optional dataset tags
CategoryTagMandatoryExample valueAdditional information
customer_infobusiness_idyes1234567-8

Business ID

(or social security number)

This cannot be changed afterwards.

namenoTest Company LtdIf not given --> onboarding wizard
street_addressnoStreet 10 A 2If not given --> onboarding wizard
street_address2noHouse BAdditional street address
postal_codeno00100If not given --> onboarding wizard
town_or_citynoHelsinkiIf not given --> onboarding wizard
countrynoFIN

3-char country code

If not given --> onboarding wizard

languagenofin

fin, eng, swe, nor

if not given, default by country

currencynoEUR

EUR, SEK or NOK

If not given --> onboarding wizard

liable_to_pay_vatno1

1=yes, 2=no

If not given --> onboarding wizard

vat_numbernoFI12345678

If liable_to_pay_vat=2, then is not mandatory

If not given --> onboarding wizard

customer_company_typeno2

Company types:

1. Corporate and Community customer

--> Fin: Yritys- ja yhteisöasiakas

2. Sole Proprietor

--> Fin: Yksityinen

elinkeinonharjoittaja

3. Housing Company

--> Fin: Asunto-osakeyhtiö

4. Associations

--> Fin: Yhdistykset

5. Foundations

--> Fin: Säätiöt

6. Mutual Real Estate

Companies

--> Fin: Keskinäiset

kiinteistöosakeyhtiöt

7. Religious Community

--> Fin: Uskonnollinen yhdyskunta

8. Foreign Entities

--> Fin: Ulkomaiset yhteisöt

9. General/Limited Partnership

--> Fin: Henkilöyhtiö (Ay / Ky)

10. Public Law Entity

--> Fin: Julkisoikeudellinen yhteisö

If not given --> onboarding wizard (Mandatory only in Finland)

customer_service_contacttelephoneno+35844123456If not given --> onboarding wizard
emailnoinfo@test.comIf not given --> onboarding wizard
wwwnowww.test.comIf not given --> onboarding wizard
contact_personnamenoJohn DoeIf not given --> onboarding wizard
telephoneno+35844123456If not given --> onboarding wizard
emailyesjohn.doe@test.comIf onboarding-wizard is needed, onboarding-email is sent to this address. Onboarding email has a link to the onboarding-wizard.
agreement_acceptoremailnojohn.doe@test.com

Email with a link is sent to this email address for accepting Ropo One service agreement. Person eligibility is checked from official register after strong authentication.

If not given when needed, contact_person email is used

money_laundering_acceptoremailnojohn.doe@test.com

Email with a link is sent to this email address for filling up KYC-questionnaire form. Person eligibility is checked from official register after strong authentication.

Mandatory only in Finland (ropo24.fi).

If not given when needed, contact_person email is used

servicesservice_typesno1

0. Printing service

1. Invoicing service

2. Reminder service

3. Debt Collection service

4. Sending e-invoices (B2B)

If none given any --> onboarding wizard.

More services can be opened in Ropo One user interface after first login.

settlement_settingsbank_account_typeno0

0= iban

1= bban

2= plusgiro

3= bankgiro

iban,bban, plusgiro,bankgiro

If not given --> onboarding wizard

bank_account_numbernoFI12345678987623If not given --> onboarding wizard
bank_account_ownernoTest Company Ltd

For banks VoP-process

If not given --> onboarding wizard

reference_lengthno10Only in Nor & Swe
ropo_service_feesinvoicing_methodno2

1= post

2= email

3= einvoice

4= peppol

If not given --> onboarding wizard

invoicing_email_addressyes /noinfo@test.com

When method = email

If not given --> onboarding wizard

evoice_addressyes /no00123456789

When method = einvoice or peppol

If not given --> onboarding wizard

broker_idyes /no00371234455

When method = einvoice

If not given --> onboarding wizard

additional_informationprofile_uuidno123456789You can provide your platforms customer unique ID. This is useful, if you have a dedicated endpoint for new profile's Ropo One REST API keys.

users

first_nameno If not given --> onboarding wizard
last_nameno If not given --> onboarding wizard
street_addressno If not given --> onboarding wizard
postal_codeno If not given --> onboarding wizard
town_or_cityno If not given --> onboarding wizard
countryno FIIf not given --> onboarding wizard
nationalitynoFIN
ssnno Social Security Number
phone_numberno If not given --> onboarding wizard
emailno If not given --> onboarding wizard
languageno finIf not given --> onboarding wizard
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://dev.ropo.com/guides/general-add-ons/onboarding.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.