Skip to main content
Version: 1.0.2

Add Customer - Business

'AddCustomer-Business' API enables to add business customer

Business Customer - A Fintech or any registered business entity that is onboarded as customer is recognised as a business customer

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

note

Refer Add Share holder API to add shareholders of business customer Refer Add Legal Representative API to add users who are responsible for operating the account

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 numbers)

params

Mandatory

Object

api

Mandatory

Object

signature

Mandatory

String

Signature for request validation

Sample value – "signature"

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 – "BUSINESS"

businessNameLegal

Mandatory

String

Legal business name of customer

Sample value – "SMALLSYS INC"

dateEstablished

Mandatory

String

Establishment Date of business entity in YYYYMMDD format

Sample value – "20200714"

identification

Mandatory

Array

type

Mandatory

String

Type of identification provided by the customer

Constant value – "TIN"

value

Mandatory

String

Value of respective identification

Sample value – "764969832"

contact

Mandatory

Object

phoneNumber

Mandatory

String

Business contact number of customer

Sample value – "4802150422"

email

Mandatory

String

Business Email ID of customer

Sample value – "daves@bank.com"

address

Mandatory

Object

addressLine1

Mandatory

String

First line of business address

Sample value – "795 E DRAGRAM"

city

Mandatory

String

City of business address

Sample value – "TUCSON"

state

Mandatory

String

State of business address

Sample value – "AZ"

country

Mandatory

String

Country of business address

Sample value – "US"

zip

Mandatory

String

Zip code of of business address

Sample value – "85705"

kycStatus

Optional

String

Status of Know Your Customer verification and compliance (Customer onboarding is possible only if the KYC status is 'ACTIVE')

Constant value – "ACTIVE"

kycData

Optional

Object

applicationId

Optional

String

Unique KYC Application ID generated by the KYC system

Sample value – "KYC_00002990750"

refId

Optional

String

Reference ID for KYC process

Sample value – "2371226d-a6c2-4358-9250-157e80be05c8"

additionalkycinfo

Optional

Object

Contains additional KYC information (if available) in JSON format


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":"BUSINESS","businessNameLegal":"SMALLSYS INC","dateEstablished":"20200714","identification":[{"type":"TIN","value":"764969832"}],"contact":{"phoneNumber":"4802150422","email":"daves@bank.com"},"address":{"addressLine1":"795 E DRAGRAM","city":"TUCSON","state":"AZ","country":"US","zip":"85705"},"kycStatus":"ACTIVE","kycData":{"applicationId":"KYC_00002990750","refId":"2371226d-a6c2-4358-9250-157e80be05c8","additionalkycinfo":{}}}}}'

Body​


{
  "method": "CustomerService.AddCustomer",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "type": "BUSINESS",
      "businessNameLegal": "SMALLSYS INC",
      "dateEstablished": "20200714",
      "identification": [
        {
          "type": "TIN",
          "value": "764969832"
        }
      ],
      "contact": {
        "phoneNumber": "4802150422",
        "email": "daves@bank.com"
      },
      "address": {
        "addressLine1": "795 E DRAGRAM",
        "city": "TUCSON",
        "state": "AZ",
        "country": "US",
        "zip": "85705"
      },
      "kycStatus": "ACTIVE",
      "kycData": {
        "applicationId": "KYC_00002990750",
        "refId": "2371226d-a6c2-4358-9250-157e80be05c8",
        "additionalkycinfo": {}
      }
    }
  }
}

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: "100000000046614"

CustomerNumber

String

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

Sample value: "100000000046614"

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": "100000000046614",
    "CustomerNumber": "100000000046614",
    "Status": "ACTIVE"
  }
}