import cobo_waas2
from cobo_waas2.models.merchant_kyc_submission import MerchantKycSubmission
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.PaymentApi(api_client)
merchant_id = "M1001"
try:
# Get merchant KYC
api_response = api_instance.get_merchant_kyc(merchant_id)
print("The response of PaymentApi->get_merchant_kyc:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_merchant_kyc: %s\n" % e)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
String merchantId = "M1001";
try {
MerchantKycSubmission result = apiInstance.getMerchantKyc(merchantId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getMerchantKyc");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
merchantId := "M1001"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.GetMerchantKyc(ctx, merchantId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetMerchantKyc``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMerchantKyc`: MerchantKycSubmission
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetMerchantKyc`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const merchant_id = "M1001";
apiInstance.getMerchantKyc(merchant_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"kyc_submission_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"merchant_id": "M1001",
"status": "PendingReview",
"email": "[email protected]",
"phone": "+85212345678",
"merchant_type": "B2B",
"country": "HKG",
"industry": [
"E-commerce"
],
"company_info": {
"company_type": "Corporation",
"listed": false,
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/business_registration.pdf",
"file_type": "BR"
}
],
"operation_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
},
"identify_no": "12345678",
"company_name": "示例有限公司",
"company_name_en": "Example Limited",
"establish_date": "2020-01-01",
"commencement_date": "2020-01-01",
"valid_period": "2020-01-01",
"register_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
},
"legal_info": {
"name": "张三",
"name_en": "Zhang San",
"id_number": "110101199001011234",
"date_of_birth": "19900101",
"issue_date": "20180101",
"expiration_date": "20280101",
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/id_card_front.jpg",
"file_type": "PRC_ID_Emblem"
}
],
"residential_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
}
},
"ubo_infos": [
{
"name": "张三",
"name_en": "Zhang San",
"id_number": "110101199001011234",
"date_of_birth": "19900101",
"issue_date": "20180101",
"expiration_date": "20280101",
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/id_card_front.jpg",
"file_type": "PRC_ID_Emblem"
}
],
"residential_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
}
}
],
"online_store_url": "https://example.com/store"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Get merchant KYC
This operation retrieves the KYC submission for a specified merchant.
The merchant ID can be retrieved by calling List all merchants.
import cobo_waas2
from cobo_waas2.models.merchant_kyc_submission import MerchantKycSubmission
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.PaymentApi(api_client)
merchant_id = "M1001"
try:
# Get merchant KYC
api_response = api_instance.get_merchant_kyc(merchant_id)
print("The response of PaymentApi->get_merchant_kyc:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_merchant_kyc: %s\n" % e)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
String merchantId = "M1001";
try {
MerchantKycSubmission result = apiInstance.getMerchantKyc(merchantId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getMerchantKyc");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
merchantId := "M1001"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.GetMerchantKyc(ctx, merchantId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetMerchantKyc``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMerchantKyc`: MerchantKycSubmission
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetMerchantKyc`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const merchant_id = "M1001";
apiInstance.getMerchantKyc(merchant_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"kyc_submission_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"merchant_id": "M1001",
"status": "PendingReview",
"email": "[email protected]",
"phone": "+85212345678",
"merchant_type": "B2B",
"country": "HKG",
"industry": [
"E-commerce"
],
"company_info": {
"company_type": "Corporation",
"listed": false,
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/business_registration.pdf",
"file_type": "BR"
}
],
"operation_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
},
"identify_no": "12345678",
"company_name": "示例有限公司",
"company_name_en": "Example Limited",
"establish_date": "2020-01-01",
"commencement_date": "2020-01-01",
"valid_period": "2020-01-01",
"register_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
},
"legal_info": {
"name": "张三",
"name_en": "Zhang San",
"id_number": "110101199001011234",
"date_of_birth": "19900101",
"issue_date": "20180101",
"expiration_date": "20280101",
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/id_card_front.jpg",
"file_type": "PRC_ID_Emblem"
}
],
"residential_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
}
},
"ubo_infos": [
{
"name": "张三",
"name_en": "Zhang San",
"id_number": "110101199001011234",
"date_of_birth": "19900101",
"issue_date": "20180101",
"expiration_date": "20280101",
"attachments": [
{
"file_id": "https://example-bucket.s3.us-east-1.amazonaws.com/uploads/id_card_front.jpg",
"file_type": "PRC_ID_Emblem"
}
],
"residential_address": {
"country": "HK",
"state": "Hong Kong",
"city": "Hong Kong",
"postcode": "999077",
"line1": "1 Example Street"
}
}
],
"online_store_url": "https://example.com/store"
},
"created_timestamp": 1744689600,
"updated_timestamp": 1744689600
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}import cobo_waas2
from cobo_waas2.models.merchant_kyc_submission import MerchantKycSubmission
from cobo_waas2.rest import ApiException
from pprint import pprint
# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
# Replace `<YOUR_PRIVATE_KEY>` with your private key
api_private_key="<YOUR_PRIVATE_KEY>",
# Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cobo_waas2.PaymentApi(api_client)
merchant_id = "M1001"
try:
# Get merchant KYC
api_response = api_instance.get_merchant_kyc(merchant_id)
print("The response of PaymentApi->get_merchant_kyc:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_merchant_kyc: %s\n" % e)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
String merchantId = "M1001";
try {
MerchantKycSubmission result = apiInstance.getMerchantKyc(merchantId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getMerchantKyc");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
merchantId := "M1001"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.GetMerchantKyc(ctx, merchantId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetMerchantKyc``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMerchantKyc`: MerchantKycSubmission
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetMerchantKyc`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const merchant_id = "M1001";
apiInstance.getMerchantKyc(merchant_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Path Parameters
The merchant ID.
Response
The request was successful.
The KYC submission ID.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
The merchant ID.
"M1001"
The KYC submission status. Possible values include:
PendingReview: The KYC submission is pending review.Completed: The KYC submission has been completed.Failed: The KYC submission has failed.
PendingReview, Completed, Failed "PendingReview"
The merchant email address.
The merchant phone number.
"+85212345678"
The merchant type. Possible values include:
B2B: Business-to-business merchant.B2C: Business-to-consumer merchant.
B2B, B2C "B2B"
The country/region of the merchant, in ISO 3166-1 alpha-3 format.
"HKG"
The industry categories of the merchant.
["E-commerce"]
Show child attributes
Show child attributes
The creation timestamp in Unix seconds.
1744689600
The last update timestamp in Unix seconds.
1744689600
