OpenSylo Backend API
  1. Marketplace Dashboard
OpenSylo Backend API
  • API Info
    • API Information
      GET
  • Health
    • HealthController_checkHealth
      GET
    • HealthController_ping
      GET
  • Marketplace Connections
    • Get available marketplaces
      GET
    • Get marketplace catalog
      GET
    • Get marketplace details
      GET
    • Initiate marketplace connection
      POST
    • Disconnect from marketplace
      POST
    • Get connection status
      GET
    • Update marketplace credentials
      POST
    • Handle OAuth callback
      POST
  • Merchant Authentication
    • Register a new merchant account
      POST
    • Authenticate merchant
      POST
    • Verify email address
      POST
    • Resend verification email
      POST
    • Request password reset
      POST
    • Reset password
      POST
    • Change password
      POST
    • Refresh access token
      POST
    • Logout
      POST
    • Get current user profile
      GET
  • MerchantKyc
    • MerchantKycController_getOnboardingStatus
    • MerchantKycController_getKycProgress
    • MerchantKycController_sendOtp
    • MerchantKycController_verifyOtp
    • MerchantKycController_updateBusinessInfo
    • MerchantKycController_addDirector
    • MerchantKycController_addBulkDirectors
    • MerchantKycController_uploadDocument
    • MerchantKycController_submitKyc
    • MerchantKycController_searchBusinessTypes
    • MerchantKycController_getBusinessCategories
    • MerchantKycController_getDocumentTypes
  • Merchants
    • Create a new merchant
    • Get all merchants
    • Get a merchant by ID
    • Update a merchant
    • Delete a merchant
  • Marketplace Data Ingestion
    • Submit Merchant Data
    • Submit Bulk Merchant Data
    • Get Merchant Credit Score
    • Health Check
  • Marketplace Dashboard
    • Complete Marketplace Registration
      POST
    • Marketplace Dashboard Login
      POST
    • Get OAuth Credentials
      GET
    • Regenerate Client Secret
      POST
    • Get Current User
      GET
    • Invite Marketplace (Admin)
      POST
  • OAuth 2.0
    • OAuth Authorization Endpoint
    • Process Authorization Decision
    • Token Endpoint
    • Revoke Token
    • Client Metadata
  • OAuth Authentication
    • Login Page
    • Login Submit
    • Signup Page
    • Signup Submit
    • Logout
  • Lenders
    • Create a new lender
    • Get all lenders
    • Get a lender by ID
    • Update a lender
    • Delete a lender
  • Schemas
    • PlatformDto
    • PlatformConnectionMetadataDto
    • PlatformConnectionInfoDto
    • PlatformListResponseDto
    • ConnectionInitResponseDto
    • ConnectionMetricsDto
    • ConnectionStatusResponseDto
    • DisconnectResponseDto
    • PlatformCatalogResponseDto
    • ConnectPlatformDto
    • DisconnectPlatformDto
    • PlatformCredentialsDto
    • MerchantSignupDto
    • SignupResponseDto
    • MerchantLoginDto
    • LoginResponseDto
    • MerchantVerifyEmailDto
    • EmailVerificationResponseDto
    • MerchantResendVerificationDto
    • GenericSuccessResponseDto
    • MerchantForgotPasswordDto
    • MerchantResetPasswordDto
    • MerchantChangePasswordDto
    • RefreshTokenDto
    • UserProfileResponseDto
    • OtpVerificationDto
    • BusinessKycDto
    • DirectorInfoDto
    • BulkDirectorInfoDto
    • DocumentUploadDto
    • CreateMerchantDto
    • UpdateMerchantDto
    • MarketplaceDataCaptureDto
    • BulkMarketplaceDataCaptureDto
    • CompleteMarketplaceRegistrationDto
    • MarketplaceLoginResponseDto
    • MarketplaceLoginDto
    • MarketplaceCredentialsResponseDto
    • RegenerateSecretResponseDto
    • InviteMarketplaceDto
    • MarketplaceInvitationResponseDto
    • CreateLenderDto
    • UpdateLenderDto
  1. Marketplace Dashboard

Invite Marketplace (Admin)

POST
/api/marketplace-dashboard/admin/invite
Admin Only - Create a new marketplace and send invitation.
What happens:
1.
Creates marketplace record with OAuth credentials
2.
Generates client_id and client_secret
3.
Sends invitation email to technical contact
4.
Returns credentials (store securely!)
IMPORTANT:
The client_secret is only shown ONCE in this response
Store it securely before sharing with marketplace
If lost, use the regenerate endpoint after registration

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Marketplace created and invitation sent
Body

🟠400
🟠401
🟠403
🟠409
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dev.opensylo.com/api/marketplace-dashboard/admin/invite' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "platformName": "chowdeck",
    "displayName": "Chowdeck",
    "companyName": "Chowdeck Technologies Limited",
    "platformType": "FOOD_DELIVERY",
    "description": "Leading food delivery platform in Nigeria",
    "logo": "https://chowdeck.com/logo.png",
    "website": "https://chowdeck.com",
    "registeredAddress": "123 Victoria Island, Lagos, Nigeria",
    "operatingAddress": "456 Lekki Phase 1, Lagos, Nigeria",
    "cacNumber": "RC123456",
    "technicalContactName": "John Developer",
    "technicalContactEmail": "developer@chowdeck.com",
    "technicalContactPhone": "+2348012345678",
    "operationalContactName": "Jane Operations",
    "operationalContactEmail": "operations@chowdeck.com",
    "operationalContactPhone": "+2348098765432",
    "redirectUris": [
        "https://chowdeck.com/oauth/callback",
        "https://staging.chowdeck.com/oauth/callback"
    ],
    "webhookUrl": "https://api.chowdeck.com/webhooks/opensylo",
    "allowedScopes": [
        "data.share.sales",
        "data.share.fulfillment",
        "credit.score.read"
    ]
}'
Response Response Example
{
    "success": true,
    "message": "Marketplace invitation sent successfully",
    "marketplaceId": "mkt_abc123",
    "clientId": "chowdeck_client_abc123",
    "clientSecret": "cs_secret_xyz789...",
    "invitationSentTo": "developer@chowdeck.com"
}
Modified at 2025-12-30 08:04:15
Previous
Get Current User
Next
OAuth Authorization Endpoint
Built with