Help Center> Partner Center> API Reference> Customer Management> Real-Name Authentication> Requesting an Individual Real-Name Authentication
Updated on 2023-03-02 GMT+08:00

Requesting an Individual Real-Name Authentication

Function

This API can be used to submit an individual real-name authentication application.

An individual customer can refer to the instructions described in Overall Process to complete the real-name authentication.

Constraints

  • This API can be invoked only by the partner account's AK/SK or token.
  • To use this API, partners need to enable Upload Photos of Handheld ID Cards Required for Real-Name Authentication on the Benefits and Support > API Configuration > Configure page.
  • Images for real-name authentication must be uploaded to the download directory of the bucket.
  • Only individual certificate authentication can be performed using APIs.

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/customers/realname-auths/individual

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

customer_id

Yes

String

A maximum of 64 characters

Customer account ID. You can call the API in Querying Customers to obtain the customer ID.

identify_type

Yes

Integer

-

Authentication method.

0: Using the individual certificate

verified_file_url

Yes

List<String>

A maximum of 4 characters

  1. Attachment URL for individual certificate authentication. The URL must be entered in sequence.

    Assume that the name of the picture for the passport profile page is abc023 and that for the customer holding the passport profile page is def004.

    abc023

    def004

    Enter the URL in the preceding sequence. The file name is case sensitive.

  2. Currently, certificate attachments must be in .jpg, .jpeg, .bmp, .png, .gif, or .pdf format. The maximum size of a single file is 10 MB.
  3. The URL is a relative URL and does not need to contain the bucket name or download directory. It only needs to contain the subdirectory and corresponding file name in the download directory. Example:
    • If the uploaded attachments are stored in the following location of the bucket, enter abc023.jpg:

      https://bucketname.obs.Endpoint.myhuaweicloud.com/download/abc023.jpg

    • If the uploaded attachments are stored in the following location of the bucket, enter test/abc023.jpg:

      https://bucketname.obs.Endpoint.myhuaweicloud.com/download/test/abc023.jpg

name

Yes

String

A maximum of 255 characters

Name.

verified_number

Yes

String

A maximum of 32 characters

Certificate number.

xaccount_type

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?

verified_type

No

Integer

-

Certificate type.

3: Passport. Two attachments need to be uploaded: the picture of the profile page, and the picture of the customer holding the passport in hands (the profile page on the front side).

5: Exit-Entry Permit for Traveling to and from Hong Kong and Macao. Three attachments need to be uploaded: the picture of the front side of Exit-Entry Permit (profile page), the picture of the back side of Exit-Entry Permit, and the picture of the customer holding Exit-Entry Permit in hands (profile page on the front side).

6: Mainland Travel Permit for Taiwan Residents. Three attachments need to be uploaded: the picture of the front side of Mainland Travel Permit (profile page), the picture of the back side of Mainland Travel Permit, and the picture of the customer holding Mainland Travel Permit in hands (profile page on the front side).

9: Residence Permit for Hong Kong and Macao Residents. Three attachments need to be uploaded: the picture of the profile side of Residence Permit for Hong Kong and Macao Residents, the picture of the national emblem side of Residence Permit for Hong Kong and Macao Residents, and the picture of the customer holding Residence Permit for Hong Kong and Macao Residents in hands (profile side on the front side).

10: Residence Permit for Taiwan Residents. Three attachments need to be uploaded: the picture of the profile side of Residence Permit for Taiwan Residents, the picture of the national emblem side of Residence Permit for Taiwan Residents, and the picture of the customer holding Residence Permit for Taiwan Residents in hands (profile side on the front side).

This parameter needs to be specified only when identify_type is set to 0.

change_type

No

Integer

[-1]

Change type.

-1: First time real-name authentication

Example Request

POST  https://bss-intl.myhuaweicloud.com/v2/customers/realname-auths/individual HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "verified_number": "949826********2922",
    "verified_file_url": [
        "shimingrenzheng/zhengmian001.jpg",
        "shimingrenzheng/fanmian002.jpg"
    ],
    "name": "wangx_****_001",
    "change_type": -1,
    "customer_id": "068a6d********288536b6ba57d1ffae",
    "verified_type": 3,
    "identify_type": 0,
    "xaccount_type": "***_IDP"
}

Response

Response Parameters

Status code: 200

Parameter

Type

Value Range

Description

is_review

Integer

-

Whether to transfer to manual review. This parameter is returned only when the status code is 200.

  • 0: No
  • 1: Yes

Status code: 400

Parameter

Type

Value Range

Description

error_code

String

A maximum of 16 characters

Error code. For details, see Returned Values. This parameter is returned only when a failure occurs.

error_msg

String

A maximum of 1024 characters

Error description. This parameter is returned only when a failure occurs.

is_review

Integer

-

Whether to transfer to manual review. This parameter is returned only when the status code is 200.

  • 0: No
  • 1: Yes

fail_check_items

List<String>

-

Error list.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
  "is_review": "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.

HTTP Value

Error Code

Description

400

CBC.99000027

Expired verification code.

400

CBC.99000035

You are not a customer of a partner yet.

400

CBC.99005030

The partner did not complete real-name authentication or bucket authentication.

400

CBC.99007188

This customer has completed real-name authentication or is currently being authenticated.

400

CBC.99007189

The number of users who used the certificate ID for real-name authentication has reached the maximum limit.

400

CBC.99007191

The maximum number of real-name authentication times has been reached.

400

CBC.99007193

The certificate ID is from an invalid certificate and cannot be used for real-name authentication.

400

CBC.99007202

Real-name authentication failed.

400

CBC.99007261

The bank card is not supported. Try another bank card.

400

CBC.0100

Parameter error.

400

CBC.70600026

Huawei Cloud cannot review the information you submitted for real-name authentication. Contact your account manager.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.