Onboarding

Create a new customer profile in Ropo One via the REST API.

Prerequisites

• You have an API token. See Authentication.

• 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

post

Creates a new Ropo One profile if the contract 'create_customer_api' is active for the authenticated user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"allowIncompleteData":true,"customer_info":{"business_id":"1234567-8","name":"Test Company","street_address":"Main St 1","postal_code":"00100","town_or_city":"Helsinki","country":"FI","language":"fin","liable_to_pay_vat":1,"vat_number":"FI12345678","customer_company_type":1},"customer_service_contact":{"telephone":"[phone]","email":"[email protected]","www":"https://test.com"},"contact_person":{"name":"John Doe","telephone":"[phone]","email":"[email protected]"},"agreement_acceptor":{"email":"[email protected]"},"money_laundering_acceptor":{"email":"[email protected]"},"services":{"service_types":[1,2,3]},"settlement_settings":{"bank_account_type":0,"bank_account_number":"FI2112345600000785","bank_account_owner":"Test Company","reference_length":10},"ropo_service_fees":{"invoicing_method":"1","invoicing_email_address":"[email protected]"},"additional_information":{"profile_uuid":"a3029a45-2608-4c9c-a8ce-93fcbcb733a7"},"users":[{"first_name":"Jane","last_name":"Doe","street_address":"Main St 2","postal_code":"00100","town_or_city":"Helsinki","country":"FI","nationality":"FIN","phone_number":"[phone]","email":"[email protected]","language":"fin"}]}

Responses

200

Customer created successfully

application/json

NewCustomerResultRest

customerIdstring · nullableOptional

Customer ID of the newly created customer

Example: 123456

messagestring · nullableOptional

Message regarding the creation result

Example: Customer created successfully.

statusstring · nullableOptional

Status of the customer creation process

Example: success

201

Incomplete customer data added successfully.

application/json

400

Invalid request

application/json

403

Create customer contract not active

application/json

post

/profile/createprofile

HTTPcURLJavaScriptPython

POST /rest/profile/createprofile HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1178

{
  "allowIncompleteData": true,
  "customer_info": {
    "business_id": "1234567-8",
    "name": "Test Company",
    "street_address": "Main St 1",
    "postal_code": "00100",
    "town_or_city": "Helsinki",
    "country": "FI",
    "language": "fin",
    "liable_to_pay_vat": 1,
    "vat_number": "FI12345678",
    "customer_company_type": 1
  },
  "customer_service_contact": {
    "telephone": "[phone]",
    "email": "[email protected]",
    "www": "https://test.com"
  },
  "contact_person": {
    "name": "John Doe",
    "telephone": "[phone]",
    "email": "[email protected]"
  },
  "agreement_acceptor": {
    "email": "[email protected]"
  },
  "money_laundering_acceptor": {
    "email": "[email protected]"
  },
  "services": {
    "service_types": [
      1,
      2,
      3
    ]
  },
  "settlement_settings": {
    "bank_account_type": 0,
    "bank_account_number": "FI2112345600000785",
    "bank_account_owner": "Test Company",
    "reference_length": 10
  },
  "ropo_service_fees": {
    "invoicing_method": "1",
    "invoicing_email_address": "[email protected]"
  },
  "additional_information": {
    "profile_uuid": "a3029a45-2608-4c9c-a8ce-93fcbcb733a7"
  },
  "users": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "street_address": "Main St 2",
      "postal_code": "00100",
      "town_or_city": "Helsinki",
      "country": "FI",
      "nationality": "FIN",
      "phone_number": "[phone]",
      "email": "[email protected]",
      "language": "fin"
    }
  ]
}

{
  "customerId": "123456",
  "message": "Customer created successfully.",
  "status": "success"
}

All mandatory and optional dataset tags

Category	Tag	Mandatory	Example value	Additional information
customer_info	business_id	yes	1234567-8	Business ID (or social security number) This cannot be changed afterwards.
	name	no	Test Company Ltd	If not given --> onboarding wizard
	street_address	no	Street 10 A 2	If not given --> onboarding wizard
	street_address2	no	House B	Additional street address
	postal_code	no	00100	If not given --> onboarding wizard
	town_or_city	no	Helsinki	If not given --> onboarding wizard
	country	no	FIN	3-char country code If not given --> onboarding wizard
	language	no	fin	fin, eng, swe, nor if not given, default by country
	currency	no	EUR	EUR, SEK or NOK If not given --> onboarding wizard
	liable_to_pay_vat	no	1	1=yes, 2=no If not given --> onboarding wizard
	vat_number	no	FI12345678	If liable_to_pay_vat=2, then is not mandatory If not given --> onboarding wizard
	customer_company_type	no	2	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_contact	telephone	no	[phone]	If not given --> onboarding wizard
	email	no	[email protected]	If not given --> onboarding wizard
	www	no	www.test.com	If not given --> onboarding wizard
contact_person	name	no	John Doe	If not given --> onboarding wizard
	telephone	no	[phone]	If not given --> onboarding wizard
	email	yes	[email protected]	If onboarding-wizard is needed, onboarding-email is sent to this address. Onboarding email has a link to the onboarding-wizard.
agreement_acceptor	email	no	[email protected]	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_acceptor	email	no	[email protected]	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
services	service_types	no	1	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_settings	bank_account_type	no	0	0= iban 1= bban 2= plusgiro 3= bankgiro iban,bban, plusgiro,bankgiro If not given --> onboarding wizard
	bank_account_number	no	FI12345678987623	If not given --> onboarding wizard
	bank_account_owner	no	Test Company Ltd	For banks VoP-process If not given --> onboarding wizard
	reference_length	no	10	Only in Nor & Swe
ropo_service_fees	invoicing_method	no	2	1= post 2= email 3= einvoice 4= peppol If not given --> onboarding wizard
	invoicing_email_address	yes /no	[email protected]	When method = email If not given --> onboarding wizard
	evoice_address	yes /no	00123456789	When method = einvoice or peppol If not given --> onboarding wizard
	broker_id	yes /no	00371234455	When method = einvoice If not given --> onboarding wizard
additional_information	profile_uuid	no	123456789	You 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_name	no		If not given --> onboarding wizard
	last_name	no		If not given --> onboarding wizard
	street_address	no		If not given --> onboarding wizard
	postal_code	no		If not given --> onboarding wizard
	town_or_city	no		If not given --> onboarding wizard
	country	no	FI	If not given --> onboarding wizard
	nationality	no	FIN
	ssn	no		Social Security Number
	phone_number	no		If not given --> onboarding wizard
	email	no		If not given --> onboarding wizard
	language	no	fin	If not given --> onboarding wizard