@alicloud/cloudauth20190307 3.9.4 → 3.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +271 -10
- package/dist/client.js +393 -10
- package/dist/client.js.map +1 -1
- package/dist/models/ContrastFaceVerifyAdvanceRequest.d.ts +93 -0
- package/dist/models/ContrastFaceVerifyAdvanceRequest.js.map +1 -1
- package/dist/models/ContrastFaceVerifyRequest.d.ts +93 -0
- package/dist/models/ContrastFaceVerifyRequest.js.map +1 -1
- package/dist/models/ContrastFaceVerifyResponseBody.d.ts +32 -0
- package/dist/models/ContrastFaceVerifyResponseBody.js.map +1 -1
- package/dist/models/CreateAuthKeyRequest.d.ts +12 -0
- package/dist/models/CreateAuthKeyRequest.js.map +1 -1
- package/dist/models/CreateAuthKeyResponseBody.d.ts +6 -0
- package/dist/models/CreateAuthKeyResponseBody.js.map +1 -1
- package/dist/models/CreateVerifySettingRequest.d.ts +18 -0
- package/dist/models/CreateVerifySettingRequest.js.map +1 -1
- package/dist/models/CreateVerifySettingResponseBody.d.ts +20 -0
- package/dist/models/CreateVerifySettingResponseBody.js.map +1 -1
- package/dist/models/CredentialVerifyRequest.d.ts +132 -0
- package/dist/models/CredentialVerifyRequest.js.map +1 -1
- package/dist/models/CredentialVerifyResponseBody.d.ts +103 -0
- package/dist/models/CredentialVerifyResponseBody.js.map +1 -1
- package/dist/models/CredentialVerifyShrinkRequest.d.ts +116 -0
- package/dist/models/CredentialVerifyShrinkRequest.js.map +1 -1
- package/dist/models/DescribeCardVerifyRequest.d.ts +3 -0
- package/dist/models/DescribeCardVerifyRequest.js.map +1 -1
- package/dist/models/DescribeCardVerifyResponseBody.d.ts +52 -0
- package/dist/models/DescribeCardVerifyResponseBody.js.map +1 -1
- package/dist/models/DescribeDeviceInfoRequest.d.ts +21 -0
- package/dist/models/DescribeDeviceInfoRequest.js.map +1 -1
- package/dist/models/DescribeDeviceInfoResponseBody.d.ts +31 -0
- package/dist/models/DescribeDeviceInfoResponseBody.js.map +1 -1
- package/dist/models/DescribeFaceGuardRiskRequest.d.ts +14 -0
- package/dist/models/DescribeFaceGuardRiskRequest.js.map +1 -1
- package/dist/models/DescribeFaceGuardRiskResponseBody.d.ts +32 -1
- package/dist/models/DescribeFaceGuardRiskResponseBody.js.map +1 -1
- package/dist/models/DescribeFaceVerifyRequest.d.ts +9 -0
- package/dist/models/DescribeFaceVerifyRequest.js.map +1 -1
- package/dist/models/DescribeFaceVerifyResponseBody.d.ts +59 -0
- package/dist/models/DescribeFaceVerifyResponseBody.js.map +1 -1
- package/dist/models/DescribeOssUploadTokenResponseBody.d.ts +28 -0
- package/dist/models/DescribeOssUploadTokenResponseBody.js.map +1 -1
- package/dist/models/DescribePageFaceVerifyDataRequest.d.ts +18 -0
- package/dist/models/DescribePageFaceVerifyDataRequest.js.map +1 -1
- package/dist/models/DescribePageFaceVerifyDataResponseBody.d.ts +50 -0
- package/dist/models/DescribePageFaceVerifyDataResponseBody.js.map +1 -1
- package/dist/models/DescribeSmartStatisticsPageListRequest.d.ts +13 -0
- package/dist/models/DescribeSmartStatisticsPageListRequest.js.map +1 -1
- package/dist/models/DescribeSmartStatisticsPageListResponseBody.d.ts +44 -0
- package/dist/models/DescribeSmartStatisticsPageListResponseBody.js.map +1 -1
- package/dist/models/DescribeVerifyResultRequest.d.ts +4 -0
- package/dist/models/DescribeVerifyResultRequest.js.map +1 -1
- package/dist/models/DescribeVerifyResultResponseBody.d.ts +125 -0
- package/dist/models/DescribeVerifyResultResponseBody.js.map +1 -1
- package/dist/models/DescribeVerifySdkrequest.d.ts +2 -0
- package/dist/models/DescribeVerifySdkrequest.js.map +1 -1
- package/dist/models/DescribeVerifySdkresponseBody.d.ts +6 -0
- package/dist/models/DescribeVerifySdkresponseBody.js.map +1 -1
- package/dist/models/DescribeVerifyTokenRequest.d.ts +49 -0
- package/dist/models/DescribeVerifyTokenRequest.js.map +1 -1
- package/dist/models/DescribeVerifyTokenResponseBody.d.ts +34 -0
- package/dist/models/DescribeVerifyTokenResponseBody.js.map +1 -1
- package/dist/models/DetectFaceAttributesRequest.d.ts +5 -0
- package/dist/models/DetectFaceAttributesRequest.js.map +1 -1
- package/dist/models/DetectFaceAttributesResponseBody.d.ts +100 -0
- package/dist/models/DetectFaceAttributesResponseBody.js.map +1 -1
- package/dist/models/Id3metaVerifyAdvanceRequest.d.ts +87 -0
- package/dist/models/Id3metaVerifyAdvanceRequest.js +67 -0
- package/dist/models/Id3metaVerifyAdvanceRequest.js.map +1 -0
- package/dist/models/Id3metaVerifyRequest.d.ts +86 -0
- package/dist/models/Id3metaVerifyRequest.js +68 -0
- package/dist/models/Id3metaVerifyRequest.js.map +1 -0
- package/dist/models/Id3metaVerifyResponse.d.ts +19 -0
- package/dist/models/Id3metaVerifyResponse.js +69 -0
- package/dist/models/Id3metaVerifyResponse.js.map +1 -0
- package/dist/models/Id3metaVerifyResponseBody.d.ts +83 -0
- package/dist/models/Id3metaVerifyResponseBody.js +88 -0
- package/dist/models/Id3metaVerifyResponseBody.js.map +1 -0
- package/dist/models/InitFaceVerifyRequest.d.ts +348 -0
- package/dist/models/InitFaceVerifyRequest.js +2 -0
- package/dist/models/InitFaceVerifyRequest.js.map +1 -1
- package/dist/models/InitFaceVerifyResponseBody.d.ts +32 -0
- package/dist/models/InitFaceVerifyResponseBody.js.map +1 -1
- package/dist/models/LivenessFaceVerifyRequest.d.ts +46 -0
- package/dist/models/LivenessFaceVerifyRequest.js.map +1 -1
- package/dist/models/LivenessFaceVerifyResponseBody.d.ts +29 -0
- package/dist/models/LivenessFaceVerifyResponseBody.js.map +1 -1
- package/dist/models/VerifyMaterialRequest.d.ts +24 -0
- package/dist/models/VerifyMaterialRequest.js.map +1 -1
- package/dist/models/VerifyMaterialResponseBody.d.ts +118 -0
- package/dist/models/VerifyMaterialResponseBody.js.map +1 -1
- package/dist/models/model.d.ts +5 -0
- package/dist/models/model.js +15 -5
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +407 -10
- package/src/models/ContrastFaceVerifyAdvanceRequest.ts +93 -0
- package/src/models/ContrastFaceVerifyRequest.ts +93 -0
- package/src/models/ContrastFaceVerifyResponseBody.ts +32 -0
- package/src/models/CreateAuthKeyRequest.ts +12 -0
- package/src/models/CreateAuthKeyResponseBody.ts +6 -0
- package/src/models/CreateVerifySettingRequest.ts +18 -0
- package/src/models/CreateVerifySettingResponseBody.ts +20 -0
- package/src/models/CredentialVerifyRequest.ts +132 -0
- package/src/models/CredentialVerifyResponseBody.ts +103 -0
- package/src/models/CredentialVerifyShrinkRequest.ts +116 -0
- package/src/models/DescribeCardVerifyRequest.ts +3 -0
- package/src/models/DescribeCardVerifyResponseBody.ts +52 -0
- package/src/models/DescribeDeviceInfoRequest.ts +21 -0
- package/src/models/DescribeDeviceInfoResponseBody.ts +31 -0
- package/src/models/DescribeFaceGuardRiskRequest.ts +14 -0
- package/src/models/DescribeFaceGuardRiskResponseBody.ts +32 -1
- package/src/models/DescribeFaceVerifyRequest.ts +9 -0
- package/src/models/DescribeFaceVerifyResponseBody.ts +59 -0
- package/src/models/DescribeOssUploadTokenResponseBody.ts +28 -0
- package/src/models/DescribePageFaceVerifyDataRequest.ts +18 -0
- package/src/models/DescribePageFaceVerifyDataResponseBody.ts +50 -0
- package/src/models/DescribeSmartStatisticsPageListRequest.ts +13 -0
- package/src/models/DescribeSmartStatisticsPageListResponseBody.ts +44 -0
- package/src/models/DescribeVerifyResultRequest.ts +4 -0
- package/src/models/DescribeVerifyResultResponseBody.ts +125 -0
- package/src/models/DescribeVerifySdkrequest.ts +2 -0
- package/src/models/DescribeVerifySdkresponseBody.ts +6 -0
- package/src/models/DescribeVerifyTokenRequest.ts +49 -0
- package/src/models/DescribeVerifyTokenResponseBody.ts +34 -0
- package/src/models/DetectFaceAttributesRequest.ts +5 -0
- package/src/models/DetectFaceAttributesResponseBody.ts +100 -0
- package/src/models/Id3metaVerifyAdvanceRequest.ts +110 -0
- package/src/models/Id3metaVerifyRequest.ts +109 -0
- package/src/models/Id3metaVerifyResponse.ts +40 -0
- package/src/models/Id3metaVerifyResponseBody.ts +117 -0
- package/src/models/InitFaceVerifyRequest.ts +350 -0
- package/src/models/InitFaceVerifyResponseBody.ts +32 -0
- package/src/models/LivenessFaceVerifyRequest.ts +46 -0
- package/src/models/LivenessFaceVerifyResponseBody.ts +29 -0
- package/src/models/VerifyMaterialRequest.ts +24 -0
- package/src/models/VerifyMaterialResponseBody.ts +118 -0
- package/src/models/model.ts +5 -0
package/src/client.ts
CHANGED
|
@@ -424,6 +424,21 @@ export default class Client extends OpenApi {
|
|
|
424
424
|
}
|
|
425
425
|
|
|
426
426
|
/**
|
|
427
|
+
* This interface is used to submit authentication materials for verification and comparison, and it synchronously returns the authentication result.
|
|
428
|
+
*
|
|
429
|
+
* @remarks
|
|
430
|
+
* - Interface Name: ContrastFaceVerify.
|
|
431
|
+
* - Service Address: cloudauth.aliyuncs.com.
|
|
432
|
+
* - Request Method: HTTPS POST and GET.
|
|
433
|
+
* - Interface Description: An interface for real person authentication through server-side integration.
|
|
434
|
+
* #### Image Format Requirements
|
|
435
|
+
* When performing real person authentication, please ensure that the images you upload meet all of the following conditions:
|
|
436
|
+
* - Recent photo with a clear, unobstructed, and natural expression, facing the camera directly.
|
|
437
|
+
* - Clear and properly exposed photo, without overly dark, bright, or haloed faces, and with minimal angle deviation.
|
|
438
|
+
* - Resolution not exceeding 1920*1080, at least 640*480, with the shorter side recommended to be resized to 720 pixels, and a compression ratio greater than 0.9.
|
|
439
|
+
* - Photo size: <1MB.
|
|
440
|
+
* - Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.
|
|
441
|
+
*
|
|
427
442
|
* @param request - ContrastFaceVerifyRequest
|
|
428
443
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
429
444
|
* @returns ContrastFaceVerifyResponse
|
|
@@ -527,6 +542,21 @@ export default class Client extends OpenApi {
|
|
|
527
542
|
}
|
|
528
543
|
|
|
529
544
|
/**
|
|
545
|
+
* This interface is used to submit authentication materials for verification and comparison, and it synchronously returns the authentication result.
|
|
546
|
+
*
|
|
547
|
+
* @remarks
|
|
548
|
+
* - Interface Name: ContrastFaceVerify.
|
|
549
|
+
* - Service Address: cloudauth.aliyuncs.com.
|
|
550
|
+
* - Request Method: HTTPS POST and GET.
|
|
551
|
+
* - Interface Description: An interface for real person authentication through server-side integration.
|
|
552
|
+
* #### Image Format Requirements
|
|
553
|
+
* When performing real person authentication, please ensure that the images you upload meet all of the following conditions:
|
|
554
|
+
* - Recent photo with a clear, unobstructed, and natural expression, facing the camera directly.
|
|
555
|
+
* - Clear and properly exposed photo, without overly dark, bright, or haloed faces, and with minimal angle deviation.
|
|
556
|
+
* - Resolution not exceeding 1920*1080, at least 640*480, with the shorter side recommended to be resized to 720 pixels, and a compression ratio greater than 0.9.
|
|
557
|
+
* - Photo size: <1MB.
|
|
558
|
+
* - Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.
|
|
559
|
+
*
|
|
530
560
|
* @param request - ContrastFaceVerifyRequest
|
|
531
561
|
* @returns ContrastFaceVerifyResponse
|
|
532
562
|
*/
|
|
@@ -622,6 +652,12 @@ export default class Client extends OpenApi {
|
|
|
622
652
|
}
|
|
623
653
|
|
|
624
654
|
/**
|
|
655
|
+
* Call CreateAuthKey to get the authorization key, which is used for offline face recognition SDK activation.
|
|
656
|
+
*
|
|
657
|
+
* @remarks
|
|
658
|
+
* Request Method: Supports sending requests via HTTPS POST and GET methods.
|
|
659
|
+
* > The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
|
|
660
|
+
*
|
|
625
661
|
* @param request - CreateAuthKeyRequest
|
|
626
662
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
627
663
|
* @returns CreateAuthKeyResponse
|
|
@@ -663,6 +699,12 @@ export default class Client extends OpenApi {
|
|
|
663
699
|
}
|
|
664
700
|
|
|
665
701
|
/**
|
|
702
|
+
* Call CreateAuthKey to get the authorization key, which is used for offline face recognition SDK activation.
|
|
703
|
+
*
|
|
704
|
+
* @remarks
|
|
705
|
+
* Request Method: Supports sending requests via HTTPS POST and GET methods.
|
|
706
|
+
* > The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
|
|
707
|
+
*
|
|
666
708
|
* @param request - CreateAuthKeyRequest
|
|
667
709
|
* @returns CreateAuthKeyResponse
|
|
668
710
|
*/
|
|
@@ -672,6 +714,11 @@ export default class Client extends OpenApi {
|
|
|
672
714
|
}
|
|
673
715
|
|
|
674
716
|
/**
|
|
717
|
+
* Call CreateVerifySetting to create a verification scenario configuration. This operation is equivalent to creating a new verification scenario on the console.
|
|
718
|
+
*
|
|
719
|
+
* @remarks
|
|
720
|
+
* Request Method: Only supports sending requests via HTTPS POST.
|
|
721
|
+
*
|
|
675
722
|
* @param request - CreateVerifySettingRequest
|
|
676
723
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
677
724
|
* @returns CreateVerifySettingResponse
|
|
@@ -721,6 +768,11 @@ export default class Client extends OpenApi {
|
|
|
721
768
|
}
|
|
722
769
|
|
|
723
770
|
/**
|
|
771
|
+
* Call CreateVerifySetting to create a verification scenario configuration. This operation is equivalent to creating a new verification scenario on the console.
|
|
772
|
+
*
|
|
773
|
+
* @remarks
|
|
774
|
+
* Request Method: Only supports sending requests via HTTPS POST.
|
|
775
|
+
*
|
|
724
776
|
* @param request - CreateVerifySettingRequest
|
|
725
777
|
* @returns CreateVerifySettingResponse
|
|
726
778
|
*/
|
|
@@ -886,7 +938,7 @@ export default class Client extends OpenApi {
|
|
|
886
938
|
}
|
|
887
939
|
|
|
888
940
|
/**
|
|
889
|
-
*
|
|
941
|
+
* Credential verification
|
|
890
942
|
*
|
|
891
943
|
* @param tmpReq - CredentialVerifyRequest
|
|
892
944
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -977,7 +1029,7 @@ export default class Client extends OpenApi {
|
|
|
977
1029
|
}
|
|
978
1030
|
|
|
979
1031
|
/**
|
|
980
|
-
*
|
|
1032
|
+
* Credential verification
|
|
981
1033
|
*
|
|
982
1034
|
* @param request - CredentialVerifyRequest
|
|
983
1035
|
* @returns CredentialVerifyResponse
|
|
@@ -1306,7 +1358,10 @@ export default class Client extends OpenApi {
|
|
|
1306
1358
|
}
|
|
1307
1359
|
|
|
1308
1360
|
/**
|
|
1309
|
-
*
|
|
1361
|
+
* Obtain Authentication Results from Image Element Verification
|
|
1362
|
+
*
|
|
1363
|
+
* @remarks
|
|
1364
|
+
* After receiving the callback notification, you can use this interface on the server side to obtain the corresponding authentication status and information.
|
|
1310
1365
|
*
|
|
1311
1366
|
* @param request - DescribeCardVerifyRequest
|
|
1312
1367
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1337,7 +1392,10 @@ export default class Client extends OpenApi {
|
|
|
1337
1392
|
}
|
|
1338
1393
|
|
|
1339
1394
|
/**
|
|
1340
|
-
*
|
|
1395
|
+
* Obtain Authentication Results from Image Element Verification
|
|
1396
|
+
*
|
|
1397
|
+
* @remarks
|
|
1398
|
+
* After receiving the callback notification, you can use this interface on the server side to obtain the corresponding authentication status and information.
|
|
1341
1399
|
*
|
|
1342
1400
|
* @param request - DescribeCardVerifyRequest
|
|
1343
1401
|
* @returns DescribeCardVerifyResponse
|
|
@@ -1348,6 +1406,11 @@ export default class Client extends OpenApi {
|
|
|
1348
1406
|
}
|
|
1349
1407
|
|
|
1350
1408
|
/**
|
|
1409
|
+
* Call DescribeDeviceInfo to query device-related information, such as the validity period of authorization, business identifiers customized by the access party, and device ID, etc.
|
|
1410
|
+
*
|
|
1411
|
+
* @remarks
|
|
1412
|
+
* Request Method: Supports sending requests using HTTPS POST and GET methods.
|
|
1413
|
+
*
|
|
1351
1414
|
* @param request - DescribeDeviceInfoRequest
|
|
1352
1415
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1353
1416
|
* @returns DescribeDeviceInfoResponse
|
|
@@ -1401,6 +1464,11 @@ export default class Client extends OpenApi {
|
|
|
1401
1464
|
}
|
|
1402
1465
|
|
|
1403
1466
|
/**
|
|
1467
|
+
* Call DescribeDeviceInfo to query device-related information, such as the validity period of authorization, business identifiers customized by the access party, and device ID, etc.
|
|
1468
|
+
*
|
|
1469
|
+
* @remarks
|
|
1470
|
+
* Request Method: Supports sending requests using HTTPS POST and GET methods.
|
|
1471
|
+
*
|
|
1404
1472
|
* @param request - DescribeDeviceInfoRequest
|
|
1405
1473
|
* @returns DescribeDeviceInfoResponse
|
|
1406
1474
|
*/
|
|
@@ -1410,7 +1478,7 @@ export default class Client extends OpenApi {
|
|
|
1410
1478
|
}
|
|
1411
1479
|
|
|
1412
1480
|
/**
|
|
1413
|
-
*
|
|
1481
|
+
* Financial-Grade Face Guard Service
|
|
1414
1482
|
*
|
|
1415
1483
|
* @param request - DescribeFaceGuardRiskRequest
|
|
1416
1484
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1453,7 +1521,7 @@ export default class Client extends OpenApi {
|
|
|
1453
1521
|
}
|
|
1454
1522
|
|
|
1455
1523
|
/**
|
|
1456
|
-
*
|
|
1524
|
+
* Financial-Grade Face Guard Service
|
|
1457
1525
|
*
|
|
1458
1526
|
* @param request - DescribeFaceGuardRiskRequest
|
|
1459
1527
|
* @returns DescribeFaceGuardRiskResponse
|
|
@@ -1464,6 +1532,12 @@ export default class Client extends OpenApi {
|
|
|
1464
1532
|
}
|
|
1465
1533
|
|
|
1466
1534
|
/**
|
|
1535
|
+
* After the mobile end of the integrator receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
|
|
1536
|
+
*
|
|
1537
|
+
* @remarks
|
|
1538
|
+
* - Service Address: cloudauth.aliyuncs.com.
|
|
1539
|
+
* - Request Method: HTTPS POST and GET.
|
|
1540
|
+
*
|
|
1467
1541
|
* @param request - DescribeFaceVerifyRequest
|
|
1468
1542
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1469
1543
|
* @returns DescribeFaceVerifyResponse
|
|
@@ -1501,6 +1575,12 @@ export default class Client extends OpenApi {
|
|
|
1501
1575
|
}
|
|
1502
1576
|
|
|
1503
1577
|
/**
|
|
1578
|
+
* After the mobile end of the integrator receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
|
|
1579
|
+
*
|
|
1580
|
+
* @remarks
|
|
1581
|
+
* - Service Address: cloudauth.aliyuncs.com.
|
|
1582
|
+
* - Request Method: HTTPS POST and GET.
|
|
1583
|
+
*
|
|
1504
1584
|
* @param request - DescribeFaceVerifyRequest
|
|
1505
1585
|
* @returns DescribeFaceVerifyResponse
|
|
1506
1586
|
*/
|
|
@@ -1510,6 +1590,8 @@ export default class Client extends OpenApi {
|
|
|
1510
1590
|
}
|
|
1511
1591
|
|
|
1512
1592
|
/**
|
|
1593
|
+
* Call DescribeOssUploadToken to get the Token required for uploading photos to OSS.
|
|
1594
|
+
*
|
|
1513
1595
|
* @param request - DescribeOssUploadTokenRequest
|
|
1514
1596
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1515
1597
|
* @returns DescribeOssUploadTokenResponse
|
|
@@ -1531,6 +1613,7 @@ export default class Client extends OpenApi {
|
|
|
1531
1613
|
}
|
|
1532
1614
|
|
|
1533
1615
|
/**
|
|
1616
|
+
* Call DescribeOssUploadToken to get the Token required for uploading photos to OSS.
|
|
1534
1617
|
* @returns DescribeOssUploadTokenResponse
|
|
1535
1618
|
*/
|
|
1536
1619
|
async describeOssUploadToken(): Promise<$_model.DescribeOssUploadTokenResponse> {
|
|
@@ -1539,7 +1622,7 @@ export default class Client extends OpenApi {
|
|
|
1539
1622
|
}
|
|
1540
1623
|
|
|
1541
1624
|
/**
|
|
1542
|
-
* Open API
|
|
1625
|
+
* Open API adds financial-grade data statistics API
|
|
1543
1626
|
*
|
|
1544
1627
|
* @param request - DescribePageFaceVerifyDataRequest
|
|
1545
1628
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1590,7 +1673,7 @@ export default class Client extends OpenApi {
|
|
|
1590
1673
|
}
|
|
1591
1674
|
|
|
1592
1675
|
/**
|
|
1593
|
-
* Open API
|
|
1676
|
+
* Open API adds financial-grade data statistics API
|
|
1594
1677
|
*
|
|
1595
1678
|
* @param request - DescribePageFaceVerifyDataRequest
|
|
1596
1679
|
* @returns DescribePageFaceVerifyDataResponse
|
|
@@ -1601,6 +1684,8 @@ export default class Client extends OpenApi {
|
|
|
1601
1684
|
}
|
|
1602
1685
|
|
|
1603
1686
|
/**
|
|
1687
|
+
* Enhanced Real Person Authentication Call Statistics Pagination Query Interface
|
|
1688
|
+
*
|
|
1604
1689
|
* @param request - DescribeSmartStatisticsPageListRequest
|
|
1605
1690
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1606
1691
|
* @returns DescribeSmartStatisticsPageListResponse
|
|
@@ -1650,6 +1735,8 @@ export default class Client extends OpenApi {
|
|
|
1650
1735
|
}
|
|
1651
1736
|
|
|
1652
1737
|
/**
|
|
1738
|
+
* Enhanced Real Person Authentication Call Statistics Pagination Query Interface
|
|
1739
|
+
*
|
|
1653
1740
|
* @param request - DescribeSmartStatisticsPageListRequest
|
|
1654
1741
|
* @returns DescribeSmartStatisticsPageListResponse
|
|
1655
1742
|
*/
|
|
@@ -1659,6 +1746,15 @@ export default class Client extends OpenApi {
|
|
|
1659
1746
|
}
|
|
1660
1747
|
|
|
1661
1748
|
/**
|
|
1749
|
+
* Query the result of real-person authentication.
|
|
1750
|
+
*
|
|
1751
|
+
* @remarks
|
|
1752
|
+
* Prerequisites: Before accessing this API, please ensure that you have completed the necessary preparations. For more details, see [Real Person Authentication Server-side Preparation](https://help.aliyun.com/document_detail/127471.html) and [Liveness Face Verification Server-side Preparation](https://help.aliyun.com/document_detail/127717.html).
|
|
1753
|
+
* > Alibaba Cloud Real Person Authentication only stores authentication data for the last 180 days. For any subsequent business use, please call this interface in a timely manner to retrieve and store the data yourself to avoid any impact on usage.
|
|
1754
|
+
* Request Method: HTTPS POST and GET.
|
|
1755
|
+
* Interface Description: After the mobile end of the access party receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
|
|
1756
|
+
* Applicable Scope: This interface is applicable to the authentication solution with SDK + server-side integration.
|
|
1757
|
+
*
|
|
1662
1758
|
* @param request - DescribeVerifyResultRequest
|
|
1663
1759
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1664
1760
|
* @returns DescribeVerifyResultResponse
|
|
@@ -1692,6 +1788,15 @@ export default class Client extends OpenApi {
|
|
|
1692
1788
|
}
|
|
1693
1789
|
|
|
1694
1790
|
/**
|
|
1791
|
+
* Query the result of real-person authentication.
|
|
1792
|
+
*
|
|
1793
|
+
* @remarks
|
|
1794
|
+
* Prerequisites: Before accessing this API, please ensure that you have completed the necessary preparations. For more details, see [Real Person Authentication Server-side Preparation](https://help.aliyun.com/document_detail/127471.html) and [Liveness Face Verification Server-side Preparation](https://help.aliyun.com/document_detail/127717.html).
|
|
1795
|
+
* > Alibaba Cloud Real Person Authentication only stores authentication data for the last 180 days. For any subsequent business use, please call this interface in a timely manner to retrieve and store the data yourself to avoid any impact on usage.
|
|
1796
|
+
* Request Method: HTTPS POST and GET.
|
|
1797
|
+
* Interface Description: After the mobile end of the access party receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
|
|
1798
|
+
* Applicable Scope: This interface is applicable to the authentication solution with SDK + server-side integration.
|
|
1799
|
+
*
|
|
1695
1800
|
* @param request - DescribeVerifyResultRequest
|
|
1696
1801
|
* @returns DescribeVerifyResultResponse
|
|
1697
1802
|
*/
|
|
@@ -1701,6 +1806,12 @@ export default class Client extends OpenApi {
|
|
|
1701
1806
|
}
|
|
1702
1807
|
|
|
1703
1808
|
/**
|
|
1809
|
+
* Call DescribeVerifySDK to get the offline SDK download address.
|
|
1810
|
+
*
|
|
1811
|
+
* @remarks
|
|
1812
|
+
* Request Method: Supports sending requests via HTTPS POST and GET methods.
|
|
1813
|
+
* Interface Description: Obtain the SDK generation result based on the task ID for generating an offline facial recognition SDK.
|
|
1814
|
+
*
|
|
1704
1815
|
* @param request - DescribeVerifySDKRequest
|
|
1705
1816
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1706
1817
|
* @returns DescribeVerifySDKResponse
|
|
@@ -1730,6 +1841,12 @@ export default class Client extends OpenApi {
|
|
|
1730
1841
|
}
|
|
1731
1842
|
|
|
1732
1843
|
/**
|
|
1844
|
+
* Call DescribeVerifySDK to get the offline SDK download address.
|
|
1845
|
+
*
|
|
1846
|
+
* @remarks
|
|
1847
|
+
* Request Method: Supports sending requests via HTTPS POST and GET methods.
|
|
1848
|
+
* Interface Description: Obtain the SDK generation result based on the task ID for generating an offline facial recognition SDK.
|
|
1849
|
+
*
|
|
1733
1850
|
* @param request - DescribeVerifySDKRequest
|
|
1734
1851
|
* @returns DescribeVerifySDKResponse
|
|
1735
1852
|
*/
|
|
@@ -1739,6 +1856,20 @@ export default class Client extends OpenApi {
|
|
|
1739
1856
|
}
|
|
1740
1857
|
|
|
1741
1858
|
/**
|
|
1859
|
+
* Call DescribeVerifyToken to initiate an authentication request and obtain an authentication Token. This interface is suitable for authentication solutions using SDK + server-side integration.
|
|
1860
|
+
*
|
|
1861
|
+
* @remarks
|
|
1862
|
+
* Preparation for Access: When integrating this API, please ensure that the corresponding preparations have been completed. For details, see [Overview of Real Person Authentication Solution Integration Process](https://help.aliyun.com/document_detail/127536.html) and [Overview of Live Face Verification Solution (Liveness Detection Solution) Integration Process](https://help.aliyun.com/document_detail/127687.html).
|
|
1863
|
+
* Request Method: HTTPS POST and GET
|
|
1864
|
+
* API Description: Before each authentication, use this interface to obtain an authentication Token (VerifyToken), which is used to link various interfaces in the authentication request.
|
|
1865
|
+
* Applicable Scope: This interface is suitable for wireless SDK integration.
|
|
1866
|
+
* Image Address: Use HTTP or HTTPS addresses that are publicly accessible over the Internet. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
1867
|
+
* Image Restrictions:
|
|
1868
|
+
* - Relative or absolute paths of local images are not supported.
|
|
1869
|
+
* - The size of a single image should be controlled within 2 MB to avoid algorithm retrieval timeout.
|
|
1870
|
+
* - The face area in the image must be at least 64*64 pixels (px).
|
|
1871
|
+
* - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request to ensure it does not exceed the limit.
|
|
1872
|
+
*
|
|
1742
1873
|
* @param request - DescribeVerifyTokenRequest
|
|
1743
1874
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1744
1875
|
* @returns DescribeVerifyTokenResponse
|
|
@@ -1824,6 +1955,20 @@ export default class Client extends OpenApi {
|
|
|
1824
1955
|
}
|
|
1825
1956
|
|
|
1826
1957
|
/**
|
|
1958
|
+
* Call DescribeVerifyToken to initiate an authentication request and obtain an authentication Token. This interface is suitable for authentication solutions using SDK + server-side integration.
|
|
1959
|
+
*
|
|
1960
|
+
* @remarks
|
|
1961
|
+
* Preparation for Access: When integrating this API, please ensure that the corresponding preparations have been completed. For details, see [Overview of Real Person Authentication Solution Integration Process](https://help.aliyun.com/document_detail/127536.html) and [Overview of Live Face Verification Solution (Liveness Detection Solution) Integration Process](https://help.aliyun.com/document_detail/127687.html).
|
|
1962
|
+
* Request Method: HTTPS POST and GET
|
|
1963
|
+
* API Description: Before each authentication, use this interface to obtain an authentication Token (VerifyToken), which is used to link various interfaces in the authentication request.
|
|
1964
|
+
* Applicable Scope: This interface is suitable for wireless SDK integration.
|
|
1965
|
+
* Image Address: Use HTTP or HTTPS addresses that are publicly accessible over the Internet. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
1966
|
+
* Image Restrictions:
|
|
1967
|
+
* - Relative or absolute paths of local images are not supported.
|
|
1968
|
+
* - The size of a single image should be controlled within 2 MB to avoid algorithm retrieval timeout.
|
|
1969
|
+
* - The face area in the image must be at least 64*64 pixels (px).
|
|
1970
|
+
* - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request to ensure it does not exceed the limit.
|
|
1971
|
+
*
|
|
1827
1972
|
* @param request - DescribeVerifyTokenRequest
|
|
1828
1973
|
* @returns DescribeVerifyTokenResponse
|
|
1829
1974
|
*/
|
|
@@ -1833,6 +1978,20 @@ export default class Client extends OpenApi {
|
|
|
1833
1978
|
}
|
|
1834
1979
|
|
|
1835
1980
|
/**
|
|
1981
|
+
* Detect Validity Attributes in Face Photos
|
|
1982
|
+
*
|
|
1983
|
+
* @remarks
|
|
1984
|
+
* Request Method: Only supports sending requests via HTTPS POST.
|
|
1985
|
+
* Interface Description: Detects the validity-related attributes of faces in the input photo, which helps the business side to determine whether the photo meets their own business retention or comparison requirements. The currently supported face validity-related attributes include: whether it is a face, whether it is blurry, whether glasses are worn, face pose, whether it is a smile, etc.
|
|
1986
|
+
* Instructions for Uploading Image Addresses: When passing in images, you need to upload their corresponding HTTP, OSS addresses, or Base64 encoding.
|
|
1987
|
+
* - HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
1988
|
+
* - Base64 Encoding: An image encoded through base64, with the format being `base64://<image base64 string>`.
|
|
1989
|
+
* Image Limitations:
|
|
1990
|
+
* - Does not support relative or absolute paths of local images.
|
|
1991
|
+
* - Please keep the size of a single image within 2 MB to avoid algorithm timeout.
|
|
1992
|
+
* - There is an 8 MB size limit for the Body of a single request; please calculate the total size of all images and other information in the request and do not exceed the limit.
|
|
1993
|
+
* - When using Base64 to pass images, the request method needs to be changed to POST; the header description of the image Base64 string, such as `data:image/png;base64`, should be removed.
|
|
1994
|
+
*
|
|
1836
1995
|
* @param request - DetectFaceAttributesRequest
|
|
1837
1996
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1838
1997
|
* @returns DetectFaceAttributesResponse
|
|
@@ -1866,6 +2025,20 @@ export default class Client extends OpenApi {
|
|
|
1866
2025
|
}
|
|
1867
2026
|
|
|
1868
2027
|
/**
|
|
2028
|
+
* Detect Validity Attributes in Face Photos
|
|
2029
|
+
*
|
|
2030
|
+
* @remarks
|
|
2031
|
+
* Request Method: Only supports sending requests via HTTPS POST.
|
|
2032
|
+
* Interface Description: Detects the validity-related attributes of faces in the input photo, which helps the business side to determine whether the photo meets their own business retention or comparison requirements. The currently supported face validity-related attributes include: whether it is a face, whether it is blurry, whether glasses are worn, face pose, whether it is a smile, etc.
|
|
2033
|
+
* Instructions for Uploading Image Addresses: When passing in images, you need to upload their corresponding HTTP, OSS addresses, or Base64 encoding.
|
|
2034
|
+
* - HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
2035
|
+
* - Base64 Encoding: An image encoded through base64, with the format being `base64://<image base64 string>`.
|
|
2036
|
+
* Image Limitations:
|
|
2037
|
+
* - Does not support relative or absolute paths of local images.
|
|
2038
|
+
* - Please keep the size of a single image within 2 MB to avoid algorithm timeout.
|
|
2039
|
+
* - There is an 8 MB size limit for the Body of a single request; please calculate the total size of all images and other information in the request and do not exceed the limit.
|
|
2040
|
+
* - When using Base64 to pass images, the request method needs to be changed to POST; the header description of the image Base64 string, such as `data:image/png;base64`, should be removed.
|
|
2041
|
+
*
|
|
1869
2042
|
* @param request - DetectFaceAttributesRequest
|
|
1870
2043
|
* @returns DetectFaceAttributesResponse
|
|
1871
2044
|
*/
|
|
@@ -2211,6 +2384,160 @@ export default class Client extends OpenApi {
|
|
|
2211
2384
|
return id2MetaVerifyWithOCRResp;
|
|
2212
2385
|
}
|
|
2213
2386
|
|
|
2387
|
+
/**
|
|
2388
|
+
* Identity Three Elements Verification
|
|
2389
|
+
*
|
|
2390
|
+
* @remarks
|
|
2391
|
+
* Input name, ID number, and face photo to verify their authenticity and consistency through authoritative sources.
|
|
2392
|
+
*
|
|
2393
|
+
* @param request - Id3MetaVerifyRequest
|
|
2394
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2395
|
+
* @returns Id3MetaVerifyResponse
|
|
2396
|
+
*/
|
|
2397
|
+
async id3MetaVerifyWithOptions(request: $_model.Id3MetaVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.Id3MetaVerifyResponse> {
|
|
2398
|
+
request.validate();
|
|
2399
|
+
let body : {[key: string ]: any} = { };
|
|
2400
|
+
if (!$dara.isNull(request.crop)) {
|
|
2401
|
+
body["Crop"] = request.crop;
|
|
2402
|
+
}
|
|
2403
|
+
|
|
2404
|
+
if (!$dara.isNull(request.faceFile)) {
|
|
2405
|
+
body["FaceFile"] = request.faceFile;
|
|
2406
|
+
}
|
|
2407
|
+
|
|
2408
|
+
if (!$dara.isNull(request.faceUrl)) {
|
|
2409
|
+
body["FaceUrl"] = request.faceUrl;
|
|
2410
|
+
}
|
|
2411
|
+
|
|
2412
|
+
if (!$dara.isNull(request.identifyNum)) {
|
|
2413
|
+
body["IdentifyNum"] = request.identifyNum;
|
|
2414
|
+
}
|
|
2415
|
+
|
|
2416
|
+
if (!$dara.isNull(request.paramType)) {
|
|
2417
|
+
body["ParamType"] = request.paramType;
|
|
2418
|
+
}
|
|
2419
|
+
|
|
2420
|
+
if (!$dara.isNull(request.userName)) {
|
|
2421
|
+
body["UserName"] = request.userName;
|
|
2422
|
+
}
|
|
2423
|
+
|
|
2424
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2425
|
+
body: OpenApiUtil.parseToMap(body),
|
|
2426
|
+
});
|
|
2427
|
+
let params = new $OpenApiUtil.Params({
|
|
2428
|
+
action: "Id3MetaVerify",
|
|
2429
|
+
version: "2019-03-07",
|
|
2430
|
+
protocol: "HTTPS",
|
|
2431
|
+
pathname: "/",
|
|
2432
|
+
method: "POST",
|
|
2433
|
+
authType: "AK",
|
|
2434
|
+
style: "RPC",
|
|
2435
|
+
reqBodyType: "formData",
|
|
2436
|
+
bodyType: "json",
|
|
2437
|
+
});
|
|
2438
|
+
return $dara.cast<$_model.Id3MetaVerifyResponse>(await this.callApi(params, req, runtime), new $_model.Id3MetaVerifyResponse({}));
|
|
2439
|
+
}
|
|
2440
|
+
|
|
2441
|
+
/**
|
|
2442
|
+
* Identity Three Elements Verification
|
|
2443
|
+
*
|
|
2444
|
+
* @remarks
|
|
2445
|
+
* Input name, ID number, and face photo to verify their authenticity and consistency through authoritative sources.
|
|
2446
|
+
*
|
|
2447
|
+
* @param request - Id3MetaVerifyRequest
|
|
2448
|
+
* @returns Id3MetaVerifyResponse
|
|
2449
|
+
*/
|
|
2450
|
+
async id3MetaVerify(request: $_model.Id3MetaVerifyRequest): Promise<$_model.Id3MetaVerifyResponse> {
|
|
2451
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2452
|
+
return await this.id3MetaVerifyWithOptions(request, runtime);
|
|
2453
|
+
}
|
|
2454
|
+
|
|
2455
|
+
async id3MetaVerifyAdvance(request: $_model.Id3MetaVerifyAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.Id3MetaVerifyResponse> {
|
|
2456
|
+
// Step 0: init client
|
|
2457
|
+
if ($dara.isNull(this._credential)) {
|
|
2458
|
+
throw new $OpenApi.ClientError({
|
|
2459
|
+
code: "InvalidCredentials",
|
|
2460
|
+
message: "Please set up the credentials correctly. If you are setting them through environment variables, please ensure that ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set correctly. See https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems for more details.",
|
|
2461
|
+
});
|
|
2462
|
+
}
|
|
2463
|
+
|
|
2464
|
+
let credentialModel = await this._credential.getCredential();
|
|
2465
|
+
let accessKeyId = credentialModel.accessKeyId;
|
|
2466
|
+
let accessKeySecret = credentialModel.accessKeySecret;
|
|
2467
|
+
let securityToken = credentialModel.securityToken;
|
|
2468
|
+
let credentialType = credentialModel.type;
|
|
2469
|
+
let openPlatformEndpoint = this._openPlatformEndpoint;
|
|
2470
|
+
if ($dara.isNull(openPlatformEndpoint) || openPlatformEndpoint == "") {
|
|
2471
|
+
openPlatformEndpoint = "openplatform.aliyuncs.com";
|
|
2472
|
+
}
|
|
2473
|
+
|
|
2474
|
+
if ($dara.isNull(credentialType)) {
|
|
2475
|
+
credentialType = "access_key";
|
|
2476
|
+
}
|
|
2477
|
+
|
|
2478
|
+
let authConfig = new $OpenApiUtil.Config({
|
|
2479
|
+
accessKeyId: accessKeyId,
|
|
2480
|
+
accessKeySecret: accessKeySecret,
|
|
2481
|
+
securityToken: securityToken,
|
|
2482
|
+
type: credentialType,
|
|
2483
|
+
endpoint: openPlatformEndpoint,
|
|
2484
|
+
protocol: this._protocol,
|
|
2485
|
+
regionId: this._regionId,
|
|
2486
|
+
});
|
|
2487
|
+
let authClient = new OpenApi(authConfig);
|
|
2488
|
+
let authRequest = {
|
|
2489
|
+
Product: "Cloudauth",
|
|
2490
|
+
RegionId: this._regionId,
|
|
2491
|
+
};
|
|
2492
|
+
let authReq = new $OpenApiUtil.OpenApiRequest({
|
|
2493
|
+
query: OpenApiUtil.query(authRequest),
|
|
2494
|
+
});
|
|
2495
|
+
let authParams = new $OpenApiUtil.Params({
|
|
2496
|
+
action: "AuthorizeFileUpload",
|
|
2497
|
+
version: "2019-12-19",
|
|
2498
|
+
protocol: "HTTPS",
|
|
2499
|
+
pathname: "/",
|
|
2500
|
+
method: "GET",
|
|
2501
|
+
authType: "AK",
|
|
2502
|
+
style: "RPC",
|
|
2503
|
+
reqBodyType: "formData",
|
|
2504
|
+
bodyType: "json",
|
|
2505
|
+
});
|
|
2506
|
+
let authResponse : {[key: string]: any} = { };
|
|
2507
|
+
let fileObj = new $dara.FileField({ });
|
|
2508
|
+
let ossHeader : {[key: string]: any} = { };
|
|
2509
|
+
let tmpBody : {[key: string]: any} = { };
|
|
2510
|
+
let useAccelerate : boolean = false;
|
|
2511
|
+
let authResponseBody : {[key: string ]: string} = { };
|
|
2512
|
+
let id3MetaVerifyReq = new $_model.Id3MetaVerifyRequest({ });
|
|
2513
|
+
OpenApiUtil.convert(request, id3MetaVerifyReq);
|
|
2514
|
+
if (!$dara.isNull(request.faceFileObject)) {
|
|
2515
|
+
authResponse = await authClient.callApi(authParams, authReq, runtime);
|
|
2516
|
+
tmpBody = authResponse["body"];
|
|
2517
|
+
useAccelerate = Boolean(tmpBody["UseAccelerate"]);
|
|
2518
|
+
authResponseBody = OpenApiUtil.stringifyMapValue(tmpBody);
|
|
2519
|
+
fileObj = new $dara.FileField({
|
|
2520
|
+
filename: authResponseBody["ObjectKey"],
|
|
2521
|
+
content: request.faceFileObject,
|
|
2522
|
+
contentType: "",
|
|
2523
|
+
});
|
|
2524
|
+
ossHeader = {
|
|
2525
|
+
host: `${authResponseBody["Bucket"]}.${OpenApiUtil.getEndpoint(authResponseBody["Endpoint"], useAccelerate, this._endpointType)}`,
|
|
2526
|
+
OSSAccessKeyId: authResponseBody["AccessKeyId"],
|
|
2527
|
+
policy: authResponseBody["EncodedPolicy"],
|
|
2528
|
+
Signature: authResponseBody["Signature"],
|
|
2529
|
+
key: authResponseBody["ObjectKey"],
|
|
2530
|
+
file: fileObj,
|
|
2531
|
+
success_action_status: "201",
|
|
2532
|
+
};
|
|
2533
|
+
await this._postOSSObject(authResponseBody["Bucket"], ossHeader);
|
|
2534
|
+
id3MetaVerifyReq.faceFile = `http://${authResponseBody["Bucket"]}.${authResponseBody["Endpoint"]}/${authResponseBody["ObjectKey"]}`;
|
|
2535
|
+
}
|
|
2536
|
+
|
|
2537
|
+
let id3MetaVerifyResp = await this.id3MetaVerifyWithOptions(id3MetaVerifyReq, runtime);
|
|
2538
|
+
return id3MetaVerifyResp;
|
|
2539
|
+
}
|
|
2540
|
+
|
|
2214
2541
|
/**
|
|
2215
2542
|
* Initiate an authentication request for image verification
|
|
2216
2543
|
*
|
|
@@ -2296,7 +2623,19 @@ export default class Client extends OpenApi {
|
|
|
2296
2623
|
}
|
|
2297
2624
|
|
|
2298
2625
|
/**
|
|
2299
|
-
*
|
|
2626
|
+
* Real-Person Server Initialization Interface
|
|
2627
|
+
*
|
|
2628
|
+
* @remarks
|
|
2629
|
+
* - Service Address: cloudauth.aliyuncs.com
|
|
2630
|
+
* - Request Method: HTTPS POST and GET.
|
|
2631
|
+
* - This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).
|
|
2632
|
+
* #### Image Format Requirements
|
|
2633
|
+
* When performing real-person authentication, please provide images that meet all of the following conditions:
|
|
2634
|
+
* - Recent photo with a clear, unobstructed face, natural expression, and facing the camera directly.
|
|
2635
|
+
* - Clear photo with normal exposure, no overexposure, underexposure, or halo effects, and no significant angle deviation.
|
|
2636
|
+
* - Resolution not exceeding 1920*1080, at least 640*480, recommended short side scaled to 720 pixels, compression ratio greater than 0.9.
|
|
2637
|
+
* - Photo size: <1MB.
|
|
2638
|
+
* - Supports 90, 180, and 270-degree photos; in the case of multiple faces, the largest face will be selected.
|
|
2300
2639
|
*
|
|
2301
2640
|
* @param request - InitFaceVerifyRequest
|
|
2302
2641
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2377,6 +2716,10 @@ export default class Client extends OpenApi {
|
|
|
2377
2716
|
query["Mode"] = request.mode;
|
|
2378
2717
|
}
|
|
2379
2718
|
|
|
2719
|
+
if (!$dara.isNull(request.needMultiFaceCheck)) {
|
|
2720
|
+
query["NeedMultiFaceCheck"] = request.needMultiFaceCheck;
|
|
2721
|
+
}
|
|
2722
|
+
|
|
2380
2723
|
if (!$dara.isNull(request.ossBucketName)) {
|
|
2381
2724
|
query["OssBucketName"] = request.ossBucketName;
|
|
2382
2725
|
}
|
|
@@ -2473,7 +2816,19 @@ export default class Client extends OpenApi {
|
|
|
2473
2816
|
}
|
|
2474
2817
|
|
|
2475
2818
|
/**
|
|
2476
|
-
*
|
|
2819
|
+
* Real-Person Server Initialization Interface
|
|
2820
|
+
*
|
|
2821
|
+
* @remarks
|
|
2822
|
+
* - Service Address: cloudauth.aliyuncs.com
|
|
2823
|
+
* - Request Method: HTTPS POST and GET.
|
|
2824
|
+
* - This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).
|
|
2825
|
+
* #### Image Format Requirements
|
|
2826
|
+
* When performing real-person authentication, please provide images that meet all of the following conditions:
|
|
2827
|
+
* - Recent photo with a clear, unobstructed face, natural expression, and facing the camera directly.
|
|
2828
|
+
* - Clear photo with normal exposure, no overexposure, underexposure, or halo effects, and no significant angle deviation.
|
|
2829
|
+
* - Resolution not exceeding 1920*1080, at least 640*480, recommended short side scaled to 720 pixels, compression ratio greater than 0.9.
|
|
2830
|
+
* - Photo size: <1MB.
|
|
2831
|
+
* - Supports 90, 180, and 270-degree photos; in the case of multiple faces, the largest face will be selected.
|
|
2477
2832
|
*
|
|
2478
2833
|
* @param request - InitFaceVerifyRequest
|
|
2479
2834
|
* @returns InitFaceVerifyResponse
|
|
@@ -2546,6 +2901,11 @@ export default class Client extends OpenApi {
|
|
|
2546
2901
|
}
|
|
2547
2902
|
|
|
2548
2903
|
/**
|
|
2904
|
+
* Silent Liveness Face (LivenessFaceVerify) refers to a service that performs real face detection by inputting pre-obtained face images through an API. The algorithm primarily identifies whether the face is from a screen recording, printed picture, or other types of liveness attacks. This service is suitable for low-risk business scenarios or in conjunction with offline facial recognition SDKs. If your business has higher requirements for real face security, it is recommended to integrate App or WebSDK mode, or integrate with Deepfake face detection services to assist in identifying more dimensions of face forgery risks.
|
|
2905
|
+
*
|
|
2906
|
+
* @remarks
|
|
2907
|
+
* Invoke the LivenessFaceVerify interface to perform liveness detection on a face image.
|
|
2908
|
+
*
|
|
2549
2909
|
* @param request - LivenessFaceVerifyRequest
|
|
2550
2910
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
2551
2911
|
* @returns LivenessFaceVerifyResponse
|
|
@@ -2629,6 +2989,11 @@ export default class Client extends OpenApi {
|
|
|
2629
2989
|
}
|
|
2630
2990
|
|
|
2631
2991
|
/**
|
|
2992
|
+
* Silent Liveness Face (LivenessFaceVerify) refers to a service that performs real face detection by inputting pre-obtained face images through an API. The algorithm primarily identifies whether the face is from a screen recording, printed picture, or other types of liveness attacks. This service is suitable for low-risk business scenarios or in conjunction with offline facial recognition SDKs. If your business has higher requirements for real face security, it is recommended to integrate App or WebSDK mode, or integrate with Deepfake face detection services to assist in identifying more dimensions of face forgery risks.
|
|
2993
|
+
*
|
|
2994
|
+
* @remarks
|
|
2995
|
+
* Invoke the LivenessFaceVerify interface to perform liveness detection on a face image.
|
|
2996
|
+
*
|
|
2632
2997
|
* @param request - LivenessFaceVerifyRequest
|
|
2633
2998
|
* @returns LivenessFaceVerifyResponse
|
|
2634
2999
|
*/
|
|
@@ -3578,6 +3943,22 @@ export default class Client extends OpenApi {
|
|
|
3578
3943
|
}
|
|
3579
3944
|
|
|
3580
3945
|
/**
|
|
3946
|
+
* Call VerifyMaterial, in a pure server-side access authentication solution, input name, ID number, portrait photo, and front and back photos of the ID card (optional) for real-person authentication, and return the authentication result synchronously.
|
|
3947
|
+
*
|
|
3948
|
+
* @remarks
|
|
3949
|
+
* Preparation for Access: When integrating this API, please ensure that the corresponding preparatory work has been completed. For details, please refer to [Server-side Access Preparation](https://help.aliyun.com/document_detail/127471.html).
|
|
3950
|
+
* Request Method: HTTPS POST and GET.
|
|
3951
|
+
* API Description: The server of the access party submits the authentication materials to the real-person authentication service for verification and comparison, with the results returned synchronously.
|
|
3952
|
+
* Applicable Scope: This interface is only applicable to pure server-side access authentication solutions.
|
|
3953
|
+
* Image Upload Address Explanation:
|
|
3954
|
+
* - HTTP or HTTPS address: Supports publicly accessible HTTP or HTTPS addresses. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
3955
|
+
* - OSS address: If the images from the access party are local files, Alibaba Cloud also provides an upload SDK, supporting the business party to upload the images to the specified OSS bucket of the real-person authentication service, and use the obtained OSS address as the image address parameter in the interface. If your business needs to use the upload SDK, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us for acquisition.
|
|
3956
|
+
* Image Limitations:
|
|
3957
|
+
* - Does not support relative or absolute paths of local images.
|
|
3958
|
+
* - Please keep the size of a single image within 2 MB to avoid algorithm retrieval timeout.
|
|
3959
|
+
* - The face area in the image should be at least 64*64 pixels.
|
|
3960
|
+
* - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request, and do not exceed the limit.
|
|
3961
|
+
*
|
|
3581
3962
|
* @param request - VerifyMaterialRequest
|
|
3582
3963
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
3583
3964
|
* @returns VerifyMaterialResponse
|
|
@@ -3635,6 +4016,22 @@ export default class Client extends OpenApi {
|
|
|
3635
4016
|
}
|
|
3636
4017
|
|
|
3637
4018
|
/**
|
|
4019
|
+
* Call VerifyMaterial, in a pure server-side access authentication solution, input name, ID number, portrait photo, and front and back photos of the ID card (optional) for real-person authentication, and return the authentication result synchronously.
|
|
4020
|
+
*
|
|
4021
|
+
* @remarks
|
|
4022
|
+
* Preparation for Access: When integrating this API, please ensure that the corresponding preparatory work has been completed. For details, please refer to [Server-side Access Preparation](https://help.aliyun.com/document_detail/127471.html).
|
|
4023
|
+
* Request Method: HTTPS POST and GET.
|
|
4024
|
+
* API Description: The server of the access party submits the authentication materials to the real-person authentication service for verification and comparison, with the results returned synchronously.
|
|
4025
|
+
* Applicable Scope: This interface is only applicable to pure server-side access authentication solutions.
|
|
4026
|
+
* Image Upload Address Explanation:
|
|
4027
|
+
* - HTTP or HTTPS address: Supports publicly accessible HTTP or HTTPS addresses. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
|
|
4028
|
+
* - OSS address: If the images from the access party are local files, Alibaba Cloud also provides an upload SDK, supporting the business party to upload the images to the specified OSS bucket of the real-person authentication service, and use the obtained OSS address as the image address parameter in the interface. If your business needs to use the upload SDK, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us for acquisition.
|
|
4029
|
+
* Image Limitations:
|
|
4030
|
+
* - Does not support relative or absolute paths of local images.
|
|
4031
|
+
* - Please keep the size of a single image within 2 MB to avoid algorithm retrieval timeout.
|
|
4032
|
+
* - The face area in the image should be at least 64*64 pixels.
|
|
4033
|
+
* - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request, and do not exceed the limit.
|
|
4034
|
+
*
|
|
3638
4035
|
* @param request - VerifyMaterialRequest
|
|
3639
4036
|
* @returns VerifyMaterialResponse
|
|
3640
4037
|
*/
|