Quickstart

This walkthrough onboards one merchant from start to finish. All calls use a Bearer JWT (see Authentication) against the sandbox base URL https://kyc.sbx.moduluslabs.io. Onboarding does not send webhooks - you poll for the result.

Create the merchant account

POST /v2/onboard/signup with the contact and user details. The response returns the account id.

curl 'https://kyc.sbx.moduluslabs.io/v2/onboard/signup' \
  -H 'Authorization: Bearer <jwt>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact": { "email": "ops@travelgo.example", "phone": "09171234567" },
    "user": { "firstName": "Juan", "lastName": "Dela Cruz", "username": "travelgo_ops", "password": "S3cretPass!", "pin": "1234" }
  }'

{ "id": 10432 }

See Create Account for every field.

Upload KYC documents

POST /v2/onboard/{id}/files as multipart/form-data, one part per required document.

curl 'https://kyc.sbx.moduluslabs.io/v2/onboard/10432/files' \
  -H 'Authorization: Bearer <jwt>' \
  -F 'businessPermit=@business-permit.pdf' \
  -F 'validId=@valid-id.jpg'

See Upload Onboarding Files for the accepted document types.

Submit the application

POST /v2/onboard with the business profile. Requirements depend on businessType (see Enums). The application starts at status NEW.

curl 'https://kyc.sbx.moduluslabs.io/v2/onboard' \
  -H 'Authorization: Bearer <jwt>' \
  -H 'Content-Type: application/json' \
  -d '{
    "merchantName": "TravelGo",
    "businessType": "CORPORATION",
    "parentOnboardingRefNo": "ONB-PARENT-0001",
    "modeOfPayments": ["ECOM", "QRPH"],
    "currency": "PHP",
    "tin": "123456789000",
    "industry": "Travel",
    "serviceDescription": "Online travel bookings",
    "isBrickAndMortarStore": false,
    "isWantPackworksWallet": false,
    "isWantPayMayaWallet": false,
    "isWantPayMayaBankAccount": false,
    "address": { "...": "..." },
    "representatives": { "...": "..." },
    "banks": [ { "...": "..." } ]
  }'

{ "onboardingReferenceNumber": "ONB-2026-0001" }

See Onboard Merchant for the full request.

Poll for the result

GET /v2/onboard/{onboardingReferenceNumber}/status until the status is APPROVED or DECLINED.

curl 'https://kyc.sbx.moduluslabs.io/v2/onboard/ONB-2026-0001/status' \
  -H 'Authorization: Bearer <jwt>'

{ "onboardingStatus": "APPROVED" }

Resubmit if declined

If DECLINED, correct the profile and PUT /v2/onboard/{onboardingReferenceNumber}. The status returns to PENDING for re-review. See Update Onboarding Data.

Amounts, wallet flags, and the required fields differ by business type. Check Enums before you build the submit payload.

Next Steps

Authentication

Generate the Bearer JWT

Enums

Business types, payment modes, and required fields

Onboard Merchant API

Full submit request and response

Errors

HTTP status ranges and retry rules

Get Started

QR API

Webhooks API

Onboarding API

Terminal Gateway API

Transaction Reporting API

Ecom API

Shared Resources

Next Steps

Authentication

Enums

Onboard Merchant API

Errors

​Next Steps

Authentication

Enums

Onboard Merchant API

Errors

Next Steps