Add Legal Representative
'AddLegalRep' API enables to add legal representative to the business customer account
Bank or financial institution can add legal representative to the business customer account for managing and operating the account. On providing the request with legal representative details and the specific account number to which to be added, the legal representative is added to the business customer account with the generation of unique legalrep ID.
Method: POST
{{URL}}/jsonrpc
Example
Request Parameters
Parameter | Description |
---|---|
method | String The API method being invoked. Sample Value: "CustomerService.AddLegalRep" |
id | String Unique identifier for the request. Used for tracking. Sample Value: "1" |
params | Object |
api | Object |
signature Mandatory | String Sign the request payload (params.payload) using private key. Sample Value: "MEQCIAbpxHpdOyBEVlmxPYv7m4Z1OvWJJYw7g7u3GE3T9nmvAiBjKHckSvb1M6O4t7FeWsn2z9Y3dMeYn3HyX/k28ek/Dw==" |
keyId | String Key ID is provided at the time of device registration. Sample Value: "348076" |
credential Mandatory | String Basic (space) [( "<Username>:<apiKey>" ) as Base64 encoded value] to be provided Sample Value: "Basic bmF2eWEubitlbXBAbmV0eGQuY29tOmY1OWIwY2NlOTU4ZTQ1YTc4MGVhZWIzYWVjOWVjZDAx" |
payload | Object |
status | String Status of the legal representative. Sample Value: "ACTIVE" |
name | String Name of the legal representative. Sample Value: "Ahmed" |
accountNumber | String Associated account number. Sample Value: "700123646308483" |
userFlags.authorizeTransaction | Boolean Indicates if the user can authorize transactions. Sample Value: true |
userFlags.selfAuthorizeTransaction | Boolean Indicates if the user can self-authorize transactions. Sample Value: true |
userFlags.canInitiateTransfer | Boolean Indicates if the user can initiate transfers. Sample Value: true |
userFlags.canApproveNewRoute | Boolean Indicates if the user can approve new payment routes. Sample Value: true |
userFlags.emailNotification | Boolean Indicates if the user should receive email notifications. Sample Value: true |
userFlags.isSignatory | Boolean Indicates if the user is a signatory. Sample Value: true |
DOB | String Date of birth in YYYYMMDD format. Sample Value: "19901107" |
dateOfEstablishment | String Establishment date in YYYYMMDD format. Sample Value: "20200215" |
identification | Object |
type | String Type of identification document. Sample Value: "SSN" |
value | String Identification number or code. Sample Value: "726280286" |
address | Object |
addressLine1 | String Address line 1. Sample Value: "2261 Market Street #4000" |
city | String City of the address Sample Value: "dallas" |
state | String State or province. Sample Value: "tn" |
country | String Country code (ISO 3166-1 alpha-2). Sample Value: "US" |
zip | String ZIP or postal code. Sample Value: "34355" |
contact | Object |
String Email address of the representative. Sample Value: "ahmed@NetXD.com" | |
PhoneNumber | String Contact phone number. Sample Value: "7528306778" |
notes | String Notes or remarks about the legal representative. Sample Value: "Legal user" |
institutionName | String Name of the associated institution. Sample Value: "samplecustomerins" |
- cURL
- C#
- Go
- NodeJS
curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"CustomerService.AddLegalRep","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"status":"ACTIVE","name":"Ahmed","accountNumber":"700123646308483","userFlags":{"authorizeTransaction":true,"selfAuthorizeTransaction":true,"canInitiateTransfer":true,"canApproveNewRoute":true,"emailNotification":true,"isSignatory":true},"DOB":"19901107","dateOfEstablishment":"20200215","identification":{"type":"SSN","value":"726280286"},"address":{"addressLine1":"2261 Market Street #4000","city":"dallas","state":"tn","country":"US","zip":"34355"},"contact":{"email":"ahmed@NetXD.com","PhoneNumber":"7528306778"},"notes":"Legal user","institutionName":"samplecustomerins"}}}'
var options = new RestClientOptions("{{URL}}/jsonrpc")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@" ""method"": ""CustomerService.AddLegalRep""," + "\n" +
@" ""id"": ""1""," + "\n" +
@" ""params"": {" + "\n" +
@" ""api"": {" + "\n" +
@" ""signature"": ""{{signature}}""," + "\n" +
@" ""keyId"": ""{{ApplicationKeyId}}""," + "\n" +
@" ""credential"": ""{{Credential}}""" + "\n" +
@" }," + "\n" +
@" ""payload"": {" + "\n" +
@" ""status"":""ACTIVE""," + "\n" +
@" ""name"": ""Ahmed""," + "\n" +
@" ""accountNumber"": ""700123646308483""," + "\n" +
@" ""userFlags"": {" + "\n" +
@" ""authorizeTransaction"": true," + "\n" +
@" ""selfAuthorizeTransaction"": true," + "\n" +
@" ""canInitiateTransfer"": true," + "\n" +
@" ""canApproveNewRoute"": true," + "\n" +
@" ""emailNotification"": true," + "\n" +
@" ""isSignatory"": true" + "\n" +
@" }," + "\n" +
@" ""DOB"": ""19901107""," + "\n" +
@" ""dateOfEstablishment"": ""20200215""," + "\n" +
@" ""identification"": {" + "\n" +
@" ""type"": ""SSN""," + "\n" +
@" ""value"": ""726280286""" + "\n" +
@" }," + "\n" +
@" ""address"": {" + "\n" +
@" ""addressLine1"": ""2261 Market Street #4000""," + "\n" +
@" ""city"": ""dallas""," + "\n" +
@" ""state"": ""tn""," + "\n" +
@" ""country"": ""US""," + "\n" +
@" ""zip"": ""34355""" + "\n" +
@" }," + "\n" +
@" ""contact"": {" + "\n" +
@" ""email"": ""ahmed@NetXD.com""," + "\n" +
@" ""PhoneNumber"": ""7528306778""" + "\n" +
@" }," + "\n" +
@" ""notes"": ""Legal user""," + "\n" +
@" ""institutionName"": ""samplecustomerins""" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{URL}}/jsonrpc"
method := "POST"
payload := strings.NewReader(`{
"method": "CustomerService.AddLegalRep",
"id": "1",
"params": {
"api": {
"signature": "{{signature}}",
"keyId": "{{ApplicationKeyId}}",
"credential": "{{Credential}}"
},
"payload": {
"status":"ACTIVE",
"name": "Ahmed",
"accountNumber": "700123646308483",
"userFlags": {
"authorizeTransaction": true,
"selfAuthorizeTransaction": true,
"canInitiateTransfer": true,
"canApproveNewRoute": true,
"emailNotification": true,
"isSignatory": true
},
"DOB": "19901107",
"dateOfEstablishment": "20200215",
"identification": {
"type": "SSN",
"value": "726280286"
},
"address": {
"addressLine1": "2261 Market Street #4000",
"city": "dallas",
"state": "tn",
"country": "US",
"zip": "34355"
},
"contact": {
"email": "ahmed@NetXD.com",
"PhoneNumber": "7528306778"
},
"notes": "Legal user",
"institutionName": "samplecustomerins"
}
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'POST',
'hostname': '{{URL}}',
'path': '/jsonrpc',
'headers': {
'Content-Type': 'application/json'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"method": "CustomerService.AddLegalRep",
"id": "1",
"params": {
"api": {
"signature": "{{signature}}",
"keyId": "{{ApplicationKeyId}}",
"credential": "{{Credential}}"
},
"payload": {
"status": "ACTIVE",
"name": "Ahmed",
"accountNumber": "700123646308483",
"userFlags": {
"authorizeTransaction": true,
"selfAuthorizeTransaction": true,
"canInitiateTransfer": true,
"canApproveNewRoute": true,
"emailNotification": true,
"isSignatory": true
},
"DOB": "19901107",
"dateOfEstablishment": "20200215",
"identification": {
"type": "SSN",
"value": "726280286"
},
"address": {
"addressLine1": "2261 Market Street #4000",
"city": "dallas",
"state": "tn",
"country": "US",
"zip": "34355"
},
"contact": {
"email": "ahmed@NetXD.com",
"PhoneNumber": "7528306778"
},
"notes": "Legal user",
"institutionName": "samplecustomerins"
}
}
});
req.write(postData);
req.end();
Body
{
"method": "CustomerService.AddLegalRep",
"id": "1",
"params": {
"api": {
"signature": "{{signature}}",
"keyId": "{{ApplicationKeyId}}",
"credential": "{{Credential}}"
},
"payload": {
"status":"ACTIVE",
"name": "Ahmed",
"accountNumber": "700123646308483",
"userFlags": {
"authorizeTransaction": true,
"selfAuthorizeTransaction": true,
"canInitiateTransfer": true,
"canApproveNewRoute": true,
"emailNotification": true,
"isSignatory": true
},
"DOB": "19901107",
"dateOfEstablishment": "20200215",
"identification": {
"type": "SSN",
"value": "726280286"
},
"address": {
"addressLine1": "2261 Market Street #4000",
"city": "dallas",
"state": "tn",
"country": "US",
"zip": "34355"
},
"contact": {
"email": "ahmed@NetXD.com",
"PhoneNumber": "7528306778"
},
"notes": "Legal user",
"institutionName": "samplecustomerins"
}
}
}
Response: 200
Request Parameters
Parameter | Description |
---|---|
id | String Echoed request identifier. Used to match the response to the original request. Sample Value: "1" |
result | Object |
ID | String Unique identifier of the legal representative. Sample Value: "608048" |
type | String Type of user. Sample Value: "LEGAL_REP" |
name | String Name of the legal representative. Sample Value: "Ahmed" |
address | Object |
addressLine1 | String Address line 1. Sample Value: "2261 Market Street #4000" |
city | String City of the address. Sample Value: "dallas" |
state | String State or province. Sample Value: "tn" |
country | String Country code in ISO 3166-1 alpha-2 format. Sample Value: "US" |
zip | String ZIP or postal code. Sample Value: "34355" |
status | String Current status of the legal representative. Sample Value: "ACTIVE" |
isActive | Boolean Indicates whether the legal representative is active. Sample Value: true |
createdDate | String ISO 8601 timestamp when the record was created. Sample Value: "2025-06-30T08:55:30.784689517Z" |
updatedDate | String ISO 8601 timestamp when the record was last updated. Sample Value: "2025-06-30T08:55:30.784690773Z" |
dOB | String Date of birth in YYYYMMDD format. Sample Value: "19901107" |
contact | Object |
String Masked email address of the legal representative. Sample Value: "ah**d@netxd.com" | |
phoneNumber | String Masked phone number of the legal representative. Sample Value: "**6778" |
identification | Object |
type | String Type of identification document. Sample Value: "SSN" |
value | String Masked identification value. Sample Value: "*0286" |
institutionName | String Name of the associated institution. Sample Value: "samplecustomerins" |
dateOfEstablishment | String Date of establishment in YYYYMMDD format. Sample Value: "20200215" |
notes | String Notes or remarks about the legal representative. Sample Value: "Legal user" |
ceTransactionNumber | String CE transaction reference number. Sample Value: "PL608049" |
legalRepNumber | String Unique identifier assigned to the legal representative. Sample Value: "20000011012" |
tenantId | String Identifier of the tenant/organization. Sample Value: "OID0000001001" |
jsonrpc | String JSON-RPC protocol version. Sample Value: "2.0" |
{
"id": "1",
"result": {
"ID": "608048",
"type": "LEGAL_REP",
"name": "Ahmed",
"address": {
"addressLine1": "2261 Market Street #4000",
"city": "dallas",
"state": "tn",
"country": "US",
"zip": "34355"
},
"status": "ACTIVE",
"isActive": true,
"createdDate": "2025-06-30T08:55:30.784689517Z",
"updatedDate": "2025-06-30T08:55:30.784690773Z",
"dOB": "19901107",
"contact": {
"email": "ah**d@netxd.com",
"phoneNumber": "******6778"
},
"identification": {
"type": "SSN",
"value": "*****0286"
},
"institutionName": "samplecustomerins",
"dateOfEstablishment": "20200215",
"notes": "Legal user",
"ceTransactionNumber": "PL608049",
"legalRepNumber": "20000011012",
"tenantId": "OID0000001001"
},
"jsonrpc": "2.0"
}