Skip to main content

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
ParameterDescription
methodString
The API method being invoked.
Sample Value: "CustomerService.AddLegalRep"
idString
Unique identifier for the request. Used for tracking.
Sample Value: "1"
paramsObject
apiObject
signature

Mandatory
String
Sign the request payload (params.payload) using private key.
Sample Value: "MEQCIAbpxHpdOyBEVlmxPYv7m4Z1OvWJJYw7g7u3GE3T9nmvAiBjKHckSvb1M6O4t7FeWsn2z9Y3dMeYn3HyX/k28ek/Dw=="
keyIdString
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"
payloadObject
statusString
Status of the legal representative.
Sample Value: "ACTIVE"
nameString
Name of the legal representative.
Sample Value: "Ahmed"
accountNumberString
Associated account number.
Sample Value: "700123646308483"
userFlags.authorizeTransactionBoolean
Indicates if the user can authorize transactions.
Sample Value: true
userFlags.selfAuthorizeTransactionBoolean
Indicates if the user can self-authorize transactions.
Sample Value: true
userFlags.canInitiateTransferBoolean
Indicates if the user can initiate transfers.
Sample Value: true
userFlags.canApproveNewRouteBoolean
Indicates if the user can approve new payment routes.
Sample Value: true
userFlags.emailNotificationBoolean
Indicates if the user should receive email notifications.
Sample Value: true
userFlags.isSignatoryBoolean
Indicates if the user is a signatory.
Sample Value: true
DOBString
Date of birth in YYYYMMDD format.
Sample Value: "19901107"
dateOfEstablishmentString
Establishment date in YYYYMMDD format.
Sample Value: "20200215"
identificationObject
typeString
Type of identification document.
Sample Value: "SSN"
valueString
Identification number or code.
Sample Value: "726280286"
addressObject
addressLine1String
Address line 1.
Sample Value: "2261 Market Street #4000"
cityString
City of the address
Sample Value: "dallas"
stateString
State or province.
Sample Value: "tn"
countryString
Country code (ISO 3166-1 alpha-2).
Sample Value: "US"
zipString
ZIP or postal code.
Sample Value: "34355"
contactObject
emailString
Email address of the representative.
Sample Value: "ahmed@NetXD.com"
PhoneNumberString
Contact phone number.
Sample Value: "7528306778"
notesString
Notes or remarks about the legal representative.
Sample Value: "Legal user"
institutionNameString
Name of the associated institution.
Sample Value: "samplecustomerins"

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"}}}'

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
ParameterDescription
idString
Echoed request identifier. Used to match the response to the original request.
Sample Value: "1"
resultObject
IDString
Unique identifier of the legal representative.
Sample Value: "608048"
typeString
Type of user.
Sample Value: "LEGAL_REP"
nameString
Name of the legal representative.
Sample Value: "Ahmed"
addressObject
addressLine1String
Address line 1.
Sample Value: "2261 Market Street #4000"
cityString
City of the address.
Sample Value: "dallas"
stateString
State or province.
Sample Value: "tn"
countryString
Country code in ISO 3166-1 alpha-2 format.
Sample Value: "US"
zipString
ZIP or postal code.
Sample Value: "34355"
statusString
Current status of the legal representative.
Sample Value: "ACTIVE"
isActiveBoolean
Indicates whether the legal representative is active.
Sample Value: true
createdDateString
ISO 8601 timestamp when the record was created.
Sample Value: "2025-06-30T08:55:30.784689517Z"
updatedDateString
ISO 8601 timestamp when the record was last updated.
Sample Value: "2025-06-30T08:55:30.784690773Z"
dOBString
Date of birth in YYYYMMDD format.
Sample Value: "19901107"
contactObject
emailString
Masked email address of the legal representative.
Sample Value: "ah**d@netxd.com"
phoneNumberString
Masked phone number of the legal representative.
Sample Value: "**6778"
identificationObject
typeString
Type of identification document.
Sample Value: "SSN"
valueString
Masked identification value.
Sample Value: "*0286"
institutionNameString
Name of the associated institution.
Sample Value: "samplecustomerins"
dateOfEstablishmentString
Date of establishment in YYYYMMDD format.
Sample Value: "20200215"
notesString
Notes or remarks about the legal representative.
Sample Value: "Legal user"
ceTransactionNumberString
CE transaction reference number.
Sample Value: "PL608049"
legalRepNumberString
Unique identifier assigned to the legal representative.
Sample Value: "20000011012"
tenantIdString
Identifier of the tenant/organization.
Sample Value: "OID0000001001"
jsonrpcString
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"
}