Modules
...
GO API Docs
Push Application Data
4 min
introduction once the application is created the data has to be pushed into the go platform for further validation and operations to be performed the same is done using the following api sample request curl location 'https //go preproduction signzy app/api/v1/externalpushmerchant/{merchant id}' \\ \ header 'content type application/json' \\ \ header 'content type application/json' \\ \ header 'authorization \<auth token>' \\ \ data '{ "formdata" \[ { "data" { "form1 label1" "form 1 val 1", "form1 label2" "form 1 val 2", "image1" "\<persist link>", "image2" "\<persist link>" }, "pagename" "form page 1", "deletepage" false }, { "data" { "form2 label1" "form 2 val 1", "form2 label2" "form 2 val 2", "images" \[ "\<persist link>", "\<persist link>" ] }, "pagename" "form page 2", "deletepage" false } ], "documents" \[ { "data" { "doc1 label1" "doc 1 val 1", "doc1 label2" "doc 1 val 2", "image1" "\<persist link>", "image2" "\<persist link>" }, "pagename" "doc page 1", "pagetype" "doc 1" }, { "data" { "doc2 label1" "doc 2 val 1", "doc2 label2" "doc 2 val 2", "images" \[ "\<persist link>", "\<persist link>" ] }, "pagename" "doc page 2", "pagetype" "doc 2" } ], "contract" { "contractresult" { "contractid" "\<contract id>", "contractcreationtime" "\<timestamp>", "initialsignercount" 1, "signedsignercount" 1, "cancelledsignercount" 0, "deletedsignercount" 0, "contractname" "\<name>", "contractexecutername" "\<name>", "signercallbackurl" "", "callbackurlauthorizationheader" "", "signercallbackurlauthorizationheader" "", "contractttl" 1209600, "initialcontract" "\<persist link>", "initialcontracthash" "\<hash>", "finalsignedcontract" "\<persist link>", "finalsignedcontracthash" "\<hash>", "auditcertificateurl" "\<persist link>", "auditcertificatehash" "\<hash>", "iscompleted" true, "contractcompletiontime" "\<timestamp>", "contractcanceltimestamp" "", "contractstatus" "completed", "customermaillist" \[], "endoflife" 16761600, "callbackstatus" {}, "locationcapturemethod" "browser", "signerdetail" \[ { "signername" "\<name>", "signergender" "na", "signeryearofbirth" "na", "uidlastfourdigits" "", "workflowurl" "\<contracting workflow url>", "signerid" "\<signer id>", "signaturetype" "smartesign", "additionalsignaturetypes" \[ "clickwrap" ], "contractlastsigntime" "\<time>", "contractsendtime" "\<time>", "status" "success", "signercancelmessage" "", "selectedsignaturetype" "smartesign", "errormessage" "na", "aadhaarstatus" "", "aadhaarerrormessage" "na", "namematchresult" "", "signerip" "\<ip>", "noofsuccessfulattempts" 1, "signersignedcontract" "\<persist link>", "signersignedcontracthash" "\<hash>", "esignattempts" \[ { "sessionid" "\<session id>", "signerip" "\<ip>", "workflowurlopentime" "\<timestamp>", "role" "signer", "workflowurlopenedfrom" "direct", "forensics" { "userbrowserdata" { "browsercodename" "mozilla", "browsername" "\<browser name>", "browserversion" "\<version>", "cookieenabled" true, "browserlanguage" "en us", "os" "\<os version>", "useragent" "\<version>" }, "geolocationdata" { "latitude" \<lat>, "longitude" \<long> } }, "signatureselecttime" "\<timestamp>", "selectedsignaturetype" "smartesign", "signingcompletetime" "\<timestamp>", "transactionhistory" \[] } ] } ], "deletedsignerdetail" \[], "reviewerdetail" \[] }, "pagetype" "contract360" }, "changestatus" "pending" }' request field description parameters required/optional description flowid required the "flowid" refers to a specific onboarding journey created within the go platform this helps segregate different types of applications from one another realmid required this is an identifier used by the go platform, the same will be provided by the signzy team merchantid required the "merchantid" refers to the identifier generated in step 2 after creating a new application pageid required the "pageid" refers to a particular page within the onboarding flow configured in the go platform widgetname required the "widgetname" refers to any specific function/module being used within a page for verification or other operations parameter n required/optional there are many data points collected during an onboarding journey, the same are pushed to the go platform under the parameters sample response 200 ok { "result" "successfully pushed" } 400 bad request { "error" { "statuscode" 400, "name" "error", "message" "not a valid status" } } 401 unauthorized { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } 404 not found { "error" { "statuscode" 404, "name" "error", "message" "shared class \\"patron\\" has no method handling post /login/1232", "status" 404 } } 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