EzKRA (KRA Microservice)
Register KRA Creds
8 min
introduction this step is used to register/update the credentials of the kra api endpoint register creds preproduction https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds production https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds sample request cams kra cams curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data '{ "priority" \[ "cams" ], "repushdelay" 300000, "cams" { "type" "cams", "config" { "userid" "camsusername", "password" "password" } } }' karvy curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data raw '{ "priority" \[ "karvy" ], "repushdelay" 300000, "karvy" { "type" "karvy", "config" { "logincredentials" { "contract" "true", "username" "username", "password" "password" }, "userid" "3428" } } }' cvl curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data '{ "priority" \[ "cvl" ], "repushdelay" 300000, "cvl" { "type" "cvl", "config" { "logincredentials" { "poscode" "", "distributorposcode" "", "password" "", "username" "", "apikey" "" }, "sftpcredentials" { "host" "", "port" "", "username" "", "password" "" } } } }' multi kra curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/creds' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data '{ "priority" \[ "karvy", "cvl", "cams" ], "repushdelay" 300000, "cvl" { "type" "cvl", "config" { "logincredentials" { "poscode" "", "distributorposcode" "", "password" "", "username" "", "apikey" "" }, "sftpcredentials" { "host" "", "port" "", "username" "", "password" "" } } }, "karvy" { "type" "karvy", "config" { "logincredentials" { "contract" "true", "username" "", "password" "" }, "userid" "" } }, "cams" { "type" "cams", "config" { "userid" "", "password" "" } } } ' "\\"repushdelay\\" must be one of \[0, 300000, 600000, 900000, 1800000, 3600000, 7200000, 10800000]" request field description cams key data type required/optional description header content type string required application/json authorization string required access token from login body priority list priority of the order in which kra should be called for pushing onboardings type string type will be kra name userid string cams kra username password string cams password karvy kra request field description key data type required/optional description header content type string required application/json authorization string required access token from login body priority list priority of the order in which kra should be called for pushing onboardings type string type will be kra name config object object to configure kra details logincredentials string object to configure kra's credentials contract string whether the user's contract form would be sent to kra username string karvy username password string karvy password userid string karvy user id cvl kra request field description key data type required/optional description header content type string required application/json authorization string required access token from login body priority list priority of the order in which kra should be called for pushing onboardings type string type will be kra name config object object to configure kra details logincredentials object object to configure kra's credentials poscode string cvl poscode password string cvl password username string cvl username distributorposcode string optional rta licensed distributor poscode and other credentials should be provided for rta use only apikey string required api key provided by cvl for json api sftpcredentials object object to configure sftp credentials host string sftp host name port string sftp port no username string sftp username password string sftp password sample responses 200 { "status" 200, "message" "credentials are updated" } 400 syntax error { "error" { "statuscode" 400, "name" "syntaxerror", "message" "unexpected string in json at position 147" } } 401 { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } 403 access forbidden the request is understood, but it has been refused or access is not allowed an accompanying error message will explain why this code is used when requests are being denied due to request limits 404 { "error" { "statuscode" 404, "name" "error", "message" "there is no method to handle post /custmers/creds" } } 500 502 bad gateway 502 bad gateway 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
