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"
}