Getting Started

Prerequisites

Before you begin integration, ensure you have the following:

Requirement	Description
Admin invitation	An OpenSylo admin must invite your marketplace. You'll receive an email with a registration link.
Registration complete	Complete the multi-step onboarding (business info, phone verification, signatory details, documents).
OAuth credentials	After registration, your `client_id` and `client_secret` are available in the dashboard. The secret is shown only once at creation — store it securely.
Redirect URI(s)	One or more callback URLs registered with OpenSylo where authorization codes will be sent.
Webhook endpoint (optional)	An HTTPS endpoint on your server to receive loan lifecycle events from OpenSylo.
Webhook secret (optional)	An API secret configured on your marketplace for signing inbound webhooks you send to OpenSylo.

Step 1 — Accept the Invitation

You will receive an email from OpenSylo with a registration link:

https://opensylo.com/marketplace/register?token=inv_<token>

The invitation token is valid for 7 days and can only be used once. Complete the registration form to create your marketplace account and activate your credentials.

Step 2 — Retrieve Your Credentials

After registration, log in to the OpenSylo Dashboard to view and manage your OAuth credentials (client_id, client_secret), redirect URIs, and webhook settings. Credential generation and regeneration are handled entirely through the dashboard.

Important: The client secret is shown only once at creation. Store it securely. If lost, regenerate it via the dashboard.

Authentication Summary

Method	Used For	How to Obtain	Lifetime
OAuth Access Token	Data and Loan API endpoints	OAuth Authorization Code + PKCE flow	1 hour
OAuth Refresh Token	Refreshing expired access tokens	Returned with initial token exchange	30 days
Webhook Signature	Inbound webhooks (`/api/v1/webhooks/marketplace/*`)	HMAC-SHA256 using your API secret	Per-request

Available Scopes

When requesting OAuth authorization, include the scopes your integration needs:

Scope	Description
`data.share.sales`	Share sales and GMV data with OpenSylo
`data.share.fulfillment`	Share order fulfillment and delivery metrics
`data.share.payouts`	Share payout and cash flow information
`data.share.risk`	Share account status and risk information
`data.share.profile`	Share merchant business profile information
`credit.score.read`	Access credit scores calculated by OpenSylo
`repayment.report`	Report loan repayments collected from merchant sales

Next Steps

Implement the OAuth 2.0 flow to obtain merchant consent and tokens

Submit merchant data via the Data Ingestion API

Set up webhook handlers for loan lifecycle events

Use the Loan API to query active loans and validate deductions

Test everything in the sandbox environment before going live

Prerequisites#

Step 1 — Accept the Invitation#

Step 2 — Retrieve Your Credentials#

Authentication Summary#