# OpenSylo Backend API ## API Docs - API Info [API Information](https://docs.dev.opensylo.com/api-information-26113954e0.md): Returns basic API information and available endpoints - Health [HealthController_checkHealth](https://docs.dev.opensylo.com/healthcontroller-checkhealth-26113955e0.md): - Health [HealthController_ping](https://docs.dev.opensylo.com/healthcontroller-ping-26113956e0.md): - Marketplace Connections [Get available marketplaces](https://docs.dev.opensylo.com/get-available-marketplaces-26113957e0.md): Retrieves all available marketplaces/platforms with their connection status for the authenticated merchant. - Marketplace Connections [Get marketplace catalog](https://docs.dev.opensylo.com/get-marketplace-catalog-26113958e0.md): Returns the full catalog of available marketplaces without connection status. - Marketplace Connections [Get marketplace details](https://docs.dev.opensylo.com/get-marketplace-details-26113959e0.md): Retrieves detailed information about a specific marketplace including the merchant's connection status. - Marketplace Connections [Initiate marketplace connection](https://docs.dev.opensylo.com/initiate-marketplace-connection-26113960e0.md): Starts the OAuth authorization flow to connect the merchant to the specified marketplace. - Marketplace Connections [Disconnect from marketplace](https://docs.dev.opensylo.com/disconnect-from-marketplace-26113961e0.md): Revokes the merchant's connection to the specified marketplace. - Marketplace Connections [Get connection status](https://docs.dev.opensylo.com/get-connection-status-26113962e0.md): Returns the current connection status and sync metrics for a specific marketplace. - Marketplace Connections [Update marketplace credentials](https://docs.dev.opensylo.com/update-marketplace-credentials-26113963e0.md): Updates API credentials for marketplaces that use API key authentication instead of OAuth. - Marketplace Connections [Handle OAuth callback](https://docs.dev.opensylo.com/handle-oauth-callback-26113964e0.md): Processes the OAuth callback after user authorization on the marketplace. - Merchant Authentication [Register a new merchant account](https://docs.dev.opensylo.com/register-a-new-merchant-account-26113965e0.md): Creates a new merchant account and sends a verification email. The merchant must verify their email before they can log in. - Merchant Authentication [Authenticate merchant](https://docs.dev.opensylo.com/authenticate-merchant-26113966e0.md): Authenticates a merchant with email and password. Returns access and refresh tokens on success. - Merchant Authentication [Verify email address](https://docs.dev.opensylo.com/verify-email-address-26113967e0.md): Verifies the merchant email address using the 6-digit code sent to their email. - Merchant Authentication [Resend verification email](https://docs.dev.opensylo.com/resend-verification-email-26113968e0.md): Sends a new verification code to the merchant email address. - Merchant Authentication [Request password reset](https://docs.dev.opensylo.com/request-password-reset-26113969e0.md): Sends a password reset link to the merchant email address. - Merchant Authentication [Reset password](https://docs.dev.opensylo.com/reset-password-26113970e0.md): Resets the merchant password using the token from the password reset email. - Merchant Authentication [Change password](https://docs.dev.opensylo.com/change-password-26113971e0.md): Changes the merchant password. Requires current password for verification. - Merchant Authentication [Refresh access token](https://docs.dev.opensylo.com/refresh-access-token-26113972e0.md): Exchanges a valid refresh token for a new access token. - Merchant Authentication [Logout](https://docs.dev.opensylo.com/logout-26113973e0.md): Logs out the merchant and invalidates the current session. - Merchant Authentication [Get current user profile](https://docs.dev.opensylo.com/get-current-user-profile-26113974e0.md): Returns the authenticated merchant profile including user details and associated merchant information. - MerchantKyc [MerchantKycController_getOnboardingStatus](https://docs.dev.opensylo.com/merchantkyccontroller-getonboardingstatus-26113975e0.md): - MerchantKyc [MerchantKycController_getKycProgress](https://docs.dev.opensylo.com/merchantkyccontroller-getkycprogress-26113976e0.md): - MerchantKyc [MerchantKycController_sendOtp](https://docs.dev.opensylo.com/merchantkyccontroller-sendotp-26113977e0.md): - MerchantKyc [MerchantKycController_verifyOtp](https://docs.dev.opensylo.com/merchantkyccontroller-verifyotp-26113978e0.md): - MerchantKyc [MerchantKycController_updateBusinessInfo](https://docs.dev.opensylo.com/merchantkyccontroller-updatebusinessinfo-26113979e0.md): - MerchantKyc [MerchantKycController_addDirector](https://docs.dev.opensylo.com/merchantkyccontroller-adddirector-26113980e0.md): - MerchantKyc [MerchantKycController_addBulkDirectors](https://docs.dev.opensylo.com/merchantkyccontroller-addbulkdirectors-26113981e0.md): - MerchantKyc [MerchantKycController_uploadDocument](https://docs.dev.opensylo.com/merchantkyccontroller-uploaddocument-26113982e0.md): - MerchantKyc [MerchantKycController_submitKyc](https://docs.dev.opensylo.com/merchantkyccontroller-submitkyc-26113983e0.md): - MerchantKyc [MerchantKycController_searchBusinessTypes](https://docs.dev.opensylo.com/merchantkyccontroller-searchbusinesstypes-26113984e0.md): - MerchantKyc [MerchantKycController_getBusinessCategories](https://docs.dev.opensylo.com/merchantkyccontroller-getbusinesscategories-26113985e0.md): - MerchantKyc [MerchantKycController_getDocumentTypes](https://docs.dev.opensylo.com/merchantkyccontroller-getdocumenttypes-26113986e0.md): - Merchants [Create a new merchant](https://docs.dev.opensylo.com/create-a-new-merchant-26113987e0.md): Registers a new merchant business with contact details - Merchants [Get all merchants](https://docs.dev.opensylo.com/get-all-merchants-26113988e0.md): Retrieves a list of all registered merchants - Merchants [Get a merchant by ID](https://docs.dev.opensylo.com/get-a-merchant-by-id-26113989e0.md): Retrieves detailed information about a specific merchant - Merchants [Update a merchant](https://docs.dev.opensylo.com/update-a-merchant-26113990e0.md): Updates merchant information by ID - Merchants [Delete a merchant](https://docs.dev.opensylo.com/delete-a-merchant-26113991e0.md): Removes a merchant from the system (soft delete) - Marketplace Data Ingestion [Submit Merchant Data](https://docs.dev.opensylo.com/submit-merchant-data-26113992e0.md): - Marketplace Data Ingestion [Submit Bulk Merchant Data](https://docs.dev.opensylo.com/submit-bulk-merchant-data-26113993e0.md): - Marketplace Data Ingestion [Get Merchant Credit Score](https://docs.dev.opensylo.com/get-merchant-credit-score-26113994e0.md): - Marketplace Data Ingestion [Health Check](https://docs.dev.opensylo.com/health-check-26113995e0.md): - Marketplace Dashboard [Complete Marketplace Registration](https://docs.dev.opensylo.com/complete-marketplace-registration-26113996e0.md): - Marketplace Dashboard [Marketplace Dashboard Login](https://docs.dev.opensylo.com/marketplace-dashboard-login-26113997e0.md): - Marketplace Dashboard [Get OAuth Credentials](https://docs.dev.opensylo.com/get-oauth-credentials-26113998e0.md): - Marketplace Dashboard [Regenerate Client Secret](https://docs.dev.opensylo.com/regenerate-client-secret-26113999e0.md): - Marketplace Dashboard [Get Current User](https://docs.dev.opensylo.com/get-current-user-26114000e0.md): Get the current logged-in user profile and marketplace information. - Marketplace Dashboard [Invite Marketplace (Admin)](https://docs.dev.opensylo.com/invite-marketplace-admin-26114001e0.md): - OAuth 2.0 [OAuth Authorization Endpoint](https://docs.dev.opensylo.com/oauth-authorization-endpoint-26114002e0.md): - OAuth 2.0 [Process Authorization Decision](https://docs.dev.opensylo.com/process-authorization-decision-26114003e0.md): - OAuth 2.0 [Token Endpoint](https://docs.dev.opensylo.com/token-endpoint-26114004e0.md): - OAuth 2.0 [Revoke Token](https://docs.dev.opensylo.com/revoke-token-26114005e0.md): - OAuth 2.0 [Client Metadata](https://docs.dev.opensylo.com/client-metadata-26114006e0.md): - OAuth Authentication [Login Page](https://docs.dev.opensylo.com/login-page-26114007e0.md): Renders the merchant login page for OAuth flow - OAuth Authentication [Login Submit](https://docs.dev.opensylo.com/login-submit-26114008e0.md): Processes merchant login credentials - OAuth Authentication [Signup Page](https://docs.dev.opensylo.com/signup-page-26114009e0.md): Renders the merchant signup page for OAuth flow - OAuth Authentication [Signup Submit](https://docs.dev.opensylo.com/signup-submit-26114010e0.md): Processes new merchant registration - OAuth Authentication [Logout](https://docs.dev.opensylo.com/logout-26114011e0.md): Clears the OAuth session and redirects to login - Lenders [Create a new lender](https://docs.dev.opensylo.com/create-a-new-lender-26114012e0.md): Creates a new lender with company details and contact information - Lenders [Get all lenders](https://docs.dev.opensylo.com/get-all-lenders-26114013e0.md): Retrieves a list of all registered lenders - Lenders [Get a lender by ID](https://docs.dev.opensylo.com/get-a-lender-by-id-26114014e0.md): Retrieves detailed information about a specific lender - Lenders [Update a lender](https://docs.dev.opensylo.com/update-a-lender-26114015e0.md): Updates lender information by ID - Lenders [Delete a lender](https://docs.dev.opensylo.com/delete-a-lender-26114016e0.md): Removes a lender from the system (soft delete) ## Schemas - [PlatformDto](https://docs.dev.opensylo.com/platformdto-11922083d0.md): - [PlatformConnectionMetadataDto](https://docs.dev.opensylo.com/platformconnectionmetadatadto-11922084d0.md): - [PlatformConnectionInfoDto](https://docs.dev.opensylo.com/platformconnectioninfodto-11922085d0.md): - [PlatformListResponseDto](https://docs.dev.opensylo.com/platformlistresponsedto-11922086d0.md): - [ConnectionInitResponseDto](https://docs.dev.opensylo.com/connectioninitresponsedto-11922087d0.md): - [ConnectionMetricsDto](https://docs.dev.opensylo.com/connectionmetricsdto-11922088d0.md): - [ConnectionStatusResponseDto](https://docs.dev.opensylo.com/connectionstatusresponsedto-11922089d0.md): - [DisconnectResponseDto](https://docs.dev.opensylo.com/disconnectresponsedto-11922090d0.md): - [PlatformCatalogResponseDto](https://docs.dev.opensylo.com/platformcatalogresponsedto-11922091d0.md): - [ConnectPlatformDto](https://docs.dev.opensylo.com/connectplatformdto-11922092d0.md): - [DisconnectPlatformDto](https://docs.dev.opensylo.com/disconnectplatformdto-11922093d0.md): - [PlatformCredentialsDto](https://docs.dev.opensylo.com/platformcredentialsdto-11922094d0.md): - [MerchantSignupDto](https://docs.dev.opensylo.com/merchantsignupdto-11922095d0.md): - [SignupResponseDto](https://docs.dev.opensylo.com/signupresponsedto-11922096d0.md): - [MerchantLoginDto](https://docs.dev.opensylo.com/merchantlogindto-11922097d0.md): - [LoginResponseDto](https://docs.dev.opensylo.com/loginresponsedto-11922098d0.md): - [MerchantVerifyEmailDto](https://docs.dev.opensylo.com/merchantverifyemaildto-11922099d0.md): - [EmailVerificationResponseDto](https://docs.dev.opensylo.com/emailverificationresponsedto-11922100d0.md): - [MerchantResendVerificationDto](https://docs.dev.opensylo.com/merchantresendverificationdto-11922101d0.md): - [GenericSuccessResponseDto](https://docs.dev.opensylo.com/genericsuccessresponsedto-11922102d0.md): - [MerchantForgotPasswordDto](https://docs.dev.opensylo.com/merchantforgotpassworddto-11922103d0.md): - [MerchantResetPasswordDto](https://docs.dev.opensylo.com/merchantresetpassworddto-11922104d0.md): - [MerchantChangePasswordDto](https://docs.dev.opensylo.com/merchantchangepassworddto-11922105d0.md): - [RefreshTokenDto](https://docs.dev.opensylo.com/refreshtokendto-11922106d0.md): - [UserProfileResponseDto](https://docs.dev.opensylo.com/userprofileresponsedto-11922107d0.md): - [OtpVerificationDto](https://docs.dev.opensylo.com/otpverificationdto-11922108d0.md): - [BusinessKycDto](https://docs.dev.opensylo.com/businesskycdto-11922109d0.md): - [DirectorInfoDto](https://docs.dev.opensylo.com/directorinfodto-11922110d0.md): - [BulkDirectorInfoDto](https://docs.dev.opensylo.com/bulkdirectorinfodto-11922111d0.md): - [DocumentUploadDto](https://docs.dev.opensylo.com/documentuploaddto-11922112d0.md): - [CreateMerchantDto](https://docs.dev.opensylo.com/createmerchantdto-11922113d0.md): - [UpdateMerchantDto](https://docs.dev.opensylo.com/updatemerchantdto-11922114d0.md): - [MarketplaceDataCaptureDto](https://docs.dev.opensylo.com/marketplacedatacapturedto-11922115d0.md): - [BulkMarketplaceDataCaptureDto](https://docs.dev.opensylo.com/bulkmarketplacedatacapturedto-11922116d0.md): - [CompleteMarketplaceRegistrationDto](https://docs.dev.opensylo.com/completemarketplaceregistrationdto-11922117d0.md): - [MarketplaceLoginResponseDto](https://docs.dev.opensylo.com/marketplaceloginresponsedto-11922118d0.md): - [MarketplaceLoginDto](https://docs.dev.opensylo.com/marketplacelogindto-11922119d0.md): - [MarketplaceCredentialsResponseDto](https://docs.dev.opensylo.com/marketplacecredentialsresponsedto-11922120d0.md): - [RegenerateSecretResponseDto](https://docs.dev.opensylo.com/regeneratesecretresponsedto-11922121d0.md): - [InviteMarketplaceDto](https://docs.dev.opensylo.com/invitemarketplacedto-11922122d0.md): - [MarketplaceInvitationResponseDto](https://docs.dev.opensylo.com/marketplaceinvitationresponsedto-11922123d0.md): - [CreateLenderDto](https://docs.dev.opensylo.com/createlenderdto-11922124d0.md): - [UpdateLenderDto](https://docs.dev.opensylo.com/updatelenderdto-11922125d0.md):