Initialize - ID Verification - Alibaba Cloud Documentation Center

This topic describes how to use Initialize API to initialize the identity proofing process.

Interface description

Interface name: Initialize.

Service address: cloudauth-intl.cn-hongkong.aliyuncs.com.

Request method: HTTPS POST.

Interface description: Before each identity proofing process, obtain the transactionId through this interface to connect the interfaces in the identity proofing process request in series.

Request parameters

Parameter	Type	Required	Description
ProductCode	String	Yes	Product code of identity proofing. Set to FACE_VERIFY in this mode.
MerchantBizId	String	Yes	A unique business ID for tracing purpose. For example, the sequence ID from the merchant's business-related database. Note The Alibaba Cloud server does not perform uniqueness check on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID.
MetaInfo	String	Yes	The meta information about the SDK and the user's device. When App SDK mode is used, its value comes from the Alibaba Cloud SDK in the JSON string format, for example: `"{\"apdidToken\":\"69b74bfe-bf7f-4d3b-ac59-907ee09e7955\",\"appName\":\"com.alibabacloud.atomic.client\",\"appVersion\":\"1.0.9\",\"bioMetaInfo\":\"3.46.0:2916352,0\",\"deviceModel\":\"MI 6\",\"deviceType\":\"android\",\"osVersion\":\"9\",\"zimVer\":\"1.0.0\"}"` Note Do not modify the returned value as it only needs to be passed through directly.
MerchantUserId	String	Yes	Merchant user ID, or other identifiers that can be used to identify a specific user, for example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field, for example, by hashing the value.
FacePictureBase64	String	No	Photos Base64 encoded. Note When ProductCode is FACE_VERIFY,FacePictureBase64 or FacePictureUrl need to be set. If you choose FacePictureBase64 to transfer face photo, please pay attention to check the size of the photo, and do not import too large photo.
FacePictureUrl	String	No	The HTTPS or HTTP address of the face image. Note When ProductCode is FACE_VERIFY,FacePictureBase64 or FacePictureUrl need to be set.

Response parameters

Field name		Data type	Description
HTTP Status Code		Integer	The HTTP status code.
HTTP Body	RequestId	String	The unique ID of the request, which can be used to locate issues.
	Code	String	Return code. For the full list of codes, see Codes and Messages.
	Message	String	Response detailed message.
	Result.TransactionId	String	A unique transaction ID that is generated by the Alibaba Cloud server for the identity proofing process. This ID will be used as an input parameter for the ID Verification CheckResult API request. Note When an error occurs during the process, for example, invalid argument, no transaction ID is returned.

Codes and Messages

HTTP Status Code	Code	Message
200	Success	The request has succeeded.
400	MissingParameter	Bad request. The parameter is missing.
400	InvalidParameter	Bad request. The parameter is invalid.
403	Forbidden.RAMUserAccessDenied	Grant AliyunAntCloudAuthFullAccess permission to the RAM user. For more information, see Authorize a RAM user to access ID Verification.
403	Forbidden.AccountAccessDenied	The account is unauthorized, overdue, deactivated, or disabled.
403	Throttling.Api	Request was denied due to api flow control.
500	InternalError	The error message returned because a temporary server error occurs. We recommend that you try again. If the error code persists, submit a ticket.