Skip to main content
Version: 1.0.2

Add Customer - Consumer

'AddCustomer-Consumer' API enables to add individual customer

Consumer customer - Any legal individual user who avails bank's services for personal financial management is recognised as a consumer customer (Individual customer)

Bank or financial institution can add a new individual customer in their ledger by using this API. On providing the individual customer details as request, the customer is added to the ledger with the generation of unique customer ID and the status becomes active.

Method: POST​

{{URL}}/jsonrpc

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

method

Mandatory

String

API method that is being called to add new customer through customer service

Constant Value: "CustomerService.AddCustomer"

id

Mandatory

String

Unique ID of API request

Sample value: "1 (Only number)"

params

Mandatory

Object

api

Mandatory

Object

signature

Mandatory

String

Signature for request validation

Sample value: "signature code"

keyId

Mandatory

String

API key used for request authentication

Sample value: "ApplicationKeyId"

credential

Mandatory

String

API credential provided by NetXD

Sample value: "Credential"

payload

Mandatory

Object

type

Mandatory

String

Type of customer

Constant value: "INDIVIDUAL"

DOB

Mandatory

String

Date of birth of individual customer

Sample value: "20200710"

title

Mandatory

Enum

Salutation of the individual customer

Valid values:

  • Mr
  • Ms
  • Mrs

Sample value: "Mr"

firstName

Mandatory

String

First name of the individual customer

Sample value: "Salim"

lastName

Mandatory

String

Last name of the individual customer

Sample value: "ESSA"

gender

Optional

Enum

Gender of the individual customer

Valid values:

  • MALE
  • FEMALE

Sample value: "MALE"

identification

Mandatory

Array

type

Mandatory

String

Type of identification provided by the customer

Constant value: "SSN"

value

Mandatory

String

Value of respective identification

Sample value: "923346506"

contact

Mandatory

Object

phoneNumber

Mandatory

String

contact number of individual customer

Sample value: "50371376"

email

Mandatory

String

Email ID of individual customer

Sample value: "cavenueapi+61@testbank.com"

address

Mandatory

Object

addressLine1

Mandatory

String

First line of customer address

Sample value: "77 HOIT RD"

city

Mandatory

String

City of customer address

Sample value: "EPSOM"

state

Mandatory

String

State of customer address

Sample value: "NH"

country

Mandatory

String

Country code of customer address

Sample value: "BH"

zip

Mandatory

String

ZIP code of customer address

Sample value: "34354"

UserName

Optional

String

Username to be assigned to the individual customer

Sample value: "9233479"

password

Optional

String

Password to be assigned to the individual customer

Sample value: "Test@1234" 


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data-raw '{"method":"CustomerService.AddCustomer","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"type":"INDIVIDUAL","DOB":"20200710","title":"Mr","firstName":"Salim.","lastName":"ESSA","gender":"MALE","identification":[{"type":"SSN","value":"923346506"}],"contact":{"phoneNumber":"50371376","email":"cavenueapi+61@testbank.com"},"address":{"addressLine1":"77 HOIT RD","city":"EPSOM","state":"NH","country":"BH","zip":"34354"},"UserName":"9233479","password":"Test@1234"}}}'

Body​


{
    "method": "CustomerService.AddCustomer",
    "id": "1",
    "params": {
        "api": {
            "signature": "{{signature}}",
            "keyId": "{{ApplicationKeyId}}",
            "credential": "{{Credential}}"
        },
        "payload": {
            "type": "INDIVIDUAL",
            "DOB": "20200710",
            "title": "Mr",
            "firstName": "Salim.",
            "lastName": "ESSA",
            "gender": "MALE",
            "identification": [
                {
                    "type": "SSN",
                    "value": "923346506"
                }
            ],
            "contact": {
                "phoneNumber": "50371376",
                "email": "cavenueapi+61@testbank.com"
            },
            "address": {
                "addressLine1": "77 HOIT RD",
                "city": "EPSOM",
                "state": "NH",
                "country": "BH",
                "zip": "34354"
            },
            "UserName": "9233479",
            "password": "Test@1234"
        }
    }
}

Response: 200​

Response Parameters
ParameterDescription

id

String

Response ID echoed from the request ID

Sample value: "1" (Only number)

result

Object

Id

String

Unique system generated ID for the newly onboarded customer

Sample value: "13346"

CustomerNumber

String

Unique system generated number that is associated with the customer information and account details of individual customer

Sample value: "343443435"

status

Enum

Status of the onboarded customer

Valid values:

  • ACTIVE - Currently active and can perform all defined activities
  • IN_ACTIVE - Not currently active
  • DORMANT - Inactive for specific period
  • SUSPENDED - Temporarily disabled
  • BLOCKED - Restricted to perform all defined activities
  • BLACK_LISTED - Permanently banned

Sample value: "ACTIVE" 


{
  "id": "1",
  "result": {
    "Id": "13346",
    "CustomerNumber": "343443435",
    "Status": "ACTIVE"
  }
}