Skip to main content

kyc verify

is used to create a verify link

Request address

  • API Address (requestURI) : /openapi/v1/kyc/verify

Request parameters

Parameter nameTypeRequirementDescription
uidStringRUnique user ID
idTypeIntegerRID type to be verified: 1 for ID card, 2 for driving license, 3 for passport
countryStringOCountry to which the user belongs. If not provided, the user needs to select the country on a third-party link
languageStringOLanguage corresponding to the user's country. Defaults to English if not provided
redirectUrlStringRRedirect URL

Sample request

{
"country": "CN",
"idType": 1,
"language": "zh-HK",
"redirectUrl": "http://47.239.118.204/",
"uid": "11223344556677"
}

Response parameters

Parameter nameTypeRequirementDescription
referenceStringOPlain text serial number
ciphertextStringOEncrypted serial number
eventStringOEvent type
verificationUrlStringOThird-party authentication address
emailStringOEmail
countryStringOCountry

Sample response

{
"code": "0",
"msg": "ok",
"data": {
"reference": "G000000006FRL20241212000000125871072151",
"ciphertext": "l3hsr2ajd%2B/6r/OzKBaDg7Yfks%2BEJk0yQnS4tMY2XZA1Ch55Lwo1gvFv2SX3g7fx",
"event": "request.pending",
"verificationUrl": "https://sg-production-cdn.zoloz.com/page/zoloz-realid-fe/index.html?clientcfg=eyJzaWduIjoidXlPTXJRN3N2K3BZdHBSYWJOSE9qajVOVi9ITUhlTjNPSDhBdFhoNzN6aVQ2MEttbzlUZVJURzlvbERRRVlhY3pnbEY4SUZHaG96eERIYjJCelpUQ0YvdldXazE5Ti80TFhTQUM1dUsvTW9NTDZsWmR4Qm9jVHBvUkcyckpMRXVXYjJJWHF4ajBFU2JaRDAvZ08wVkFGSi9rWnZBbERxeHJKb3hrZEoxbStGQ0dEYmpHTzlDL1hxZWwvR3dtUE9HU2swN3lYNEQ3ZDRMZGhGWC9rVFdYcGhXajNWQ2lVeHRCMXZ2YlpBRWw2cnJBMzRzemx3aEFNalZ1M2lYWmFQQ21oWWd0UXNubXlmTkhkcUNtbnlzYXNxUnE0UW1KWDJURG83VitEOXRhWUwvK292Si9wVFRSbUJHWDlMZWhRZlNjT3c3cDBzMG5xWFZrZHk3LzBJd0ZRPT0iLCJjb250ZW50Ijoie1wiR0FURVdBWV9VUkxcIjpcImh0dHBzOi8vaGstcHJvZHVjdGlvbi16bWdzLnpvbG96Lm5ldC96bWdzL3YyL3NlY1wiLFwiQVBQX0lEXCI6XCJcIixcImtleU1ldGFcIjpcIntcXFwicmVzb3VyY2VDb2RlXFxcIjpcXFwiMDAwMDAwMDBcXFwiLFxcXCJtaWRcXFwiOlxcXCIzMDIzOFxcXCIsXFxcImtleVZlclxcXCI6XFxcInYxXFxcIn1cIixcInZlcnNpb25Ub2tlblwiOlwiMjAyNDEyMTIxMzM2Mzg3MDQ0NzY2NTU3XCIsXCJsb2NhbGVcIjpcInpoLUhLXCIsXCJoNURlZ3JhZGFibGVcIjpcIk5cIixcImludGVycnVwdENhbGxiYWNrVXJsXCI6XCJodHRwczovL3Rlc3QubWMtcGF5bWVudC5jb20vbWMtY3JtL29wZW5hcGkvdjEva3ljL3RoaXJkL3pvbG96L2NhbGxiYWNrXCIsXCJmYWNlR3VpZGVVcmxcIjpcImh0dHBzOi8vaGstcHJvZHVjdGlvbi1jZG4uem9sb3oubmV0L3BhZ2UvZmFjZS1ndWlkZS1mZS9pbmRleC5odG1sP2xvY2FsZT16aC1IS1wiLFwiV09SS1NQQUNFX0lEXCI6XCJcIixcInN0YXRlXCI6XCJHMDAwMDAwMDA2RlJMMjAyNDEyMTIwMDAwMDAxMjU4NzEwNzIxNTFcIixcImNvbXBsZXRlQ2FsbGJhY2tVcmxcIjpcImh0dHBzOi8vdGVzdC5tYy1wYXltZW50LmNvbS9tYy1jcm0vb3BlbmFwaS92MS9reWMvdGhpcmQvem9sb3ovY2FsbGJhY2tcIixcImF1dGhUeXBlXCI6XCJSRUFMSURcIixcImZsb3dJZFwiOlwiRjIwMjQxMjEyMDAwMDAwMTI1ODcxMTAwNjY5XCIsXCJDMlNfUFVCX0tFWVwiOlwiTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF2Q0Vha2FqUU1zR3QrMm1NeStuZ1c1S25HandDOGtFQnRlM1ppYkNMbDlmRktyOFppejZBRXFnU1gxQXJ1ZGlLNnpGRUptQWFFK0NxMWI4R3p5aFRNbXVyUG5tZG4wQ3ZVQmNjdGxyYmhJTGE5UEd5UVIzTnc2RUl1cGVwS1dFdFkvU3NYV0RINFcrUmlINXUyYzI2MHkzWWVYMkdzWXFXR3NkQ1pFRzV6dU1rd01YaDhqck41aXU1WmRxenJyMG9xYjd3aGFocVFVVWtVUTV2aVVNS1V6UitnYXBLTGo0MTlWcXN2ZjhReTZQUzYxcnc5UEhDZGFBV0pNcGlvYng0b014aEtoREsyRElzQ0RoS2R3WmkrRHRXUFJ5akp6dW5qSVB3TUJOVmY5QXA0SXRXZzUzYjRzZGNGd256K0c4NjhONFphcjNQS3N3RmNjS2prdWtrb1FJREFRQUJcIixcIlJFTU9URUxPR19VUkxcIjpcImh0dHBzOi8vaGstcHJvZHVjdGlvbi16bWdzLnpvbG96Lm5ldC9sb2dndy9sb2dVcGxvYWQuZG9cIixcImZsb3dUeXBlXCI6XCJINV9SRUFMSURMSVRFX0tZQ1wifSJ9",
"email": null,
"country": null
},
"success": true
}