Get merchant status (KYC, credit score, funding requests)

GET

/api/v1/marketplace-api/merchants/{ref}

Polling endpoint covering the whole journey: connection status, KYC
progress and status, credit score (populated after sales-data scoring),
and all funding requests with their fulfillment state.

Request

Authorization

API Key

Add parameter in header

X-OpenSylo-Secret-Key

Example:

X-OpenSylo-Secret-Key: ********************

Path Params

Responses

🟢200OK

application/json

Merchant status retrieved.

Bodyapplication/json

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.opensylo.com/api/v1/marketplace-api/merchants/mkt_merchant_8421' \
--header 'X-OpenSylo-Secret-Key: <api-key>'

Response Example

200 - Example 1

{
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "thirdPartyCustomerId": "string",
    "connectionStatus": "PENDING",
    "kyc": {
        "currentStep": "directors",
        "completedSteps": [
            "string"
        ],
        "remainingSteps": [
            "string"
        ],
        "overallProgress": 0,
        "status": "PENDING",
        "canProceed": true,
        "submittedAt": "2019-08-24T14:15:22.123Z"
    },
    "creditScore": {
        "score": 0,
        "computedAt": "2019-08-24T14:15:22.123Z"
    },
    "fundingRequests": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "status": "PENDING",
            "amountRequested": 0,
            "tenorDays": 0,
            "purpose": "string",
            "loanId": "7f89c4c5-c1d0-4b4b-ae8c-fb112b2c21a4",
            "failureReason": "string",
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ]
}

Modified at 2026-06-10 14:59:36

Create (or fetch) a merchant

Update business KYC information