Verifying Customer Registration Information

Function

This API is used to check whether the account name, and mobile number or email address entered by the customer can be used for registration.

Constraints

This API can only be invoked using the AK/SK or token of a cloud solution provider or a Huawei Cloud distributor.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

POST /v2/partners/sub-customers/users/check-identity

Request

Request parameters

Parameter	Mandatory	Type	Description
search_type	Yes	String	Definition: Verification type. Constraints: N/A Range: email: indicates search by email address. mobile: indicates search by mobile number. name: indicates search by login name. Default Value: N/A
search_value	Yes	String	Definition: Verification content. The value can be a mobile number, email address, or login name. Constraints: The mobile number must comply with the regular expression "^\d{4}-\d+$". The value contains the country code and starts with 00. The format is "00XX-XXXXXXXX". The email address must consist of an email prefix and an email domain, as well as the (@) symbol. name: The value must comply with the regular expression "^([a-zA-Z-]([a-zA-Z0-9_-]){4,31})$" and contains 5 to 32 characters. The value cannot start with op_ or shadow_ and cannot contain only digits. It must start with a letter (case-insensitive) or a hyphen (-). Range: A maximum of 64 characters Default Value: N/A

Parameter

Mandatory

Type

Description

search_type

Yes

String

Definition:

Verification type.

Constraints:

N/A

Range:

email: indicates search by email address.
mobile: indicates search by mobile number.
name: indicates search by login name.

Default Value:

N/A

search_value

Yes

String

Definition:

Verification content. The value can be a mobile number, email address, or login name.

Constraints:

The mobile number must comply with the regular expression "^\d{4}-\d+$". The value contains the country code and starts with 00. The format is "00XX-XXXXXXXX".
The email address must consist of an email prefix and an email domain, as well as the (@) symbol.
name: The value must comply with the regular expression "^([a-zA-Z-]([a-zA-Z0-9_-]){4,31})$" and contains 5 to 32 characters. The value cannot start with op_ or shadow_ and cannot contain only digits. It must start with a letter (case-insensitive) or a hyphen (-).

Range:

A maximum of 64 characters

Default Value:

N/A

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/users/check-identity HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
  "search_type": "name", 
  "search_value": "ceshiyonghu001"
}

Response

Response Parameters

Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Returned Values. Range: A maximum of 16 characters
error_msg	String	Definition: Error description. Range: A maximum of 1024 characters
check_result	String	Definition: Verification result. Range: available: The account name, mobile number, or email address is valid. used_by_user: The account name, mobile number, or email address is in use.
mobile_remain_available_num	Integer	Definition: Number of remaining customers who can be registered using the mobile number. This field is returned only when search_type is set to mobile. It indicates that how many more customers can be registered with this mobile number.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "error_code": "CBC.0000",
    "error_msg": "success",
    "check_result": "available",
    "mobile_remain_available_num": 1
}

Returned Values

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.