Creating a New Channel

For each distributor channel, you can create a channel object by providing the required properties.

/api/channels/….your-channel-id…./channels

The channel-id is the userID that you get from the login call as described above.

POST

Content-type: “application/json” -> This is constant

Authorization: “your access token” -> You will receive the access token from the login API call as described above.

The API accepts the following properties as detailed in the table below:

product_productId

This information tells what Signzy’s product does this particular channel allowed to push data into.

value = 'investorOnboarding’

Currently, only the above value is allowed.

product_customerId

The product_customerId is obtained for a particular user by logging into Signzy’s product as defined by the above definition. The userId parameter of the login call is where you get the value of this parameter.

product_accessToken

The product_accessToken is obtained for a particular user by logging into Signzy’s product as defined by the above definition. The id parameter of the login call is where you get the value of this parameter.

control_active

If control_active is set as true, only then the API calls from the channels will be allowed to enter into the Signzy system, if this property isn’t set or is set to false, that channel won’t make the channel API calls or onboarding API calls. Defaults to true if not set.

control_allowedCount

This property defines the number of onboarding objects that this channel can create. Defaults to 500 if not set.

control_selfUpdation

If this property is not set or set to false, then the update calls to its own object. The self-updation API mentioned below will not be enabled. This enables the channels to update the username, password, and email. For updating product specifications and the control parameters, control_updateControls & control_updateProductInfo should also be set. Defaults to true if not set.

control_updateControls

If this property is not set or set to false, then the channel won’t be able to update the properties which have a prefix of control_. Defaults to false if not set.

control_updateProductInfo

If this property is not set or set to false, then the channel won’t be able to update the properties which have a prefix of product_. Defaults to false if not set.

control_createChildren

If this property is not set or set to false, then the channel won’t be able to child channels. Channels won’t be able to call the create channel API if this is not set or set as false. Defaults to false if not set.

control_enableFrontendURLs

Enables showing of frontend Web URLs for onboarding in response of create Onboarding API, in JSON keys: applicationUrl, autoLoginUrL, mobileLoginUrl, mobileAutoLoginUrl

disableEmailFromAmc

Flag to Disable/Enable Emails that are sent to investors on behalf of AMC. true implies email won't be sent. Defaults to false if not set.

callbackOnAction

This object contains the list of callback URLs, to which data is to be posted when any corresponding action is taken on the application. Defaults to empty if not set.

pageCallbackUrl

This object contains the list of callback URLs, to which data is to be posted when any step is completed by the investor. Defaults to empty if not set.