Introduction

This API support KYC application for the user.

The user will be redirected to the card issuer’s URL returned by the API to complete the KYC process.

*Note: Merchant-side KYC on behalf of the user is not supported.

API Description

Request Method: POST

Request Path: open/api/kyc/userRegister

Request Parameters

Body Parameters:

Parameter	Required	Type	length	Description
redirectUrl	N	string	256	KYC success redirect url
callbackUrl	N	string	256	KYC success webhook url

Request Parameter Example:

{
   "redirectUrl":"https://card.alchemypay.org/web3auth",
   "callbackUrl":"https://card-api.alchemypay.org/kyc/callback"
}

Response Parameters

Body Parameters:

Parameter	Type	Description
success	boolean	success
error	boolean	error
code	long	return code
msg	string	return message
traceId	string	traceId
model	object	response entity

Model Entity Description

Parameter	Type	Description
linkUrl	string	kyc url, Validity period: 24 hours

Response Parameter Example:

{
    "code":"0",
    "msg":"SUCCESS",
    "model":{
        "linkUrl":"https://dev-card.alchemypay.org/web3auth/300317494606861619080"
    },
    "traceId":"665597457b9b37cb000187a035002030",
    "success":true,
    "error":false
}