Create Journey Link
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.
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.
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").
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.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 |
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 |
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 [email protected]. 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!