Skip to main content

​
Overview

The Ping endpoint is a simple health check that allows you to:
  • Test connectivity to Modulus Labs onboarding servers
  • Verify API availability and response time
  • Confirm your network can reach the onboarding API endpoints
This endpoint does not require authentication, making it perfect for quick connectivity tests and uptime monitoring.

Test Connectivity

Verify your application can reach Modulus Labs onboarding servers

Check API Availability

Confirm the Onboarding API is online and responding

​
Endpoint

GET https://kyc.sbx.moduluslabs.io/ping
This endpoint does not require authentication. It’s a public health check endpoint that anyone can access to verify Onboarding API connectivity.

​
Request

​
Headers

HeaderValueRequired
accept*/*No

​
Parameters

This endpoint does not accept any parameters.

​
Request Body

This endpoint does not require a request body.

​
Response

​
Success Response

Status Code: 200 OK Headers: 
Content-Type: text/html; charset=utf-8
Body: 
Pong!
If you receive Pong!, the Onboarding API is available and your network connectivity is working!
Pong!

​
Error Responses

Status Code: 500Cause: Unexpected server errorSolution:
  • Retry the request
  • If the issue persists, contact Modulus Labs support
  • Report the time of occurrence for troubleshooting
Status Code: 503Cause: Onboarding API temporarily unavailable (maintenance, overload, etc.)Solution:
  • Wait and retry the request
  • Check Modulus Labs status page for scheduled maintenance
  • Implement exponential backoff for retries
curl https://kyc.sbx.moduluslabs.io/ping

# Successful response:
# Pong!

​
Use Cases

Integration Testing

Verify onboarding API connectivity during development and testing

Health Monitoring

Include in your application’s health check endpoints

CI/CD Pipeline

Test API availability in automated deployment workflows

Startup Checks

Confirm API is reachable when your application starts

​
Testing Checklist

Use this checklist to verify your Onboarding API setup:
1

Test Basic Connectivity

curl https://kyc.sbx.moduluslabs.io/ping
Expected: Pong! with 200 OK status
2

Test Response Time

curl -w "\nTime: %{time_total}s\n" \
  https://kyc.sbx.moduluslabs.io/ping
Expected: Pong! with response time displayed
3

Test from Your Application

Run the ping function from your application codeExpected: Successfully receives Pong!

​
Monitoring & Health Checks

Include the Ping endpoint in your monitoring strategy:
Monitoring Example
const HEALTH_CHECK_INTERVAL = 60000; // 1 minute

async function checkOnboardingAPIHealth() {
  try {
    const response = await axios.get(
      'https://kyc.sbx.moduluslabs.io/ping',
      {
        timeout: 5000 // 5 second timeout
      }
    );

    if (response.data === 'Pong!') {
      console.log(' Onboarding API is healthy');
      // Update your monitoring dashboard
      metrics.onboardingAPIStatus = 'healthy';
    }
  } catch (error) {
    console.error('  Onboarding API health check failed');
    metrics.onboardingAPIStatus = 'unhealthy';

    // Alert your team
    await alertOncall('Onboarding API unreachable', {
      error: error.message,
      timestamp: new Date()
    });
  }
}

setInterval(checkOnboardingAPIHealth, HEALTH_CHECK_INTERVAL);

​
Best Practices

Test connectivity before merchant onboarding:
async function onboardMerchant(merchantData) {
  // Test API connectivity first
  try {
    await ping();
  } catch (error) {
    console.error('Onboarding API unavailable, skipping registration');
    return null;
  }

  // Proceed with merchant onboarding
  return await createMerchant(merchantData);
}
Always set appropriate timeouts to avoid hanging:
axios.get('https://kyc.sbx.moduluslabs.io/ping', {
  timeout: 5000 // 5 seconds
});
Keep track of health check outcomes for debugging:
const healthCheckLog = {
  timestamp: new Date(),
  status: response.status,
  responseTime: duration,
  success: response.data === 'Pong!'
};

await db.healthChecks.insert(healthCheckLog);
Verify Onboarding API connectivity when your application starts:
async function startupChecks() {
  console.log('Checking Onboarding API connectivity...');

  try {
    await ping();
    console.log(' Onboarding API connection verified');
  } catch (error) {
    console.error(' Cannot reach Onboarding API');
    console.error('Application may not be able to onboard merchants');
    // Decide whether to proceed or abort startup
  }
}

app.listen(3000, async () => {
  await startupChecks();
  console.log('Server running on port 3000');
});

​
Troubleshooting

Symptom: Request times out without responsePossible Causes:
  • Firewall blocking HTTPS requests
  • DNS resolution problems
  • Network connectivity issues
Solutions:
  • Check firewall rules allow HTTPS (port 443)
  • Test DNS resolution: nslookup kyc.sbx.moduluslabs.io
  • Try from a different network
  • Increase timeout duration
Symptom: SSL/TLS certificate validation failsPossible Causes:
  • System time incorrect
  • Missing CA certificates
  • Corporate proxy intercepting SSL
Solutions:
  • Verify system time is correct
  • Update SSL certificates on your system
  • Configure proxy settings if applicable

​
Next Steps

Onboard Merchant

Register and onboard a new merchant

Authentication Guide

Learn about JWT Bearer Token authentication

Onboarding Introduction

Understand the Onboarding API

Enums Reference

All valid enum values for onboarding parameters