Creating a New Channel

for each distributor channel, you can create a channel object by providing the required properties endpoint /api/channels/ … your channel id… /channels the channel id is the userid that you get from the login call as described above request type post headers 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 json payload { "product productid" " ", "product customerid" " ", "product accesstoken" " ", "control active" true, "control allowedcount" 20, "control updateproductinfo" true, "control selfupdation" true, "control updatecontrols" true, "control createchildren" true, "control enablefrontendurls" false, "disableemailfromamc" false, "username" " ", "password" " ", "email" " ", "callbackonaction" { "accepted" " ", "rejected" " ", "draft" " " }, "pagecallbackurl" { "identity" " ", "address" " ", "corraddress" " ", "bankaccount" " ", "documents" " ", "fatca" " ", "signature" " ", "photo" " ", "video" " ", "contract" " ", "submit" " " } } the api accepts the following properties as detailed in the table below property data type example values username string username password string password email string email product productid string investoronbaording product customerid string 5219872648addff product accesstoken string whr320jrehbfdvipkqwmnh control active boolean true/false control allowedcount integer integer control updateproductinfo boolean true/false control selfupdation boolean true/false control updatecontrols boolean true/false control createchildren boolean true/false control enablefrontendurls boolean true/false disableemailfromamc boolean true/false callbackonaction object pagecallbackurl object field descriptions 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 expected response { "product productid" " ", "product customerid" " ", "product accesstoken" " ", "control active" false, "control allowedcount" 20, "control updateproductinfo" false, "control selfupdation" true, "control updatecontrols" true, "control createchildren" true, "control enablefrontendurls" false, "disableemailfromamc" false, "username" " ", "email" " ", "id" " ", "channelid" " ", "callbackonaction" { "accepted" " ", "rejected" " ", "draft" " " }, "pagecallbackurl" { "identity" " ", "address" " ", "corraddress" " ", "bankaccount" " ", "documents" " ", "fatca" " ", "signature" " ", "photo" " ", "video" " ", "contract" " ", "submit" " " } } getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at help\@signzy com