GetGroupClient

GetGroupClient retrieves the client compliance profile associated with a specific group.

This allows fetching the compliance details of the client that is owned by the specified group, using the group's resource name as the lookup key.

Overview

Method Options

Authorisation specification of the GetGroupClient method.

Type	METHOD_TYPE_READ
Access Level	METHOD_ACCESS_LEVEL_AUTHORISED
Roles	ROLE_COMPLIANCE_ADMIN ROLE_COMPLIANCE_VIEWER ROLE_COMPLIANCE_CLIENT_ADMIN ROLE_COMPLIANCE_CLIENT_VIEWER

Parameters

Request and response parameter message overview:

Input: GetGroupClientRequest Message

Field	Type	Required	Description
Group	string	True	The resource name of the group whose client is to be retrieved. Format: "groups/{group_id}"

Returns: Client Message

Protobuf

syntax = "proto3";

package meshtrade.compliance.client.v1;

import "buf/validate/validate.proto";
import "meshtrade/compliance/client/v1/client.proto";
import "meshtrade/option/method_options/v1/method_options.proto";

option go_package = "github.com/meshtrade/api/go/compliance/client/v1;client_v1";
option java_package = "co.meshtrade.api.compliance.client.v1";

// Service manages client profiles for compliance and Know Your Customer (KYC)
// purposes.
//
// The main entity managed by this service is the `Client` resource. A client can
// be a natural person, company, or trust. This service allows you to retrieve
// the compliance profiles for these clients.
service ClientService {
  // CreateClient creates a single client.
  rpc CreateClient(CreateClientRequest) returns (meshtrade.compliance.client.v1.Client) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_WRITE
      access_level: METHOD_ACCESS_LEVEL_AUTHORISED
      roles: [
        ROLE_COMPLIANCE_ADMIN,
        ROLE_COMPLIANCE_CLIENT_ADMIN
      ]
    };
  }

  // GetClient retrieves a single client's compliance profile by its unique resource name.
  //
  // This allows for fetching the complete compliance details of a specific client,
  // including all associated information like identification documents, tax residencies,
  // and company structures.
  rpc GetClient(GetClientRequest) returns (meshtrade.compliance.client.v1.Client) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_READ
      access_level: METHOD_ACCESS_LEVEL_AUTHORISED
      roles: [
        ROLE_COMPLIANCE_ADMIN,
        ROLE_COMPLIANCE_VIEWER,
        ROLE_COMPLIANCE_CLIENT_ADMIN,
        ROLE_COMPLIANCE_CLIENT_VIEWER
      ]
    };
  }

  // GetGroupClient retrieves the client compliance profile associated with a specific group.
  //
  // This allows fetching the compliance details of the client that is owned by
  // the specified group, using the group's resource name as the lookup key.
  rpc GetGroupClient(GetGroupClientRequest) returns (meshtrade.compliance.client.v1.Client) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_READ
      access_level: METHOD_ACCESS_LEVEL_AUTHORISED
      roles: [
        ROLE_COMPLIANCE_ADMIN,
        ROLE_COMPLIANCE_VIEWER,
        ROLE_COMPLIANCE_CLIENT_ADMIN,
        ROLE_COMPLIANCE_CLIENT_VIEWER
      ]
    };
  }

  // ListClients retrieves a collection of client compliance profiles.
  //
  // This method is useful for fetching multiple client records at once.
  // Note: This endpoint does not currently support pagination or filtering.
  rpc ListClients(ListClientsRequest) returns (ListClientsResponse) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_READ
      access_level: METHOD_ACCESS_LEVEL_AUTHORISED
      roles: [
        ROLE_COMPLIANCE_ADMIN,
        ROLE_COMPLIANCE_VIEWER,
        ROLE_COMPLIANCE_CLIENT_ADMIN,
        ROLE_COMPLIANCE_CLIENT_VIEWER
      ]
    };
  }
}

// GetClientRequest is the message used to request a single client resource.
message GetClientRequest {
  // The unique resource name of the client to be retrieved.
  // The name serves as the primary identifier for the client resource.
  // Format: "compliance/clients/{client_id}"
  string name = 1 [(buf.validate.field) = {
    required: true
    string: {
      len: 45
      pattern: "^compliance/clients/[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$"
    }
  }];
}

// CreateClientRequest is the message used to create a single client resource.
message CreateClientRequest {
  // Client is the client resource to create.
  meshtrade.compliance.client.v1.Client client = 1 [(buf.validate.field) = {required: true}];
}

// GetGroupClientRequest is the message used to request a client resource by its owning group.
message GetGroupClientRequest {
  // The resource name of the group whose client is to be retrieved.
  // Format: "groups/{group_id}"
  string group = 1 [(buf.validate.field) = {
    required: true
    string: {
      len: 33
      pattern: "^groups/[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$"
    }
  }];
}

// ListClientsRequest is the message used to request a list of client resources.
message ListClientsRequest {}

// ListClientsResponse contains a list of client resources.
message ListClientsResponse {
  // A repeated field containing the client resource objects.
  repeated meshtrade.compliance.client.v1.Client clients = 1;
}

Code Examples

Select supported SDK in the language of your choice for a full example of how to invoke the this method:

Go

package main

import (
	"context"
	"log"

	clientv1 "github.com/meshtrade/api/go/compliance/client/v1"
)

func main() {
	ctx := context.Background()

	// Default configuration is used and credentials come from MESH_API_CREDENTIALS
	// environment variable or default discovery methods. Zero config required
	// unless you want custom configuration.
	service, err := clientv1.NewClientService()
	if err != nil {
		log.Fatalf("Failed to create service: %v", err)
	}
	defer service.Close()

	// Create request with service-specific parameters
	request := &clientv1.GetGroupClientRequest{
		// FIXME: Populate service-specific request fields
	}

	// Call the GetGroupClient method
	client, err := service.GetGroupClient(ctx, request)
	if err != nil {
		log.Fatalf("GetGroupClient failed: %v", err)
	}

	// FIXME: Add relevant response object usage
	log.Printf("GetGroupClient successful: %+v", client)
}

Python

from meshtrade.compliance.client.v1 import (
    ClientService,
    GetGroupClientRequest,
)


def main():
    # Default configuration is used and credentials come from MESH_API_CREDENTIALS
    # environment variable or default discovery methods. Zero config required
    # unless you want custom configuration.
    service = ClientService()

    with service:
        # Create request with service-specific parameters
        request = GetGroupClientRequest(
            # FIXME: Populate service-specific request fields
        )

        # Call the GetGroupClient method
        client = service.get_group_client(request)

        # FIXME: Add relevant response object usage
        print("GetGroupClient successful:", client)


if __name__ == "__main__":
    main()

Java

import co.meshtrade.api.compliance.client.v1.ClientService;
import co.meshtrade.api.compliance.client.v1.Service.GetGroupClientRequest;
import co.meshtrade.api.compliance.client.v1.Client.Client;

import java.util.Optional;

public class GetGroupClientExample {
    public static void main(String[] args) {
        // Default configuration is used and credentials come from MESH_API_CREDENTIALS
        // environment variable or default discovery methods. Zero config required
        // unless you want custom configuration.
        try (ClientService service = new ClientService()) {
            // Create request with service-specific parameters
            GetGroupClientRequest request = GetGroupClientRequest.newBuilder()
                // FIXME: Populate service-specific request fields
                .build();

            // Call the GetGroupClient method
            Client client = service.getGroupClient(request, Optional.empty());

            // FIXME: Add relevant response object usage
            System.out.println("GetGroupClient successful: " + client);
        } catch (Exception e) {
            System.err.println("GetGroupClient failed: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

Advanced Configuration

For advanced client configuration options (custom endpoints, TLS settings, timeouts), see the SDK Configuration Guide.

Other Methods

• Compliance Client v1 Method List - For Other methods