EzKRA (KRA Microservice)

Get Push Onboarding Response

6 min

introduction this step is required to get the details of the onboarding customer once the data is pushed for further validation api endpoint preproduction https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/{{customerid}}/onboardings/{{onboardingid}} production https //backops investor onboarding signzy tech/kra handler/api/customers/{{customerid}}/onboardings/{{onboardingid}} sample request curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/customers/63cf75672bf6b08ae7a28f61/onboardings/null' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data '' request field description key data type required/optional description header content type string required application/json authorization string required access token from login sample responses the “response cvl” is the comprehensive output for all responses associated with a specific onboarding id the field “response cvlresponsehistory” is an array that stores all responses from previous repushes and auto retries, maintaining them in standard response formats tracking of cvl form submission success is enabled to facilitate the transfer of kyc documents to sftp upon successful form submission 200 ok { "customerid" "64xxxxxea", "id" "65xxxxxx90", "response" { "cvl" { "merchantid" "65xxxxxx90", "uuid" "bxxx8 fxxe 4xxf 8xx5 fxxxxx9", "kratype" "cvl", "rawresponse" { "statuscode" "200", "respbody" { "msg" { "msg" "sftp done", "applicationstatus" "200" } } }, "pushresponse" { "description" "cvl sftp process is completed", "statuscode" "200", "status" "completed" }, "result" "success", "status" "completed", "lastupdated" 1709716509947, "responsetimestamp" 1709716509947 }, "cvlresponsehistory" \[ { "uuid" "bxxx8 fxxe 4xxf 8xx5 fxxxx9", "pushtriggeredby" "64xxxxxea", "status" "completed", "lastupdated" 1709716509974, "timestamp" 1709716505754, "kratype" "cvlresponsehistory", "merchantid" "65xxxxxx90", "pekrn" "", "pushresponse" { "description" "cvl sftp process is completed", "statuscode" "200", "status" "completed" }, "rawresponse" { "statuscode" "200", "respbody" { "msg" { "msg" "sftp done", "applicationstatus" "200" } } }, "responsetimestamp" 1709716509947, "result" "success" } ], "cvlformupdates" { "formresponse" { "response" { "root" { "xmlns" "", "kycdata" { "app pan no" "wxxxxl", "app pan dob" {}, "app name" "signzy testing gp", "app status" "01", "app modf ack" "5xx9", "app statusdt" {}, "app entrydt" {}, "app moddt" {}, "app pos code" "axxc" }, "footer" { "app response date" "06/03/2024 14 45 08", "app total rec" "1" } }, "description" "submitted" }, "submitted" true, "formsubmissiontimestamp" 1709716508666 } } } } 401 { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } 403 when access is 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 get /6451198320bf270e75ce7/onboardings/6464ad5eb4f19100244509" } } 502 \<html> \<head> \<title>502 bad gateway\</title> \</head> \<body> \<center> \<h1>502 bad gateway\</h1> \</center> \</body> \</html> response field description key data type description customerid string client's userid obtained from customer login api response id string requestid/merchantid for every application being pushed to kra request object complete json data being pushed to kra response object object which contains response received from kra(s) as per priority (if multi kra is used) cvl/cams/karvy object name of the kra the application is being pushed on merchantid string requestid of every application being pushed to kra kratype string name of the kra the application being pushed on rawresponse(existing structure) object raw response received from kra during push which includes various fields from kra like pan, name dob, status etc pushresponse(new structure) object standardised response structure from kra description string status description received from kra statuscode string status code of kra push api status string completed or failure status of kra push api result string success or failed action of kra push api lastupdated string latest timestamp of the kra push api responsetimestamp string timestamp at which the response was available 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