Phone KYC - Create Consent Link

Introduction

The Create Consent Link API initiates Customer Consent for Phone KYC by generating a unique Authentication Link. Users of this API can create consent requests on behalf of customers by submitting mailing addresses and/or mobile numbers. A notification containing a unique link will be sent to the provided contact details.

Upon successful completion of customer verification, the Phone KYC report will be sent to the user's provided callback URL.

Key Features

Customer Consent Initiation: Users can initiate Customer Consent for Phone KYC by generating a unique Authentication Link.
Notification: Notifications are sent to provided contact details along with the unique link for consent initiation.
Callback URL: Phone KYC reports are sent to the user's provided callback URL upon successful completion of customer verification.

Authorization

Authorization Token: Users require an authorization token generated by Signzy to use this API. Please contact [email protected] for acquiring this token.

Conclusion

In summary, the Create Consent Link API simplifies the initiation of Customer Consent for Phone KYC by providing a unique Authentication Link. It streamlines the process of customer verification and ensures the secure transmission of Phone KYC reports to the user's provided callback URL.

cURL

curl --location 'https://api.signzy.app/api/v3/underwriting/create-phone-kyc-consent' \
--header 'Authorization: <Auth Token>' \
--header 'Content-Type: application/json' \
--data '{
    "requestData": "<Encrypted Payload>"
}'

Request Headers

Key	Value
Authorization	shared by Signzy
Content-type	application/json

Request Body

{
    "requestData": "eI+hI1MO+Zkwqt8w6BeHmr4EkK8+mHvj0eNEmJHygQCuNSvRSY6I7TgwImTAM44C1T7iAk6E8BvZC6i4W1SHEpGSTzkxx/YHUwPvCjNUc38orWzxOHJkAS/c+S9tRJAo7sF57pwRE3JcJz+rkqg3CmwrR0scMOx7f+GccDcr6drOJjkgvy/k72qjn62aiyOZhBcuNtrp9J/CwUpOPiYjPJLytbpjhbsQ/9fYmZ27kYx1W0JO5eMSCCEb1zEDlZUgvK+svcQIBTcnGLt3dWVHIvfYDeaxkDvK59eepvHgXpMTtmcrmIHYnqukfIJ+282wrLMV+LqVekn4185MNsDSQSL0FWitX/2fLvdEecDUmkw=:zpF0ZBilAYHdVEQ02rJOZQ=="
}

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestData	AES-256 bit encrypted string containing the request payload	String	COMPULSORY

Response Body

{
    "responseData": "2TpPddgMePqQrhVoPZxnsk0Q+fNQ1QGb+ukMColhhiL6G5SI/Rrts04mKKzN4/j5C55+VDR7eJyZeaxPleUUD6QlXF3l8torxGCigwP0MzPeInhfBifb4LZ73FoVKJfeBn3k3auWIy0JocN05DbNwlr/Io56Ro3YYs/5Sf/h6IGah3yqlm2Sp8JlZ4qPhHx0eWwFDh9CHRyOwbYFpUtgWg==:qaV3AK8ICFWw03+WBv/50A=="
}

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
responseData	AES-256 bit encrypted string containing the request response	Object	COMPULSORY

NOTE: Signzy will share the Encryption key to be used for encrypting the actual request data, and decrypting the response data.

Request Data (Decrypted)

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
mobileNumber	10 digit mobile number for which Phone KYC need to be initiated	String	COMPULSORY
countryCode	Valid country code for the mobile number without any special character	String	COMPULSORY
requestId	A valid uuid to be shared by the user	String	COMPULSORY
email	Email of the customer to be notified with KYC link	String	OPTIONAL
notifications	Possible notification options: "email", "sms", "email and sms"	String	OPTIONAL
callbackUrl	A valid url in which status of the consent to be posted	String	COMPULSORY
successPage	Whether to display success page or not after customer successfully gives their consent. NOTE: This needs to be set as true	Boolean	COMPULSORY
expiryTime	When to expire the consent link - format: HH:MM:SS, e.g. 14:00:00 would indicate all the links that was created prior to 2pm today will be expired at that time, however if a link is after 2 pm today it would be expired at 2 pm the next day. Default expiry time is set at 9 am.	String	OPTIONAL

Response Data (Decrypted)

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
result	Result object containing the following field	Object	COMPULSORY
referenceId	A valid uuid generated by Signzy for the consent request which also serves as unique identifier for the consent link	String	COMPULSORY
requestId	A valid uuid that was shared by the user while making the request	String	COMPULSORY
emailStatus	Provides info if email was successfully sent or not	String	OPTIONAL
smsStatus	Provides info if sms was successfully sent or not	String	OPTIONAL

Callback Data (Decrypted)

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
referenceId	A valid uuid generated by Signzy for the consent request which also serves as unique identifier for the consent link	String	COMPULSORY
requestId	A valid uuid that was shared by the user while making the request	String	COMPULSORY
type	Denotes if the consent was successful or not	String	COMPULSORY
statusCode	Denoting the status of the user journey	String	COMPULSORY
message	Provides description of the status	String	COMPULSORY
userConsent	An object containing the details of the user's consent	Object	COMPULSORY
consentObject	Consent message shared with the customer	String	OPTIONAL
timeStamp	Timestamp in milliseconds when the consent link was opened by the customer	String	OPTIONAL
result	Details of the Phone KYC data to be included during successful completion of consent	Object	OPTIONAL

Status Codes

STATUS CODE	MESSAGE	DESCRIPTION
0	Success	When the link expires, we will post status on the callbackURL
1001	Notification link expired, user generated OTP but did not validate OTP	When the link expires, we will post status on the callbackUrl or if the customer submit incorrect OTP 3 times then also the link will be expired, and the status will be posted immediately
1002	Notification link expired, user visited the verification page but did not generate OTP	When the link expires, we will post status on the callbackUrl in cases where customer didn't click Generate OTP
1003	User did not open auth link sent in sms/email notificaiton	When the link expires, we will post status on the callbackUrl in cases where customer didn't even open link and therefore haven't provided consent

Sample Status Codes And Messages

{
    "responseData": "2TpPddgMePqQrhVoPZxnsk0Q+fNQ1QGb+ukMColhhiL6G5SI/Rrts04mKKzN4/j5C55+VDR7eJyZeaxPleUUD6QlXF3l8torxGCigwP0MzPeInhfBifb4LZ73FoVKJfeBn3k3auWIy0JocN05DbNwlr/Io56Ro3YYs/5Sf/h6IGah3yqlm2Sp8JlZ4qPhHx0eWwFDh9CHRyOwbYFpUtgWg==:qaV3AK8ICFWw03+WBv/50A=="
}

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].