User Registration

Introduction

This api is used to summit user registration.

API Description

Request Method: POST

Request Path: /open/api/user/core/register

Request Parameters:

Parameter NameRequiredTypeDescriptionLengthExample
merchantNoYesstringMerchant number64NFT0001
subMerchantNoNostringSub-merchant number64a01a123
businessSubcategoriesNostringBusiness subcategories32BUY
emailYesstringEmail64test@email.com
kycPlatformYesstringKYC platform255KYC platform onfido or sumsub
kycTypeYesstringKYC type2551
redirectUrlNostringRedirect URL after KYC success255https://your-redirect-url
callbackUrlYesstringCallback URL after KYC success255https://your-callback-url
remarkNostringRemark255test

Request Parameter Example

{ "merchantNo": "NFT0001", "subMerchantNo": "a01a123", "businessSubcategories": "BUY", "email": "test@email.com", "kycType": "1", "kycPlatform": "sumsub", "redirectUrl": "https\://your-redirect-url", "callbackUrl": "https\://your-callback-url", "remark": "9999" }

Response Parameters

Parameter NameRequiredTypeDescriptionExample
codeYesintegerReturn code0
msgYesstringReturn messageUser registered
modelYesstringKYC linkhttps://dev-user.alchemytech.cc?token=37aa507d116c4cc49ac32c4bd3458f2b
traceIdYesstringtraceId64e316f0cf1c6c4ac44c881c051f51f8
errorYesbooleanFailure indicatorfalse
successYesbooleanSuccess indicatortrue

Response Parameter Example

User not registered

{ "code": "0", "msg": "Success", "model": "https://dev-user.alchemytech.cc?token=37aa507d116c4cc49ac32c4bd3458f2b", "traceId": "64e316f0cf1c6c4ac44c881c051f51f8", "error": false, "success": true }

User already registered

{ "code": "2002", "msg": "User registered", "model": null, "traceId": "64e462f03cb28e341b6973070be1e22b", "success": false, "error": true }

Did this page help you?