Create Journey Link

overview and purpose overview the create journey url api generates a unique journey link for each user, which can be integrated into a business's mobile app or website this link directs users to the kyc process configured by the client purpose the purpose of this api is to create a unique and secure url for the kyc journey, allowing end users to complete their identity verification process seamlessly through the provided link api details flow information includes the flowid (identifier for the configured kyc flow), version (version of the flow), and test (boolean indicating if it's a test flow) result object contains journeyid (unique identifier for the journey), journeyurl (url for the kyc process), createdat (timestamp of creation), and ttl (time to live for the url, e g , "24 hours") sample request preproduction curl location 'https //api preproduction signzy app/api/v3/otk service/create journey url' \\ \ header 'content type application/json' \\ \ header 'authorization \<auth token>' \\ \ data '{ "flowid" "\<flow id>", "userid" "\<user id>", "userinfo" { "phonenumber" "string", "dateofbirth" "string", "matchimage" "\<image url>", "emailaddress" "string", "externalreferenceid" "string", "name" { "firstname" "string", "lastname" "string" }, "address" { "street" "string", "street2" "string", "city" "string", "region" "string", "postalcode" "string", "country" "string" }, "id" { "idtype" "string", "country" "string" } }, "processingconfig" { "callbackurl" "https //www callbackurl com", "authkeyforcallback" "string" "redirecttime" 0, "successredirecturl" "https //www successredirecturl com", "failureredirecturl" "https //www failureredirecturl com", "journeylinkvalidity" 3600, "language" "en" } }' api request body parameters parameter data type description required flowid string unique id for flow yes userid string userid of client no userinfo object information about the user no userinfo phonenumber number phone number of the user no userinfo dateofbirth date dob of the user no userinfo matchimage string the url of the face image used for face match comparison against the selfie captured during the selfie analysis process required only for face verification–only flows not required for all other flow types userinfo emailaddress string emailid of the user no serinfo externalreferenceid string external reference no, eg client's userid no userinfo name object name of the user no userinfo name firstname string first name of the user no userinfo name lastname string last name of the user no userinfo address object address of the user no userinfo address street string specifics of the user's address no userinfo address street2 string specifics of the user's address no userinfo address city string city no userinfo address region string region no userinfo address postalcode string postal code no userinfo address country string country no userinfo id object details of user's id no userinfo id idtype string id type no userinfo id country string the country where the idtype is valid no processingconfig object this object contains all the neccessary configuration for the journey no processingconfig callbackurl string the callbackurl where the result of the journey can be posted post verification no processingconfig authkeyforcallback string auth key in case required for callback url no processingconfig redirecttime number the time in seconds after which user will be redirected to redirecturls no processingconfig successredirecturl string the user will be redirected to this url post succesful flow no processingconfig failureredirecturl string the user will be redirected to this url post unsuccessful flow no processingconfig journeylinkvalidity number the journey url will be valid for the specified seconds only default value > 3600 seconds no processingconfig language string we use iso 639 1 standard two letter codes to represent languages this is an internationally recognized format used in software systems, apis, and localization processes this will overwrite the language selected in the flow example "hi" hindi "en" english "es" spanish "ar" arabic "ru" russian n sample api response 200 { "result" { "journeyid" "abcdef", "journeyurl" "https //kyc preproduction signzy app/abcdef", "createdat" 1716184320411, "ttl" "24 hours" } } api response body parameter parameter data type description journeyid string journey id journeyurl string url of the joureny createdat number the timestamp of when the journey link was created ttl string link validity upto error code and response mapping 400 (bad request) { "error" { "name" "error", "message" "bad input and description ", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 401(unauthorized) { "error" { "name" "error", "message" "invalid authentication credentials", "status" 401, "reason" "authentication error", "type" "bad request", "statuscode" 401 } } 403 (forbidden) { "error" { "name" "error", "message" "forbidden", "reason" "error", "type" "bad request", "statuscode" "403" } } 500 (internal server error) { "error" { "name" "error", "message" "internal server error", "status" 500, "reason" "error", "type" "bad request", "statuscode" 500 } } 409(upstream down { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "bad request", "statuscode" 409 } } field type description name string text displayed on the screen explaining error type reason string reason for the error status number http status code message string error message indicating an upstream error type string error type statuscode number status code representing the error scenario 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 we strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively we value your feedback and are committed to making your experience smooth and enjoyable our team is dedicated to assisting you with any needs you may have thank you for choosing our services we look forward to helping you!