Help Center/ Partner Center/ API Reference/
Updated on 2023-04-19 GMT+08:00
View PDF
Share
Synchronizing Customer Real-Name Authentication Information

Synchronizing Customer Real-Name Authentication Information

Function

This API will become unavailable soon. To perform real-name authentication, see Requesting an Individual Real-Name Authentication, Requesting an Enterprise Real-Name Authentication, Requesting a Real-Name Authentication Change, and Querying the Real-Name Authentication Review Result.

After a customer performs real-name authentication on the partner sales platform, the real-name authentication information will be synchronized to HUAWEI CLOUD, and the customer already passes the real-name authentication on HUAWEI CLOUD.

Note:

  • The real-name authentication data synchronized from the partner sales platform to HUAWEI CLOUD platform must be valid. Otherwise, the API will be forbidden to invoke.
  • The real-name authentication information of a customer can be synchronized to HUAWEI CLOUD only after the customer's partner sales platform account is associated with its HUAWEI CLOUD account.
  • This API can be invoked only by the partner AK/SK or token.

URI

PUT /v1.0/{partner_id}/partner/customer-mgr/verified-info

The following table describes the parameters.

Parameter

Mandatory

Value Range

Description

partner_id

Yes

A maximum of 64 characters

Partner ID (assigned by Huawei).

For details about how to obtain the partner ID, see How Do I Check the Partner ID?

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

xaccountType

Yes

String

A maximum of 64 characters

Platform ID assigned by Huawei to a partner.

This value is assigned by Huawei. For details about how to obtain the platform ID, see How Do I Obtain the xaccountType Value?

xaccountId

Yes

String

A maximum of 64 characters

Unique user ID on the partner sales platform. The ID is allocated by the partner.

domainId

Yes

String

A maximum of 64 characters

Domain ID allocated to the customer by HUAWEI CLOUD carried in the notification message sent by HUAWEI CLOUD.

verifiedType

Yes

Integer

0 or 1

Third-party real-name authentication type. The options are as follows:

  • 0: Individual authentication.
  • 1: Enterprise authentication.

The value must be the same as that in the SAML assertion request sent during account synchronization. HUAWEI CLOUD will verify the value.

verifiedStatus

Yes

Integer

Fixed at 2

The value is fixed at 2.

2: The real name is authenticated.

name

Yes

String

A maximum of 256 characters

Name to be authenticated.

  • For individuals, the value is the individual's name.
  • For enterprises, the value is the company name.

The value cannot contain only special characters, digits, or spaces.

NOTICE:

Ensure that the name is real.

identifyType

Yes

Integer

[1-11]

Credential type. The options are as follows:

  • 1: Second-generation ID card
  • 2: Passport
  • 3: Business license
  • 4: First-generation ID card
  • 5: Temporary ID card
  • 11: Organization structure code

The value of this parameter varies according to the value of verifiedType.

  • When verifiedType is set to 0, the value can be: 1, 2, 4, 5.
  • When verifiedType is set to 1, the value can be 3 or 11.

verifiedNumber

Yes

String

A maximum of 32 characters

Credential number.

  • For a personal credential, the verification rule is as follows: ^[0-9a-zA-Z]{1,32}$
  • For an enterprise credential, the verification rule is as follows: Excluding [^!@#$%^&*<\\>]+

Example Request

PUT https://bss-intl.myhuaweicloud.com/v1.0/{partner_id}/partner/customer-mgr/verified-info HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
  "xaccountType":"xxx",
  "xaccountId":"xxxxxxxxxxx",
  "domainId":"e97ec022f3af448596765475941deb60",
  "verifiedType":"1",
  "verifiedStatus":"2",
  "name": "Huawei Cloud",
  "identifyType":"3",
  "verifiedNumber":"432100000001234"
}

Response

Response Parameters

Parameter

Type

Value Range

Description

error_code

String

16 characters

Error code. For details, see Returned Values.

error_msg

String

1024 characters

Error description.

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"
}

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.

HTTP Status Code

Error Code

Description

200

CBC.0000

Success.

400

CBC.0100

Invalid parameter.

500

CBC.0999

Other errors.

403

CBC.0151

Access denied.

500

CBC.5002

The customer does not exist.

200

CBC.5005

The customer is being authenticated by HUAWEI CLOUD.

200

CBC.5006

The customer type (individual/enterprise) is different from the customer type stored in the system.

500

CBC.5035

Sandbox accounts cannot access this interface.