Onboard Merchant
curl --request POST \
--url https://kyc.sbx.moduluslabs.io/v2/onboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantName": "<string>",
"modeOfPayments": [],
"tin": "<string>",
"industry": "<string>",
"serviceDescription": "<string>",
"isBrickAndMortarStore": true,
"address": {
"office": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
}
},
"representatives": {
"authorized": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"position": "<string>",
"middleName": "<string>",
"tin": "<string>",
"sss": "<string>",
"mothersMaidenName": "<string>"
},
"escalation": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"tin": "<string>",
"sss": "<string>",
"position": "<string>"
}
},
"banks": [
{
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
}
],
"businessType": "<string>",
"parentOnboardingRefNo": "<string>",
"isWantPackworksWallet": true,
"isWantPayMayaWallet": true,
"isWantPayMayaBankAccount": true,
"legalName": "<string>",
"businessHandle": "<string>",
"incorporators": [
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
},
"middleName": "<string>"
}
],
"signatories": [
{
"firstName": "<string>",
"lastName": "<string>",
"position": "<string>",
"middleName": "<string>"
}
],
"websites": {
"businessWebsiteUrl": "<string>",
"isBusinessWebsiteUnderDevelopment": true,
"facebookUrl": "<string>",
"twitterUrl": "<string>",
"instagramUrl": "<string>",
"tiktokUrl": "<string>"
},
"aubPartnerId": "<string>",
"estimatedMonthlyGrossTransaction": "<string>"
}
'import requests
url = "https://kyc.sbx.moduluslabs.io/v2/onboard"
payload = {
"merchantName": "<string>",
"modeOfPayments": [],
"tin": "<string>",
"industry": "<string>",
"serviceDescription": "<string>",
"isBrickAndMortarStore": True,
"address": { "office": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
} },
"representatives": {
"authorized": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"position": "<string>",
"middleName": "<string>",
"tin": "<string>",
"sss": "<string>",
"mothersMaidenName": "<string>"
},
"escalation": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"tin": "<string>",
"sss": "<string>",
"position": "<string>"
}
},
"banks": [
{
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
}
],
"businessType": "<string>",
"parentOnboardingRefNo": "<string>",
"isWantPackworksWallet": True,
"isWantPayMayaWallet": True,
"isWantPayMayaBankAccount": True,
"legalName": "<string>",
"businessHandle": "<string>",
"incorporators": [
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
},
"middleName": "<string>"
}
],
"signatories": [
{
"firstName": "<string>",
"lastName": "<string>",
"position": "<string>",
"middleName": "<string>"
}
],
"websites": {
"businessWebsiteUrl": "<string>",
"isBusinessWebsiteUnderDevelopment": True,
"facebookUrl": "<string>",
"twitterUrl": "<string>",
"instagramUrl": "<string>",
"tiktokUrl": "<string>"
},
"aubPartnerId": "<string>",
"estimatedMonthlyGrossTransaction": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantName: '<string>',
modeOfPayments: [],
tin: '<string>',
industry: '<string>',
serviceDescription: '<string>',
isBrickAndMortarStore: true,
address: {
office: {
city: '<string>',
line1: '<string>',
state: '<string>',
postalCode: '<string>',
contactNumber: '<string>',
barangay: '<string>',
buildingNameAndNumber: '<string>'
}
},
representatives: {
authorized: {
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
position: '<string>',
middleName: '<string>',
tin: '<string>',
sss: '<string>',
mothersMaidenName: '<string>'
},
escalation: {
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
tin: '<string>',
sss: '<string>',
position: '<string>'
}
},
banks: [{bankName: '<string>', accountName: '<string>', accountNumber: '<string>'}],
businessType: '<string>',
parentOnboardingRefNo: '<string>',
isWantPackworksWallet: true,
isWantPayMayaWallet: true,
isWantPayMayaBankAccount: true,
legalName: '<string>',
businessHandle: '<string>',
incorporators: [
{
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
address: {
city: '<string>',
line1: '<string>',
state: '<string>',
postalCode: '<string>',
contactNumber: '<string>',
barangay: '<string>',
buildingNameAndNumber: '<string>'
},
middleName: '<string>'
}
],
signatories: [
{
firstName: '<string>',
lastName: '<string>',
position: '<string>',
middleName: '<string>'
}
],
websites: {
businessWebsiteUrl: '<string>',
isBusinessWebsiteUnderDevelopment: true,
facebookUrl: '<string>',
twitterUrl: '<string>',
instagramUrl: '<string>',
tiktokUrl: '<string>'
},
aubPartnerId: '<string>',
estimatedMonthlyGrossTransaction: '<string>'
})
};
fetch('https://kyc.sbx.moduluslabs.io/v2/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kyc.sbx.moduluslabs.io/v2/onboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchantName' => '<string>',
'modeOfPayments' => [
],
'tin' => '<string>',
'industry' => '<string>',
'serviceDescription' => '<string>',
'isBrickAndMortarStore' => true,
'address' => [
'office' => [
'city' => '<string>',
'line1' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'contactNumber' => '<string>',
'barangay' => '<string>',
'buildingNameAndNumber' => '<string>'
]
],
'representatives' => [
'authorized' => [
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'position' => '<string>',
'middleName' => '<string>',
'tin' => '<string>',
'sss' => '<string>',
'mothersMaidenName' => '<string>'
],
'escalation' => [
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'tin' => '<string>',
'sss' => '<string>',
'position' => '<string>'
]
],
'banks' => [
[
'bankName' => '<string>',
'accountName' => '<string>',
'accountNumber' => '<string>'
]
],
'businessType' => '<string>',
'parentOnboardingRefNo' => '<string>',
'isWantPackworksWallet' => true,
'isWantPayMayaWallet' => true,
'isWantPayMayaBankAccount' => true,
'legalName' => '<string>',
'businessHandle' => '<string>',
'incorporators' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'address' => [
'city' => '<string>',
'line1' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'contactNumber' => '<string>',
'barangay' => '<string>',
'buildingNameAndNumber' => '<string>'
],
'middleName' => '<string>'
]
],
'signatories' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'position' => '<string>',
'middleName' => '<string>'
]
],
'websites' => [
'businessWebsiteUrl' => '<string>',
'isBusinessWebsiteUnderDevelopment' => true,
'facebookUrl' => '<string>',
'twitterUrl' => '<string>',
'instagramUrl' => '<string>',
'tiktokUrl' => '<string>'
],
'aubPartnerId' => '<string>',
'estimatedMonthlyGrossTransaction' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kyc.sbx.moduluslabs.io/v2/onboard"
payload := strings.NewReader("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kyc.sbx.moduluslabs.io/v2/onboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://kyc.sbx.moduluslabs.io/v2/onboard");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"onboardingReferenceNumber": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"details": {}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"details": {}
}Onboarding API
Onboard Merchant
Onboard a merchant to accept payments through Modulus Labs
POST
/
v2
/
onboard
Onboard Merchant
curl --request POST \
--url https://kyc.sbx.moduluslabs.io/v2/onboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantName": "<string>",
"modeOfPayments": [],
"tin": "<string>",
"industry": "<string>",
"serviceDescription": "<string>",
"isBrickAndMortarStore": true,
"address": {
"office": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
}
},
"representatives": {
"authorized": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"position": "<string>",
"middleName": "<string>",
"tin": "<string>",
"sss": "<string>",
"mothersMaidenName": "<string>"
},
"escalation": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"tin": "<string>",
"sss": "<string>",
"position": "<string>"
}
},
"banks": [
{
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
}
],
"businessType": "<string>",
"parentOnboardingRefNo": "<string>",
"isWantPackworksWallet": true,
"isWantPayMayaWallet": true,
"isWantPayMayaBankAccount": true,
"legalName": "<string>",
"businessHandle": "<string>",
"incorporators": [
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
},
"middleName": "<string>"
}
],
"signatories": [
{
"firstName": "<string>",
"lastName": "<string>",
"position": "<string>",
"middleName": "<string>"
}
],
"websites": {
"businessWebsiteUrl": "<string>",
"isBusinessWebsiteUnderDevelopment": true,
"facebookUrl": "<string>",
"twitterUrl": "<string>",
"instagramUrl": "<string>",
"tiktokUrl": "<string>"
},
"aubPartnerId": "<string>",
"estimatedMonthlyGrossTransaction": "<string>"
}
'import requests
url = "https://kyc.sbx.moduluslabs.io/v2/onboard"
payload = {
"merchantName": "<string>",
"modeOfPayments": [],
"tin": "<string>",
"industry": "<string>",
"serviceDescription": "<string>",
"isBrickAndMortarStore": True,
"address": { "office": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
} },
"representatives": {
"authorized": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"position": "<string>",
"middleName": "<string>",
"tin": "<string>",
"sss": "<string>",
"mothersMaidenName": "<string>"
},
"escalation": {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"tin": "<string>",
"sss": "<string>",
"position": "<string>"
}
},
"banks": [
{
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
}
],
"businessType": "<string>",
"parentOnboardingRefNo": "<string>",
"isWantPackworksWallet": True,
"isWantPayMayaWallet": True,
"isWantPayMayaBankAccount": True,
"legalName": "<string>",
"businessHandle": "<string>",
"incorporators": [
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"contactNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": {
"city": "<string>",
"line1": "<string>",
"state": "<string>",
"postalCode": "<string>",
"contactNumber": "<string>",
"barangay": "<string>",
"buildingNameAndNumber": "<string>"
},
"middleName": "<string>"
}
],
"signatories": [
{
"firstName": "<string>",
"lastName": "<string>",
"position": "<string>",
"middleName": "<string>"
}
],
"websites": {
"businessWebsiteUrl": "<string>",
"isBusinessWebsiteUnderDevelopment": True,
"facebookUrl": "<string>",
"twitterUrl": "<string>",
"instagramUrl": "<string>",
"tiktokUrl": "<string>"
},
"aubPartnerId": "<string>",
"estimatedMonthlyGrossTransaction": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantName: '<string>',
modeOfPayments: [],
tin: '<string>',
industry: '<string>',
serviceDescription: '<string>',
isBrickAndMortarStore: true,
address: {
office: {
city: '<string>',
line1: '<string>',
state: '<string>',
postalCode: '<string>',
contactNumber: '<string>',
barangay: '<string>',
buildingNameAndNumber: '<string>'
}
},
representatives: {
authorized: {
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
position: '<string>',
middleName: '<string>',
tin: '<string>',
sss: '<string>',
mothersMaidenName: '<string>'
},
escalation: {
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
tin: '<string>',
sss: '<string>',
position: '<string>'
}
},
banks: [{bankName: '<string>', accountName: '<string>', accountNumber: '<string>'}],
businessType: '<string>',
parentOnboardingRefNo: '<string>',
isWantPackworksWallet: true,
isWantPayMayaWallet: true,
isWantPayMayaBankAccount: true,
legalName: '<string>',
businessHandle: '<string>',
incorporators: [
{
firstName: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
contactNumber: '<string>',
dateOfBirth: '2023-12-25',
address: {
city: '<string>',
line1: '<string>',
state: '<string>',
postalCode: '<string>',
contactNumber: '<string>',
barangay: '<string>',
buildingNameAndNumber: '<string>'
},
middleName: '<string>'
}
],
signatories: [
{
firstName: '<string>',
lastName: '<string>',
position: '<string>',
middleName: '<string>'
}
],
websites: {
businessWebsiteUrl: '<string>',
isBusinessWebsiteUnderDevelopment: true,
facebookUrl: '<string>',
twitterUrl: '<string>',
instagramUrl: '<string>',
tiktokUrl: '<string>'
},
aubPartnerId: '<string>',
estimatedMonthlyGrossTransaction: '<string>'
})
};
fetch('https://kyc.sbx.moduluslabs.io/v2/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kyc.sbx.moduluslabs.io/v2/onboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchantName' => '<string>',
'modeOfPayments' => [
],
'tin' => '<string>',
'industry' => '<string>',
'serviceDescription' => '<string>',
'isBrickAndMortarStore' => true,
'address' => [
'office' => [
'city' => '<string>',
'line1' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'contactNumber' => '<string>',
'barangay' => '<string>',
'buildingNameAndNumber' => '<string>'
]
],
'representatives' => [
'authorized' => [
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'position' => '<string>',
'middleName' => '<string>',
'tin' => '<string>',
'sss' => '<string>',
'mothersMaidenName' => '<string>'
],
'escalation' => [
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'tin' => '<string>',
'sss' => '<string>',
'position' => '<string>'
]
],
'banks' => [
[
'bankName' => '<string>',
'accountName' => '<string>',
'accountNumber' => '<string>'
]
],
'businessType' => '<string>',
'parentOnboardingRefNo' => '<string>',
'isWantPackworksWallet' => true,
'isWantPayMayaWallet' => true,
'isWantPayMayaBankAccount' => true,
'legalName' => '<string>',
'businessHandle' => '<string>',
'incorporators' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'contactNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'address' => [
'city' => '<string>',
'line1' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'contactNumber' => '<string>',
'barangay' => '<string>',
'buildingNameAndNumber' => '<string>'
],
'middleName' => '<string>'
]
],
'signatories' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'position' => '<string>',
'middleName' => '<string>'
]
],
'websites' => [
'businessWebsiteUrl' => '<string>',
'isBusinessWebsiteUnderDevelopment' => true,
'facebookUrl' => '<string>',
'twitterUrl' => '<string>',
'instagramUrl' => '<string>',
'tiktokUrl' => '<string>'
],
'aubPartnerId' => '<string>',
'estimatedMonthlyGrossTransaction' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kyc.sbx.moduluslabs.io/v2/onboard"
payload := strings.NewReader("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kyc.sbx.moduluslabs.io/v2/onboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://kyc.sbx.moduluslabs.io/v2/onboard");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"merchantName\": \"<string>\",\n \"modeOfPayments\": [],\n \"tin\": \"<string>\",\n \"industry\": \"<string>\",\n \"serviceDescription\": \"<string>\",\n \"isBrickAndMortarStore\": true,\n \"address\": {\n \"office\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n }\n },\n \"representatives\": {\n \"authorized\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"mothersMaidenName\": \"<string>\"\n },\n \"escalation\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"tin\": \"<string>\",\n \"sss\": \"<string>\",\n \"position\": \"<string>\"\n }\n },\n \"banks\": [\n {\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\"\n }\n ],\n \"businessType\": \"<string>\",\n \"parentOnboardingRefNo\": \"<string>\",\n \"isWantPackworksWallet\": true,\n \"isWantPayMayaWallet\": true,\n \"isWantPayMayaBankAccount\": true,\n \"legalName\": \"<string>\",\n \"businessHandle\": \"<string>\",\n \"incorporators\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"contactNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": {\n \"city\": \"<string>\",\n \"line1\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"contactNumber\": \"<string>\",\n \"barangay\": \"<string>\",\n \"buildingNameAndNumber\": \"<string>\"\n },\n \"middleName\": \"<string>\"\n }\n ],\n \"signatories\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"position\": \"<string>\",\n \"middleName\": \"<string>\"\n }\n ],\n \"websites\": {\n \"businessWebsiteUrl\": \"<string>\",\n \"isBusinessWebsiteUnderDevelopment\": true,\n \"facebookUrl\": \"<string>\",\n \"twitterUrl\": \"<string>\",\n \"instagramUrl\": \"<string>\",\n \"tiktokUrl\": \"<string>\"\n },\n \"aubPartnerId\": \"<string>\",\n \"estimatedMonthlyGrossTransaction\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"onboardingReferenceNumber": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"details": {}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"details": {}
}Overview
This endpoint onboards a merchant to accept various payment methods. Before calling this API, you must upload all required documents using the File Upload API based on the business type.Document verification required: The API verifies that all required documents have been uploaded for the selected business type. If documents are missing, the request will fail.
Prerequisites
1
Create Account
Create a merchant account using the Create Account API to obtain an Account ID
2
Upload Documents
Upload required KYC documents via File Upload API (requirements vary by business type)
3
Generate JWT Token
Create a JWT Bearer Token with the Account ID and email (see Authentication)
4
Submit Onboarding
Call this endpoint with complete merchant details
Authentication
This endpoint requires JWT Bearer Token authentication. See the Authentication Guide for details.Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Business Type Examples
- Starter Business
- Sole Proprietor
- Partnership
- Corporation
{
"businessType": "STARTER",
"merchantName": "My Coffee Shop",
"modeOfPayments": ["ECOM", "QRPH"],
"currency": "PHP",
"tin": "123456789",
"industry": "Food and Beverage",
"serviceDescription": "Local coffee shop",
"isBrickAndMortarStore": true,
"address": {
"office": { /* required */ }
},
"representatives": {
"authorized": { /* required */ }
},
"banks": [ /* at least one required */ ]
}
Starter businesses don’t require
legalName, incorporators, or registered address.{
"businessType": "SOLE_PROPRIETOR",
"legalName": "Juan Dela Cruz Trading",
"merchantName": "JDC Store",
"incorporators": [
{
"firstName": "Juan",
"lastName": "Dela Cruz",
"emailAddress": "juan@email.com",
"contactNumber": "09123456789",
"dateOfBirth": "1985-01-15T00:00:00.000Z",
"address": { /* required */ }
}
],
"address": {
"office": { /* required */ },
"registered": { /* required */ }
},
/* ... other required fields ... */
}
Exactly 1 incorporator required for Sole Proprietor businesses.
{
"businessType": "PARTNERSHIP",
"legalName": "Smith & Jones Partnership",
"merchantName": "S&J Enterprises",
"incorporators": [
{
"firstName": "John",
"lastName": "Smith",
/* ... complete details ... */
},
{
"firstName": "Mary",
"lastName": "Jones",
/* ... complete details ... */
}
],
"address": {
"office": { /* required */ },
"registered": { /* required */ }
},
/* ... other required fields ... */
}
Exactly 2 incorporators required for Partnership businesses.
{
"businessType": "CORPORATION",
"legalName": "Acme Corporation Inc.",
"merchantName": "Acme Corp",
"incorporators": [
{ /* incorporator 1 - complete details */ },
{ /* incorporator 2 - complete details */ },
{ /* incorporator 3 - complete details */ }
],
"signatories": [
{
"firstName": "Jane",
"lastName": "Doe",
"position": "CEO"
}
],
"address": {
"office": { /* required */ },
"registered": { /* required */ }
},
/* ... other required fields ... */
}
Minimum 3 incorporators required for Corporation businesses.
Next Steps
Store Reference Number
Save the reference number for tracking and support requests
Enums Reference
All valid enum values for parameters
Error Handling
Handle onboarding errors properly
Authentication
JWT Bearer Token authentication guide
Authorizations
JWT Bearer token authentication
Body
application/json
Trading name or DBA (Doing Business As) name
Maximum string length:
500List of accepted payment modes
Minimum array length:
1Available options:
TERMINAL, ECOM, PAYMENT_LINK, QRPH, PAY_WITH_MAYA Currency. On create the service uses PHP regardless of this value.
Available options:
PHP, USD Tax Identification Number
Maximum string length:
20Pattern:
^\d+$Business industry category
Maximum string length:
200Description of services or products offered
Whether the business has a physical store location
Show child attributes
Show child attributes
Show child attributes
Show child attributes
List of bank accounts for settlement
Required array length:
1 - 2 elementsShow child attributes
Show child attributes
Business type (see Enums Reference).
Reference number of the parent onboarding record.
Whether the merchant wants a wallet.
Whether the merchant wants a Maya wallet.
Whether the merchant wants a Maya bank account.
Legal registered name of the business (required for non-STARTER types)
Maximum string length:
500Unique business handle/slug for payment links (required for non-STARTER types)
Pattern:
^([A-Za-z]|[0-9]|_|-)+$List of business incorporators (for non-STARTER types)
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
List of authorized signatories
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Optional partner identifier.
Optional estimated monthly gross transaction volume.
Response
Onboarding application submitted successfully
Unique reference number for the onboarding record
Was this page helpful?