string [Optional] The target URL to notify the caller after the H5 Identity Verification result is all completed (include Id forgery result).Max Length 2048 characters. Refer to Callback Notification
bizId
string The unique business id to identify the business transaction that triggered this Identity Verification processing, such as order id.
userId
string The unique userId to identify the user who is performing the Verification.
region
string The region of the service support, typically aligned with the address's residence. Refer to ISO ALPHA-3 Country Code
bizCode
string [Optional] The business type of the user. max size of the length is 32. only support characters a-zA-z0-9
proofFileBase64
string The proof file bytes encoded by Base64. Please provide either proofFileBase64 or proofFileUrl.
proofFileUrl
string The proof file url. Should not expire in 1 hour. Max Length 2048 characters.
Please provide either proofFileBase64 or proofFileUrl.
proofFileBase64s
array An array of Base64-encoded images. Supports JPG/PNG/JPEG/WEBP formats, with a maximum of 5 images,and the total size of all images must not exceed 30MB.This field is mutually exclusive with the single-image fields (proofFileBase64 / proofFileUrl); passing them simultaneously will return an PARAMETER_ERROR error. This field can be passed together with proofFileUrls. If both are provided, proofFileBase64s takes precedence. If this field is empty or null, the system will fall back to proofFileUrls.
proofFileUrls
array An array of image URLs. The backend will download the images sequentially. Supports JPG/PNG/JPEG/WEBP formats, with a maximum of 5 images,and the total size of all images must not exceed 30MB. This field is mutually exclusive with the single-image fields (proofFileBase64 / proofFileUrl); passing them simultaneously will return an PARAMETER_ERROR error. If proofFileBase64s is also provided, it will take precedence, and this field will be ignored.
issueDate
string [Optional] The issue date of the proof, in the format of "yyyy-MM-dd", iles are valid for the last 3 months by default.
firstName
string [Optional] the first name.
middleName
string [Optional] the middle name.
lastName
string [Optional] the last name.
fullName
string [Optional] the full name.
Response Description
Parameter
Description
code
Response Code.
transactionId
The request id of this API call, the max length is 64.
pricingStrategy
Deprecated Always return FREE
message
Status Code Explanation
data
signatureId, the business id of this verification, need to be used in get-result API later.
Response Code
Status Code
Message
SUCCESS
OK
PARAMETER_ERROR
Parameter error, please check you input.
Parameter should not be empty
Region is wrong
Invalid issueDate format. Expected yyyy-MM-dd
No image found
Invalid image format, image format should be one of jpeg/jpg/png/pdf
Invalid image size, max image size should be less than 16M
{
"code":"PARAMETER_ERROR",
"message":"Parameter should not be empty",
"data":null,
"extra":null,
"transactionId":"dfcdc346a81f404f",
"pricingStrategy":"FREE"
}
