Introduction

What is OpenSylo?

OpenSylo is a credit infrastructure platform that enables marketplaces to share merchant data for credit scoring and lending. Marketplace partners connect via OAuth 2.0, share merchant performance data, and receive credit scores that lenders use to make loan decisions.

Architecture Overview

                Marketplace (Partner)          OpenSylo Platform  
                +------------------+          +------------------+
                |                  |  OAuth   |                  |
                |  Your Platform   |<-------->|   API Gateway    |
                |                  |          |                  | 
                |  Merchant Data   |--------->|  Credit Scoring  |
                |  Submission      |  Data    |  Engine          |
                |                  | Ingest   |                  | 
                |  Webhook         |<---------|  Webhook         |
                |  Handler         | Events   |  Dispatcher      |
                +------------------+          +------------------+

Integration Flow

The end-to-end integration follows these steps:

Invitation — An OpenSylo admin invites your marketplace. You receive an email with a registration link.

Registration — Complete the multi-step onboarding process (business info, phone verification, signatory details, documents).

Credentials — After registration, your client_id and client_secret are available in the dashboard. The secret is shown only once at creation.

OAuth Authorization — A merchant on your platform grants consent via the OAuth 2.0 Authorization Code flow with PKCE. You receive an access token and refresh token.

Data Submission — Submit the merchant's performance data (sales, fulfillment, payout, risk metrics) to OpenSylo using the access token.

Credit Scoring — OpenSylo calculates a credit score and returns it in the data submission response.

Loan Decision — Lenders on the OpenSylo platform use the credit score to make loan decisions.

Webhook Notifications — OpenSylo sends outbound webhooks to notify your marketplace of loan lifecycle events (approval, disbursement, repayment changes, completion).

Repayment Collection — Your marketplace deducts repayments from merchant settlements and reports them to OpenSylo via inbound webhooks.

Key Concepts

Concept	Description
Marketplace	Your platform — an e-commerce marketplace, payment gateway, or similar platform with merchant data.
Merchant	A seller/vendor on your marketplace who consents to share data for credit scoring.
OAuth Consent	The merchant explicitly grants permission for your marketplace to share their data with OpenSylo.
Credit Score	A 0-100 score calculated from submitted merchant data, with risk tiers A (best) through E (worst).
Lending Cap	The maximum loan amount a lender can offer to a merchant, derived from the credit score.
Deduction	A percentage of each merchant sale that is withheld to repay an active loan.

API Groups

The marketplace API is organized into these groups:

Group	Purpose
Marketplace Dashboard	Login, view and manage OAuth credentials
OAuth 2.0	Authorization code flow, token exchange, revocation, discovery
Data Ingestion	Submit merchant data, retrieve credit scores, health check
Loan API	Query active loans, check status, validate deduction amounts
Inbound Webhooks	Your marketplace sends repayment and settlement events to OpenSylo
Outbound Webhooks	OpenSylo sends loan lifecycle events to your marketplace
Sandbox	Test environment with pre-seeded merchants and simulated credit scores

Base URL

All API requests use the same base URL for both production and sandbox:

https://api.opensylo.com

Sandbox mode is automatically detected by the sb_ prefix on your client_id. No separate URL or configuration is needed.

What is OpenSylo?#

Architecture Overview#

Integration Flow#

Key Concepts#