1. OAuth 2.0
marketplace-doc
  • Data Ingestion
  • Errors
  • Introduction
  • Loan API & Deduction Lifecycle
  • Getting Started
  • OAuth
  • Webhooks
  • Embedded Journey
  • OpenSylo Marketplace Integration API
    • OAuth 2.0
      • Start OAuth authorization
      • Exchange authorization code or refresh token
      • Revoke a token
      • Discover OAuth capabilities
    • Data Ingestion
      • Submit single merchant data
      • Submit bulk merchant data
      • Poll batch processing status
      • Get merchant credit score
      • Data ingestion health check
    • Sales & Events
      • Submit a sales event
      • Submit a repayment event
      • Submit an account flag
    • Loan API
      • Get active loans for a merchant
      • Get loan status
      • Validate deduction amounts
      • Bulk loan status
    • Inbound Webhooks
      • Repayment events
      • Settlement events
    • Outbound Webhooks
      • loan.approved
      • loan.disbursed
      • loan.repayment_updated
      • loan.nearly_complete
      • loan.completed
      • loan.defaulted
      • merchant.created
      • kyc.submitted
      • kyc.approved
      • kyc.rejected
      • funding_request.created
      • funding_request.fulfilled
      • funding_request.rejected
    • Embedded Journey (Marketplace API)
      • Create (or fetch) a merchant
      • Get merchant status (KYC, credit score, funding requests)
      • Update business KYC information
      • Add directors (bulk)
      • Attach a KYC document
      • Submit KYC for review
      • Submit sales data for credit scoring
      • Create a funding request
      • Mint an embed token for the hosted journey
  • OpenSylo Marketplace API
    • OAuth 2.0
      • Start OAuth authorization
        GET
      • Exchange code or refresh token
        POST
      • Revoke a token
        POST
      • OAuth discovery / client metadata
        GET
    • Data Ingestion
      • Submit single merchant data
      • Submit bulk merchant data
      • Get merchant credit score
      • Integration health check
    • Loan API
      • Get active loans for a merchant
      • Get loan status
      • Validate deduction amounts
      • Bulk loan status check
    • Inbound Webhooks
      • Send repayment webhook
      • Send settlement webhook
  1. OAuth 2.0

Start OAuth authorization

GET
/oauth/authorize
Redirect the merchant's browser here to start the authorization code flow. The merchant logs in and grants consent. On success, OpenSylo redirects to your redirect_uri with an authorization code and your state. The authorization code expires in 5 minutes.

Request

Query Params

Responses

🔵302
Redirects to the consent page, then back to redirect_uri with ?code=...&state=... on success or ?error=access_denied&state=... on denial.
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/oauth/authorize?client_id=yourmarketplace_client_a1b2c3d4&redirect_uri=https%3A%2F%2Fyourmarketplace.com%2Foauth%2Fcallback&response_type=undefined&scope=data.share.sales%20data.share.profile%20credit.score.read&state=random_csrf_token_123&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=undefined'
Modified at 2026-04-08 17:24:40
Previous
Mint an embed token for the hosted journey
Next
Exchange code or refresh token
Built with