1. Onboarding
Confirma Finance Integrations API
  • Introduction
  • Authentication
  • Environments
  • Data validation
  • Contact information
  • Go Live & Deployment Guide
  • Services
    • Services
    • Invoice Intermediation service
    • Invoice Lifecycle Service
    • Debt Collection Services
    • Accounting integrations
  • Core endpoints
    • Onboarding
      • Introduction to onboarding
      • Create a new client
        POST
      • Validate access token
        GET
      • Renew access token
        GET
    • Invoices
      • Introduction to Invoices
      • Create an invoice
      • Create an Invoice Action
      • Retrieve case details
      • Retrieve distribution Information
    • Payments
      • Introduction to Payments
      • Retrieve Payments
      • Retrieve settlements
    • Accounting
      • Introduction to accounting
      • Invoice
        • Invoice
      • Ledger
        • Ledger
        • Ledger
      • Payment
        • Payment
        • Payment
Need help?
  1. Onboarding

Introduction to onboarding

The Onboarding module is the entry point for provisioning new clients within the Partner API Service. It covers client account creation, and the ongoing management of client access tokens — including validation and renewal.
Under development
The onboarding endpoints are currently under active development.
Until they are generally available, new clients are provisioned manually through the Confirma Finance deployment process. See the Deployment Request section below for instructions.

Endpoints Overview#

Create a new client POST (in development)
Creates a new client account within the Partner API Service. The payload includes the client's business details, service type, partner code, and contact persons.
Partner uses the Partner Provisioning Token when submitting new clients.
On success, the service returns a client identifier, a Confirma Finance customer code, a payment reference prefix, and the client's initial API access token.
Validate access token GET (in development)
Validates the current API key and returns its status. Use this endpoint to confirm that a client's access token is active and has not expired before making further requests.
Renew access token GET (in development)
Initiates renewal of a client's access token. The current API key is passed in the request header, and a new access token is returned in the response. This endpoint is also used when renewing tokens that have reached their expiration date.

Onboarding process#

onboarding_lifecycle.svg
Onboarding process

Deployment request#

Until the client creation endpoint is generally available, new clients are onboarded by the Confirma Finance deployment team.
To submit a deployment request, send an email to deployment@cash-in.fi with the following information:
Full business name and business code
Address information
Contact persons (primary, technical, and accountant)
Type of service (Lifecycle, Intermediation, or Co-Op)
Accounting system, if applicable
Please also include the name and email of the person in your organization who will be responsible for completing the onboarding process with the client. Once deployment is complete, credentials and onboarding instructions will be sent to that person directly.
Previous
Accounting integrations
Next
Create a new client
Built with