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
    • Print and Distribution service
      • Overview
    • Operations
      • Overview
  • 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
      • Retrieve distribution Information MV v2
    • Payments
      • Introduction to Payments
      • Retrieve Payments
      • Retrieve settlements
    • Accounting
      • Introduction to accounting
      • Invoice
        • Invoice
      • Ledger
        • Ledger
        • Ledger
      • Payment
        • Payment
        • Payment
    • Operations
      • Retrieve Finvoice Credentials
  • Schemas
    • Finvoice Credentials Response
    • Invoice Header object
    • Invoice Parties
    • Invoice Attachments
    • InvoiceExtensions
    • Client Settings
    • Accounting
    • Address
    • BuyerParty
    • Collection
    • Collection Costs
    • Collection Interest
    • Contact
    • Contact Person
    • Definition Detail
    • Delivery Party
    • Distribution
    • Factoring
    • Interest
    • InvoiceAmounts
    • Invoice Content Data
    • Invoice Recipient Party
    • InvoiceReferences
    • InvoiceRowData
    • InvoiceTerms
    • PaymentData
    • Payment Details
    • PaymentState
    • PaymentTerms
    • Processing
    • SalesInvoiceRequest
    • Seller Party
Need help?
  1. Onboarding

Introduction to onboarding

The Onboarding module is how you provision new clients in the Partner API. It covers creating a client account and managing access tokens (validate and renew).

Onboarding options#

Two ways to onboard new clients:
Automated onboarding (recommended) — Your system calls the API to create the client and receive credentials. Use this when you can drive the flow from your own product.
Manual onboarding — The Confirma Finance deployment team provisions the client. Use this when you are not using the API-driven flow (for example, while you are still integrating, or your process cannot start from the API).
Here are both options explained in more detail:
Automated Onboarding
Manual Onboarding
We recommend building a flow in your system that calls the API to start onboarding. When your system initiates onboarding that way, the process runs as follows.
onboarding_automated_2.png
Automated process flow
What your app does (partner-side flow)
1.
Your application presents the client with an onboarding form.
2.
Known client details are prefilled from system settings and attributes.
3.
The client reviews and completes any missing information, and is presented with the terms and conditions.
4.
The client selects a service type and accepts the terms — both are required to proceed.
5.
The client submits the form, triggering account creation in CFIS.
6.
On success, CFIS returns the new client account credentials, including the API access token.
7.
Your application saves the credentials to local database and activates the CFIS integration for the client.

Endpoints Overview#

In the automated flow you typically:
1.
Create a client and receive an access token
2.
Validate a token when your service starts or on sensitive operations
3.
Renew the token periodically.
Manual onboarding may deliver credentials out of band; once you have a token, validation and renewal work the same.
EndpointMethodDescription
Create a new clientPOSTCreates a new client account.
Validate access tokenGETConfirms that the access token is valid.
Renew access tokenGETInitiates token renewal.
Note
To use Create a new client, you must authenticate with the Partner Provisioning Token when you submit the payload. If you have not yet received one, please contact us to retrieve the proper token.

What happens after you call the API#

Once CFIS receives an onboarding request via the API, it performs the following steps:
1
Validation
Incoming client information is validated. If any details are invalid or missing, CFIS responds immediately with a detailed error message.
2
Account creation
The client account is created and activated. The client is now registered as a new user in the Partner API Service.
3
Credential delivery
CFIS returns a response to the partner system containing the client's credentials, including the API access token and associated attributes.
4
Ready for production
The client account is immediately active. The client can begin communicating via the API.
Good to remember!
Once your client has received the valid access token, they are ready to start to use the service in production. All data submitted is considered as production-ready and will be automatically handled by the system

What if onboarding fails?#

Onboarding can fail for several reasons. In most cases the API responds with an error immediately and no client account is created.

1. Request validation failed#

Required fields are missing, values are in the wrong format, or business rules reject the payload.
What to do:
Read the error message and any field-level details in the response body.
Fix the payload and retry the same call after correction.
Show a clear message in your UI so the end user can correct information where appropriate.

2. Authentication / authorization failed (Partner Provisioning Token)#

The request was not authenticated correctly for provisioning.
What to do:
Verify you are using the Partner Provisioning Token exactly as documented.

3. Duplicate or conflicting client#

The system detects that this client already exists.
What to do:
If the client already exists, switch to your “existing client” path: Validate or Renew tokens as needed rather than creating again.

4. Transient errors (timeouts, 5xx, network)#

The failure may not reflect a bad payload.
What to do:
Retry with exponential backoff and a small maximum retry count.
Need help?
If you are unable to complete onboarding or requests keep failing after you have checked the payload and authentication, contact us and we will help you through the next steps.
Contact us
Previous
Overview
Next
Create a new client
Built with