# Alibaba Cloud Phone Number Verification Service API

> Alibaba Cloud Phone Number Verification Service API on Apizie: 19 endpoints (Verifies an SMS verification code and returns the verification result, Creates a unified authentication scheme and retrieves the scheme code. A unified authentication scheme…, A verification scheme identifies authentication scenarios for an application (App). Each scheme typically…, If you no longer need a verification scheme, you can call this operation or delete the scheme in the Phone…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-dypnsapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dypnsapi`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dypnsapi
- Page: https://apizie.tech/api/cloud/aliyun-dypnsapi
- OpenAPI: https://apizie.tech/api/cloud/aliyun-dypnsapi/openapi.json

Alibaba Cloud OpenAPI for Phone Number Verification Service (dypnsapi, version 2017-05-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Verifies an SMS verification code and returns the verification result
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/check-sms-verify-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeName | string | no | The scheme name. If this parameter is not specified, the value defaults to "Default Scheme". The value can be up to 20 characters in… |
| CountryCode | string | no | The country code of the phone number. Default value: 86 |
| PhoneNumber | string | yes | The phone number |
| OutId | string | no | The external serial number |
| VerifyCode | string | yes | The verification code. The TemplateParam field of the SendSmsVerifyCode operation can be configured in two ways: -… |
| CaseAuthPolicy | integer | no | The case sensitivity policy for verification code validation. Valid values: 1: case-insensitive. 2: case-sensitive |

### Creates a unified authentication scheme and retrieves the scheme code. A unified authentication scheme…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/create-scheme-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeName | string | yes | The scheme name. The name can contain only Chinese and English letters and must be up to 10 characters in length |
| Platform | string | yes | The platform to which the scheme applies |
| AppName | string | no | The name of the app for the scheme. The name can contain only Chinese and English letters and must be up to 20 characters in length |
| AndroidPackageName | string | no | The package name. This parameter is required when Platform is set to Android. The package name can contain digits, letters, hyphens (-),… |
| AndroidPackageSign | string | no | The package signature. This parameter is required when Platform is set to Android. The signature can contain digits and letters and must… |
| IosBundleId | string | no | The bundle ID. This parameter is required when osType is set to iOS. The bundle ID can contain digits, letters, hyphens (-), underscores… |
| H5Url | string | no | Reserved. H5 schemes are not supported |
| H5Origin | string | no | Reserved. H5 schemes are not supported |

### A verification scheme identifies authentication scenarios for an application (App). Each scheme typically…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/create-verify-scheme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeName | string | yes | Scheme name |
| AppName | string | yes | App name |
| OsType | string | yes | Operating system type of the client. Valid values: iOS Android Harmony Web |
| PackName | string | no | Package name. Required when OsType is Android. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128… |
| PackSign | string | no | Package signature. Required when OsType is Android. Must contain only digits and letters. Length: 32 characters |
| BundleId | string | no | Bundle ID. Required when OsType is iOS. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128 characters |
| Origin | string | no | Source URL of the H5 scheme page. We recommend specifying the domain level |
| Url | string | no | Page URL used by the H5 scheme |
| IpWhiteList | string | no | IP address whitelist. Optional |
| CmApiCode | integer | no | China Mobile channel code. Optional |
| CuApiCode | integer | no | China Unicom channel code. Optional |
| CtApiCode | integer | no | China Telecom channel code. Optional |
| SceneType | string | no | Scheme type. Optional |
| Email | string | no | Email address to receive the key. Optional |
| AuthType | string | no | Authentication type. Optional. Select multiple values only if number authentication is supported. Separate multiple values with commas. 1:… |
| SmsSignName | string | no | Bound text message signature. Valid only if AuthType includes 2 (text message authentication). The signature must be approved and created… |
| HmPackageName | string | no | Package name. Required when OsType is `Harmony`. Must contain only digits, letters, underscores, or periods. Must start with a letter.… |
| HmSignName | string | no | Package signature. Required when OsType is `Harmony`. Must contain only digits and letters. Length: 64 characters |
| HmAppIdentifier | string | no | App ID. Required when OsType is `Harmony`. Length: 19 digits |

### If you no longer need a verification scheme, you can call this operation or delete the scheme in the Phone…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/delete-verify-scheme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeCode | string | yes | The scheme code. Get this value from the `SchemeCode` parameter in the response of the [CreateVerifyScheme](~~CreateVerifyScheme~~)… |
| CustomerId | integer | no | The user ID |

### Queries the details of a verification service
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/describe-verify-scheme` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeCode | string | yes | The service code |
| CustomerId | integer | no | The user ID |

### Obtain an authorization token for H5 native number verification. The response includes an AccessToken and a…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| Url | string | yes | URL of the request page. Enter the URL you specified when creating the authentication plan in the console. Format: protocol + // + domain… |
| Origin | string | yes | Origin URL. Enter the origin URL you specified when creating the authentication plan in the console. Format: protocol + // + domain name |
| SceneCode | string | no | Authentication plan code. This parameter is required due to plan upgrades. After creating an authentication plan in the console, pass its… |
| Version | string | no | The Version |
| BizType | integer | no | Business type. Valid values: 0: Native number verification. 1: One-click logon. This parameter is required due to flow optimizations that… |
| CmApiCode | integer | no | The CmApiCode |
| CuApiCode | integer | no | The CuApiCode |
| CtApiCode | integer | no | The CtApiCode |

### This operation is offline
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-authorization-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| PhoneNo | string | yes | The phone number |
| SchemeId | integer | yes | The authorization scenario ID. You can view the authorization scenario ID on the Authorization Scenarios page in the Phone Number… |
| EndDate | string | no | The authorization end date. This field is required for contract-based plans. Format: yyyy-MM-dd |

### After the fusion authentication client completes initialization, you can call this API from your server to…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-fusion-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeCode | string | yes | The scheme code |
| PackageName | string | no | Required when Platform is Android. The app package name |
| PackageSign | string | no | Required when Platform is Android. The app package signature |
| BundleId | string | no | Required when Platform is iOS. The app bundle ID |
| Platform | string | yes | The platform. Valid values: Android or iOS |
| DurationSeconds | integer | yes | The validity period of the token, in seconds. Minimum value: 900. Maximum value: 43200 |

### This API retrieves a mobile phone number using the one-click login feature of the Phone Number Verification…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-mobile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| AccessToken | string | yes | Login token obtained from the app-side SDK. Token validity period and usage limits: China Telecom: 10 minutes, usable once. China Unicom:… |
| OutId | string | no | External transaction ID |

### Obtains a phone number for one-click logon. This operation is exclusive to HTML5 pages
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-phone-with-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SpToken | string | yes | The token for phone number verification that is obtained by the JavaScript SDK. The validity period of the token is 10 minutes for China… |

### This operation is offline
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/get-sms-auth-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| PackageName | string | no | Package name. Required when OsType is Android |
| SignName | string | no | Signature. Required when OsType is Android |
| SceneCode | string | yes | Authentication flow ID |
| OsType | string | yes | Operating system type. Valid values: Android or iOS |
| BundleId | string | no | iOS bundle ID. Required when OsType is iOS |
| Expire | integer | yes | Token time-to-live (TTL), in seconds. Minimum value: 900. Maximum value: 43200 |
| SmsTemplateCode | string | yes | SMS template code |
| SmsCodeExpire | integer | no | SMS verification code TTL, in seconds. Default value: 180 |

### You can call this API to query monthly billing details for a specific authentication method
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/query-gate-verify-billing-public` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| Month | string | yes | The monthly bill. Format is YYYYMM, such as 202111 |
| AuthenticationType | integer | yes | The authentication method. Values: 0: Native number verification. 1: One-click logon. 2: All. 3: Liveness verification. 4: Text message… |

### Queries the calls of Phone Number Verification Service
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/query-gate-verify-statistic-public` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SceneCode | string | no | The service code |
| StartDate | string | yes | The start date. Specify this parameter in the YYYYMMDD format. Example: 20220101 |
| EndDate | string | yes | The end date. Specify this parameter in the YYYYMMDD format. Example: 20220106 |
| AuthenticationType | integer | yes | The verification method. Valid values: 1: one-click logon 2: phone number verification, including the verification of the phone number… |
| OsType | string | no | The type of the operating system. Valid values: Android iOS |

### Sends an SMS verification code
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/send-sms-verify-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SchemeName | string | no | The scheme name. If this parameter is not specified, the value defaults to "Default Scheme". The value can be up to 20 characters in length |
| CountryCode | string | no | The country code of the phone number. Default value: 86. Currently, only Chinese mainland phone numbers are supported |
| PhoneNumber | string | yes | The phone number of the SMS recipient |
| SignName | string | yes | The signature name. Custom signatures are not supported. Use the system-provided signatures. You can select the signature to use on the… |
| TemplateCode | string | yes | The SMS template code. When the SignName parameter is set to a system-provided signature, you must use a system-provided template to send… |
| TemplateParam | string | yes | The SMS template parameters. There are two ways to pass the verification code value: Use "##code##" as a placeholder, and the CodeType… |
| SmsUpExtendCode | string | no | The uplink SMS extension code. Uplink SMS messages are messages sent to a telecommunications service provider to subscribe to a service,… |
| OutId | string | no | The external serial number |
| CodeLength | integer | no | The length of the verification code. Valid values: 4 to 8. Default value: 4 |
| ValidTime | integer | no | The validity period of the verification code. Unit: seconds. Default value: 300 |
| DuplicatePolicy | integer | no | The verification rule that specifies how to handle old verification codes when a new verification code is sent to the same phone number… |
| Interval | integer | no | The minimum interval between two consecutive verification code deliveries to the same phone number. Unit: seconds. This parameter is used… |
| CodeType | integer | no | The type of the generated verification code. This parameter is required when the TemplateParam parameter contains a placeholder. The… |
| ReturnVerifyCode | string | no | Specifies whether to return the verification code. Valid values: true: Returned. false: Not returned |
| AutoRetry | integer | no | Specifies whether to enable automatic signature replacement and retry (enabled by default). Valid values: 1: Enables automatic retry. When… |

### Call this operation to verify the phone number of the current device. It returns the verification result
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/verify-mobile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| AccessCode | string | yes | Token validity and usage limits: China Telecom: valid for 10 minutes. Use once only. China Unicom: valid for 30 minutes. Use once only.… |
| PhoneNumber | string | yes | The phone number to verify |
| OutId | string | no | The external sequence number |

### Call this API to verify phone numbers on H5 pages and retrieve the verification result when the operation…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/verify-phone-with-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| PhoneNumber | string | yes | The phone number to verify |
| SpToken | string | yes | The phone number verification token obtained from the JSSDK. The validity period and usage count of the token vary by carrier: China… |

### This API operation is unpublished
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/verify-sms-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| SmsCode | string | yes | The verification code |
| PhoneNumber | string | yes | The mobile phone number. This is returned when you obtain the text message verification code |
| SmsToken | string | yes | The text message token. When you call the operation to send a verification code using the text message verification software development… |

### Obtains the verification results by using the verification token that is obtained by using the…
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/verify-with-fusion-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |
| VerifyToken | string | yes | The unified verification token that is returned by the client SDKs |

### version
`POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dypnsapi.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-dypnsapi/check-sms-verify-code" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Phone Number Verification Service API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-dypnsapi/check-sms-verify-code with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Phone Number Verification Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Phone Number Verification Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Phone Number Verification Service API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dypnsapi.

### What is the status of the Alibaba Cloud Phone Number Verification Service API?
Needs your own provider key (bring your own key)