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
        • Validate access token
        • Renew access token
      • 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?

    Go Live & Deployment Guide

    Once your API endpoints are implemented and tested in the staging environment, the next stage is going live with the API client. This page outlines the recommended steps to onboard clients and launch your integration smoothly.

    Step 1: Client Onboarding#

    Purpose: To establish the new client account and provide the necessary credentials for live operations, and also securing the use of the proper service.
    Options:
    1
    Automated onboarding
    Use the onboarding functionality to initiate client onboarding and service connections.
    Best when completed directly from the partner system.
    2
    Deployment request
    Submit a deployment request via Deployment Services team to initiate client onboarding.
    Recommended if you are unsure about the process.
    Key Actions:
    1.
    Collect the client’s basic details (name, creditor account, contact info).
    2.
    Assign the correct service type (Invoice Lifecycle, Invoice Intermediation or Debt Collection).
    3.
    Initiate the onboarding process either with Deployment Services, or using the onboarding functionality.
    4.
    Verify permissions and ensure the client is linked to the correct creditor account.
    What happens next:
    1.
    The deployment process creates the required client accounts, configurations, and service access.
    2.
    As a result, a client-specific API access token is generated for use when communicating with the service.
    3.
    The client account is activated and ready to be used as a service user account.
    You will be notified once the setup is complete.
    Important note
    Contact the Deployment Services team before onboarding your first client.

    Step 2: Verify Integration in Production#

    Purpose: To ensure your implementation functions correctly with real data.
    Checklist:
    1.
    Confirm that the client-specific access token works with production endpoints.
    2.
    Execute a test invoice creation or payment retrieval for the client.
    3.
    Verify the expected responses, including HTTP codes and data formats.
    4.
    Check that notifications, reminders, and settlement workflows are triggered correctly (if the Invoice Lifecycle is in use).
    Important note
    Compare staging vs production behavior for key workflows before full deployment.

    Step 3: Go-Live Confirmation#

    Purpose: Officially enable the client to start using the live API.
    Actions:
    1.
    Notify the client that production access is active.
    2.
    Monitor the first live requests for errors or unexpected behavior.
    3.
    Validate that settlements, reminders, or collection processes execute correctly.
    4.
    Enable monitoring and alerting for ongoing operations.
    Important note
    Schedule a follow-up review with the client after the first live cycle to ensure everything works smoothly.

    Step 4: Post Go-Live Support (optional)#

    Purpose: Minimize disruptions and address any issues promptly.
    1.
    Provide access to support channels (email or ticketing).
    2.
    Document common errors and solutions for the client.
    3.
    Regularly review token usage and rotate tokens as part of security best practices.

    Confirma Finance Deployment Services Overview#

    Our Deployment Services are designed to support developers throughout the entire Go-Live process, ensuring a smooth onboarding experience for new clients and minimizing integration risk.
    These services provide guidance, automation, and monitoring at every stage, so you can focus on delivering value without worrying about operational hurdles.
    Key Benefits for Developers:
    1.
    Client Onboarding Support
    Assistance with registering new clients and configuring creditor accounts.
    Guidance on generating and managing production access tokens.
    Verification that client permissions and service assignments are correct.
    2.
    Integration Verification
    Tools to test API endpoints with production data safely.
    Automated checks to ensure settlement workflows, reminders, and collections operate as expected.
    Validation of error handling and response formats before full deployment.
    3.
    Go-Live Assistance
    Step-by-step guidance for activating new clients.
    Monitoring of initial live requests to catch issues early.
    Recommendations for best practices in scaling the integration to multiple clients.
    4.
    Post-Go-Live Monitoring and Support
    Continuous monitoring of API requests and token usage.
    Alerts for errors, failed settlements, or collection exceptions.
    Advice on token rotation, security, and operational maintenance.
    Why it matters
    With Deployment Services assistance, developers can confidently move from testing to production, reduce the risk of integration errors, and provide clients with a seamless experience from day one.
    Previous
    Contact information
    Next
    Services
    Built with