java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.essbasic.v20201222.EssbasicClient

public class EssbasicClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor	Description
`EssbasicClient(Credential credential, String region)`
`EssbasicClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ArchiveFlowResponse`	`ArchiveFlow(ArchiveFlowRequest req)`	此接口（ArchiveFlow）用于流程的归档。注意：归档后的流程不可再进行发送、签署、拒签、撤回等一系列操作。
`CancelFlowResponse`	`CancelFlow(CancelFlowRequest req)`	此接口（CancelFlow）用于撤销正在进行中的流程。注：已归档流程不可完成撤销动作。
`CheckBankCard2EVerificationResponse`	`CheckBankCard2EVerification(CheckBankCard2EVerificationRequest req)`	该接口为第三方平台向电子签平台验证银行卡二要素
`CheckBankCard3EVerificationResponse`	`CheckBankCard3EVerification(CheckBankCard3EVerificationRequest req)`	该接口为第三方平台向电子签平台验证银行卡三要素
`CheckBankCard4EVerificationResponse`	`CheckBankCard4EVerification(CheckBankCard4EVerificationRequest req)`	该接口为第三方平台向电子签平台验证银行卡四要素
`CheckBankCardVerificationResponse`	`CheckBankCardVerification(CheckBankCardVerificationRequest req)`	该接口为第三方平台向电子签平台验证银行卡二/三/四要素银行卡二要素(同CheckBankCard2EVerification): bank_card + name 银行卡三要素(同CheckBankCard3EVerification): bank_card + name + id_card_number 银行卡四要素(同CheckBankCard4EVerification): bank_card + name + id_card_number + mobile
`CheckFaceIdentifyResponse`	`CheckFaceIdentify(CheckFaceIdentifyRequest req)`	该接口为第三方平台向电子签平台检测慧眼或腾讯电子签小程序人脸核身结果
`CheckIdCardVerificationResponse`	`CheckIdCardVerification(CheckIdCardVerificationRequest req)`	该接口为第三方平台向电子签平台验证姓名和身份证信息
`CheckMobileAndNameResponse`	`CheckMobileAndName(CheckMobileAndNameRequest req)`	该接口为第三方平台向电子签平台验证手机号二要素
`CheckMobileVerificationResponse`	`CheckMobileVerification(CheckMobileVerificationRequest req)`	该接口为第三方平台向电子签平台验证手机号三要素
`CheckVerifyCodeMatchFlowIdResponse`	`CheckVerifyCodeMatchFlowId(CheckVerifyCodeMatchFlowIdRequest req)`	此接口用于确认验证码是否正确
`CreateFaceIdSignResponse`	`CreateFaceIdSign(CreateFaceIdSignRequest req)`	该接口为第三方平台向电子签平台获取慧眼慧眼API签名
`CreateFlowByFilesResponse`	`CreateFlowByFiles(CreateFlowByFilesRequest req)`	此接口（CreateFlowByFiles）用于通过PDF文件创建签署流程。注意：调用此接口前，请先调用多文件上传接口 (UploadFiles)，提前上传合同文件。
`CreateH5FaceIdUrlResponse`	`CreateH5FaceIdUrl(CreateH5FaceIdUrlRequest req)`	该接口为第三方平台向电子签平台获取慧眼H5人脸核身Url
`CreatePreviewSignUrlResponse`	`CreatePreviewSignUrl(CreatePreviewSignUrlRequest req)`	此接口（CreatePreviewSignUrl）用于生成生成预览签署URL。注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
`CreateSealResponse`	`CreateSeal(CreateSealRequest req)`	此接口（CreateSeal）用于创建个人/企业印章。注意：使用FileId参数指定印章，需先调用多文件上传 (UploadFiles) 上传印章图片。
`CreateServerFlowSignResponse`	`CreateServerFlowSign(CreateServerFlowSignRequest req)`	此接口（CreateServerFlowSign）用于静默签署文件。注： 1、此接口为白名单接口，调用前请提前与客服经理或邮件至[email protected]进行联系。 2、仅合同发起者可使用流程静默签署能力。
`CreateSignUrlResponse`	`CreateSignUrl(CreateSignUrlRequest req)`	此接口（CreateSignUrl）用于生成指定用户的签署URL。注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
`CreateSubOrganizationResponse`	`CreateSubOrganization(CreateSubOrganizationRequest req)`	此接口（CreateSubOrganization）用于在腾讯电子签内注册子机构。
`CreateSubOrganizationAndSealResponse`	`CreateSubOrganizationAndSeal(CreateSubOrganizationAndSealRequest req)`	此接口（CreateSubOrganizationAndSeal）用于注册子机构，同时系统将为该子企业自动生成一个默认电子印章图片。注意： 1.
`CreateUserResponse`	`CreateUser(CreateUserRequest req)`	此接口（CreateUser）用于注册腾讯电子签个人用户。
`CreateUserAndSealResponse`	`CreateUserAndSeal(CreateUserAndSealRequest req)`	第三方应用可通过此接口（CreateUserAndSeal）注册腾讯电子签实名个人用户，同时系统将为该用户自动生成一个默认电子签名图片。注意： 1.
`DeleteSealResponse`	`DeleteSeal(DeleteSealRequest req)`	此接口 (DeleteSeal) 用于删除指定ID的印章。注意：默认印章不支持删除
`DescribeCatalogApproversResponse`	`DescribeCatalogApprovers(DescribeCatalogApproversRequest req)`	第三方应用可通过此接口（DescribeCatalogApprovers）查询指定目录的参与者列表
`DescribeCatalogSignComponentsResponse`	`DescribeCatalogSignComponents(DescribeCatalogSignComponentsRequest req)`	第三方应用可通过此接口（DescribeCatalogSignComponents）拉取目录签署区
`DescribeCustomFlowIdsResponse`	`DescribeCustomFlowIds(DescribeCustomFlowIdsRequest req)`	此接口（DescribeCustomFlowIds）用于通过自定义流程id来查询对应的电子签流程id
`DescribeCustomFlowIdsByFlowIdResponse`	`DescribeCustomFlowIdsByFlowId(DescribeCustomFlowIdsByFlowIdRequest req)`	此接口（DescribeCustomFlowIdsByFlowId）用于根据流程id反查自定义流程id
`DescribeFaceIdPhotosResponse`	`DescribeFaceIdPhotos(DescribeFaceIdPhotosRequest req)`	该接口为第三方平台向电子签平台获取慧眼人脸核身照片
`DescribeFaceIdResultsResponse`	`DescribeFaceIdResults(DescribeFaceIdResultsRequest req)`	该接口为第三方平台向电子签平台获取慧眼人脸核身结果
`DescribeFileIdsByCustomIdsResponse`	`DescribeFileIdsByCustomIds(DescribeFileIdsByCustomIdsRequest req)`	根据用户自定义id查询文件id
`DescribeFileUrlsResponse`	`DescribeFileUrls(DescribeFileUrlsRequest req)`	此接口（DescribeFileUrls）用于获取签署文件下载的URL。
`DescribeFlowResponse`	`DescribeFlow(DescribeFlowRequest req)`	通过此接口（DescribeFlow）可查询签署流程的详细信息。
`DescribeFlowApproversResponse`	`DescribeFlowApprovers(DescribeFlowApproversRequest req)`	第三方应用可通过此接口（DescribeFlowApprovers）查询流程参与者信息。
`DescribeFlowFilesResponse`	`DescribeFlowFiles(DescribeFlowFilesRequest req)`	查询流程文件
`DescribeSealsResponse`	`DescribeSeals(DescribeSealsRequest req)`	此接口（DescribeSeals）用于查询指定ID的印章信息。
`DescribeSubOrganizationsResponse`	`DescribeSubOrganizations(DescribeSubOrganizationsRequest req)`	此接口（DescribeSubOrganizations）用于查询子机构信息。注：此接口仅可查询您所属机构应用号创建的子机构信息，不可跨应用/跨机构查询。
`DescribeUsersResponse`	`DescribeUsers(DescribeUsersRequest req)`	此接口（DescribeUsers）用于查询应用号下的个人用户信息。注：此接口仅可查询您所属机构应用号创建的个人用户信息，不可跨应用/跨机构查询。
`DestroyFlowFileResponse`	`DestroyFlowFile(DestroyFlowFileRequest req)`	通过此接口（DestroyFlowFile）可删除指定流程中的合同文件。注：调用此接口前，请确保此流程已属于归档状态。您可通过查询流程信息接口（DescribeFlow）进行查询。
`GenerateOrganizationSealResponse`	`GenerateOrganizationSeal(GenerateOrganizationSealRequest req)`	生成企业电子印章
`GenerateUserSealResponse`	`GenerateUserSeal(GenerateUserSealRequest req)`	此接口（GenerateUserSeal）用于生成个人签名图片。注意： 1.
`ModifyOrganizationDefaultSealResponse`	`ModifyOrganizationDefaultSeal(ModifyOrganizationDefaultSealRequest req)`	此接口 (ModifyOrganizationDefaultSeal) 用于重新指定企业默认印章。
`ModifySealResponse`	`ModifySeal(ModifySealRequest req)`	此接口（ModifySeal）用于修改指定印章ID的印章图片和名称。注：印章类型暂不支持修改，如需调整，请联系客服经理或通过创建印章接口（CreateSeal）进行创建新印章。
`ModifySubOrganizationInfoResponse`	`ModifySubOrganizationInfo(ModifySubOrganizationInfoRequest req)`	此接口（ModifySubOrganizationInfo）用于更新子机构信息。注：若修改子机构名称或更新机构证件照片，需要重新通过子机构实名接口（VerifySubOrganization）进行重新实名。
`ModifyUserResponse`	`ModifyUser(ModifyUserRequest req)`	此接口（ModifyUser）用于更新个人用户信息。注：若修改用户姓名，需要重新通过个人用户实名接口（VerifyUser）进行重新实名。
`ModifyUserDefaultSealResponse`	`ModifyUserDefaultSeal(ModifyUserDefaultSealRequest req)`	此接口 (ModifyUserDefaultSeal) 用于重新指定个人默认印章。
`RejectFlowResponse`	`RejectFlow(RejectFlowRequest req)`	此接口（RejectFlow）用于用户拒绝签署合同流程。
`SendFlowResponse`	`SendFlow(SendFlowRequest req)`	此接口（SendFlow）用于指定签署者及签署内容，后续可通过生成签署接口（CreateSignUrl）获取签署url。
`SendFlowUrlResponse`	`SendFlowUrl(SendFlowUrlRequest req)`	发送流程并获取签署URL
`SendSignInnerVerifyCodeResponse`	`SendSignInnerVerifyCode(SendSignInnerVerifyCodeRequest req)`	此接口用于发送签署验证码
`SignFlowResponse`	`SignFlow(SignFlowRequest req)`	此接口（SignFlow）可用于对流程文件进行签署。
`UploadFilesResponse`	`UploadFiles(UploadFilesRequest req)`	此接口（UploadFiles）用于文件上传。
`VerifySubOrganizationResponse`	`VerifySubOrganization(VerifySubOrganizationRequest req)`	此接口（VerifySubOrganization）用于通过子机构的实名认证。注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
`VerifyUserResponse`	`VerifyUser(VerifyUserRequest req)`	第三方应用可通过此接口（VerifyUser）将腾讯电子签个人用户的实名认证状态设为通过。注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EssbasicClient
```
public EssbasicClient(Credential credential,
                      String region)
```
  - EssbasicClient
```
public EssbasicClient(Credential credential,
                      String region,
                      ClientProfile profile)
```
- Method Detail
  - ArchiveFlow
```
public ArchiveFlowResponse ArchiveFlow(ArchiveFlowRequest req)
                                throws TencentCloudSDKException
```
    此接口（ArchiveFlow）用于流程的归档。注意：归档后的流程不可再进行发送、签署、拒签、撤回等一系列操作。
    
    Parameters:
    
    req - ArchiveFlowRequest
    
    Returns:
    
    ArchiveFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelFlow
```
public CancelFlowResponse CancelFlow(CancelFlowRequest req)
                              throws TencentCloudSDKException
```
    此接口（CancelFlow）用于撤销正在进行中的流程。注：已归档流程不可完成撤销动作。
    
    Parameters:
    
    req - CancelFlowRequest
    
    Returns:
    
    CancelFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckBankCard2EVerification
```
public CheckBankCard2EVerificationResponse CheckBankCard2EVerification(CheckBankCard2EVerificationRequest req)
                                                                throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证银行卡二要素
    
    Parameters:
    
    req - CheckBankCard2EVerificationRequest
    
    Returns:
    
    CheckBankCard2EVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckBankCard3EVerification
```
public CheckBankCard3EVerificationResponse CheckBankCard3EVerification(CheckBankCard3EVerificationRequest req)
                                                                throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证银行卡三要素
    
    Parameters:
    
    req - CheckBankCard3EVerificationRequest
    
    Returns:
    
    CheckBankCard3EVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckBankCard4EVerification
```
public CheckBankCard4EVerificationResponse CheckBankCard4EVerification(CheckBankCard4EVerificationRequest req)
                                                                throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证银行卡四要素
    
    Parameters:
    
    req - CheckBankCard4EVerificationRequest
    
    Returns:
    
    CheckBankCard4EVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckBankCardVerification
```
public CheckBankCardVerificationResponse CheckBankCardVerification(CheckBankCardVerificationRequest req)
                                                            throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证银行卡二/三/四要素银行卡二要素(同CheckBankCard2EVerification): bank_card + name 银行卡三要素(同CheckBankCard3EVerification): bank_card + name + id_card_number 银行卡四要素(同CheckBankCard4EVerification): bank_card + name + id_card_number + mobile
    
    Parameters:
    
    req - CheckBankCardVerificationRequest
    
    Returns:
    
    CheckBankCardVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckFaceIdentify
```
public CheckFaceIdentifyResponse CheckFaceIdentify(CheckFaceIdentifyRequest req)
                                            throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台检测慧眼或腾讯电子签小程序人脸核身结果
    
    Parameters:
    
    req - CheckFaceIdentifyRequest
    
    Returns:
    
    CheckFaceIdentifyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckIdCardVerification
```
public CheckIdCardVerificationResponse CheckIdCardVerification(CheckIdCardVerificationRequest req)
                                                        throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证姓名和身份证信息
    
    Parameters:
    
    req - CheckIdCardVerificationRequest
    
    Returns:
    
    CheckIdCardVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckMobileAndName
```
public CheckMobileAndNameResponse CheckMobileAndName(CheckMobileAndNameRequest req)
                                              throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证手机号二要素
    
    Parameters:
    
    req - CheckMobileAndNameRequest
    
    Returns:
    
    CheckMobileAndNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckMobileVerification
```
public CheckMobileVerificationResponse CheckMobileVerification(CheckMobileVerificationRequest req)
                                                        throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台验证手机号三要素
    
    Parameters:
    
    req - CheckMobileVerificationRequest
    
    Returns:
    
    CheckMobileVerificationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CheckVerifyCodeMatchFlowId
```
public CheckVerifyCodeMatchFlowIdResponse CheckVerifyCodeMatchFlowId(CheckVerifyCodeMatchFlowIdRequest req)
                                                              throws TencentCloudSDKException
```
    此接口用于确认验证码是否正确
    
    Parameters:
    
    req - CheckVerifyCodeMatchFlowIdRequest
    
    Returns:
    
    CheckVerifyCodeMatchFlowIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFaceIdSign
```
public CreateFaceIdSignResponse CreateFaceIdSign(CreateFaceIdSignRequest req)
                                          throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台获取慧眼慧眼API签名
    
    Parameters:
    
    req - CreateFaceIdSignRequest
    
    Returns:
    
    CreateFaceIdSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFlowByFiles
```
public CreateFlowByFilesResponse CreateFlowByFiles(CreateFlowByFilesRequest req)
                                            throws TencentCloudSDKException
```
    此接口（CreateFlowByFiles）用于通过PDF文件创建签署流程。注意：调用此接口前，请先调用多文件上传接口 (UploadFiles)，提前上传合同文件。
    
    Parameters:
    
    req - CreateFlowByFilesRequest
    
    Returns:
    
    CreateFlowByFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateH5FaceIdUrl
```
public CreateH5FaceIdUrlResponse CreateH5FaceIdUrl(CreateH5FaceIdUrlRequest req)
                                            throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台获取慧眼H5人脸核身Url
    
    Parameters:
    
    req - CreateH5FaceIdUrlRequest
    
    Returns:
    
    CreateH5FaceIdUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePreviewSignUrl
```
public CreatePreviewSignUrlResponse CreatePreviewSignUrl(CreatePreviewSignUrlRequest req)
                                                  throws TencentCloudSDKException
```
    此接口（CreatePreviewSignUrl）用于生成生成预览签署URL。注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
    
    Parameters:
    
    req - CreatePreviewSignUrlRequest
    
    Returns:
    
    CreatePreviewSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSeal
```
public CreateSealResponse CreateSeal(CreateSealRequest req)
                              throws TencentCloudSDKException
```
    此接口（CreateSeal）用于创建个人/企业印章。注意：使用FileId参数指定印章，需先调用多文件上传 (UploadFiles) 上传印章图片。
    
    Parameters:
    
    req - CreateSealRequest
    
    Returns:
    
    CreateSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateServerFlowSign
```
public CreateServerFlowSignResponse CreateServerFlowSign(CreateServerFlowSignRequest req)
                                                  throws TencentCloudSDKException
```
    此接口（CreateServerFlowSign）用于静默签署文件。注： 1、此接口为白名单接口，调用前请提前与客服经理或邮件至[email protected]进行联系。 2、仅合同发起者可使用流程静默签署能力。
    
    Parameters:
    
    req - CreateServerFlowSignRequest
    
    Returns:
    
    CreateServerFlowSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSignUrl
```
public CreateSignUrlResponse CreateSignUrl(CreateSignUrlRequest req)
                                    throws TencentCloudSDKException
```
    此接口（CreateSignUrl）用于生成指定用户的签署URL。注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
    
    Parameters:
    
    req - CreateSignUrlRequest
    
    Returns:
    
    CreateSignUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSubOrganization
```
public CreateSubOrganizationResponse CreateSubOrganization(CreateSubOrganizationRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（CreateSubOrganization）用于在腾讯电子签内注册子机构。
    
    Parameters:
    
    req - CreateSubOrganizationRequest
    
    Returns:
    
    CreateSubOrganizationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSubOrganizationAndSeal
```
public CreateSubOrganizationAndSealResponse CreateSubOrganizationAndSeal(CreateSubOrganizationAndSealRequest req)
                                                                  throws TencentCloudSDKException
```
    此接口（CreateSubOrganizationAndSeal）用于注册子机构，同时系统将为该子企业自动生成一个默认电子印章图片。注意： 1. 在后续的签署流程中，若未指定签署使用的印章ID，则默认调用自动生成的印章图片进行签署。 2. 此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
    
    Parameters:
    
    req - CreateSubOrganizationAndSealRequest
    
    Returns:
    
    CreateSubOrganizationAndSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUser
```
public CreateUserResponse CreateUser(CreateUserRequest req)
                              throws TencentCloudSDKException
```
    此接口（CreateUser）用于注册腾讯电子签个人用户。
    
    Parameters:
    
    req - CreateUserRequest
    
    Returns:
    
    CreateUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUserAndSeal
```
public CreateUserAndSealResponse CreateUserAndSeal(CreateUserAndSealRequest req)
                                            throws TencentCloudSDKException
```
    第三方应用可通过此接口（CreateUserAndSeal）注册腾讯电子签实名个人用户，同时系统将为该用户自动生成一个默认电子签名图片。注意： 1. 在后续的签署流程中，若未指定签署使用的印章ID，则默认调用自动生成的签名图片进行签署。 2. 此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
    
    Parameters:
    
    req - CreateUserAndSealRequest
    
    Returns:
    
    CreateUserAndSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSeal
```
public DeleteSealResponse DeleteSeal(DeleteSealRequest req)
                              throws TencentCloudSDKException
```
    此接口 (DeleteSeal) 用于删除指定ID的印章。注意：默认印章不支持删除
    
    Parameters:
    
    req - DeleteSealRequest
    
    Returns:
    
    DeleteSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCatalogApprovers
```
public DescribeCatalogApproversResponse DescribeCatalogApprovers(DescribeCatalogApproversRequest req)
                                                          throws TencentCloudSDKException
```
    第三方应用可通过此接口（DescribeCatalogApprovers）查询指定目录的参与者列表
    
    Parameters:
    
    req - DescribeCatalogApproversRequest
    
    Returns:
    
    DescribeCatalogApproversResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCatalogSignComponents
```
public DescribeCatalogSignComponentsResponse DescribeCatalogSignComponents(DescribeCatalogSignComponentsRequest req)
                                                                    throws TencentCloudSDKException
```
    第三方应用可通过此接口（DescribeCatalogSignComponents）拉取目录签署区
    
    Parameters:
    
    req - DescribeCatalogSignComponentsRequest
    
    Returns:
    
    DescribeCatalogSignComponentsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCustomFlowIds
```
public DescribeCustomFlowIdsResponse DescribeCustomFlowIds(DescribeCustomFlowIdsRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（DescribeCustomFlowIds）用于通过自定义流程id来查询对应的电子签流程id
    
    Parameters:
    
    req - DescribeCustomFlowIdsRequest
    
    Returns:
    
    DescribeCustomFlowIdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCustomFlowIdsByFlowId
```
public DescribeCustomFlowIdsByFlowIdResponse DescribeCustomFlowIdsByFlowId(DescribeCustomFlowIdsByFlowIdRequest req)
                                                                    throws TencentCloudSDKException
```
    此接口（DescribeCustomFlowIdsByFlowId）用于根据流程id反查自定义流程id
    
    Parameters:
    
    req - DescribeCustomFlowIdsByFlowIdRequest
    
    Returns:
    
    DescribeCustomFlowIdsByFlowIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFaceIdPhotos
```
public DescribeFaceIdPhotosResponse DescribeFaceIdPhotos(DescribeFaceIdPhotosRequest req)
                                                  throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台获取慧眼人脸核身照片
    
    Parameters:
    
    req - DescribeFaceIdPhotosRequest
    
    Returns:
    
    DescribeFaceIdPhotosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFaceIdResults
```
public DescribeFaceIdResultsResponse DescribeFaceIdResults(DescribeFaceIdResultsRequest req)
                                                    throws TencentCloudSDKException
```
    该接口为第三方平台向电子签平台获取慧眼人脸核身结果
    
    Parameters:
    
    req - DescribeFaceIdResultsRequest
    
    Returns:
    
    DescribeFaceIdResultsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFileIdsByCustomIds
```
public DescribeFileIdsByCustomIdsResponse DescribeFileIdsByCustomIds(DescribeFileIdsByCustomIdsRequest req)
                                                              throws TencentCloudSDKException
```
    根据用户自定义id查询文件id
    
    Parameters:
    
    req - DescribeFileIdsByCustomIdsRequest
    
    Returns:
    
    DescribeFileIdsByCustomIdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFileUrls
```
public DescribeFileUrlsResponse DescribeFileUrls(DescribeFileUrlsRequest req)
                                          throws TencentCloudSDKException
```
    此接口（DescribeFileUrls）用于获取签署文件下载的URL。
    
    Parameters:
    
    req - DescribeFileUrlsRequest
    
    Returns:
    
    DescribeFileUrlsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlow
```
public DescribeFlowResponse DescribeFlow(DescribeFlowRequest req)
                                  throws TencentCloudSDKException
```
    通过此接口（DescribeFlow）可查询签署流程的详细信息。
    
    Parameters:
    
    req - DescribeFlowRequest
    
    Returns:
    
    DescribeFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowApprovers
```
public DescribeFlowApproversResponse DescribeFlowApprovers(DescribeFlowApproversRequest req)
                                                    throws TencentCloudSDKException
```
    第三方应用可通过此接口（DescribeFlowApprovers）查询流程参与者信息。
    
    Parameters:
    
    req - DescribeFlowApproversRequest
    
    Returns:
    
    DescribeFlowApproversResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFlowFiles
```
public DescribeFlowFilesResponse DescribeFlowFiles(DescribeFlowFilesRequest req)
                                            throws TencentCloudSDKException
```
    查询流程文件
    
    Parameters:
    
    req - DescribeFlowFilesRequest
    
    Returns:
    
    DescribeFlowFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSeals
```
public DescribeSealsResponse DescribeSeals(DescribeSealsRequest req)
                                    throws TencentCloudSDKException
```
    此接口（DescribeSeals）用于查询指定ID的印章信息。
    
    Parameters:
    
    req - DescribeSealsRequest
    
    Returns:
    
    DescribeSealsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSubOrganizations
```
public DescribeSubOrganizationsResponse DescribeSubOrganizations(DescribeSubOrganizationsRequest req)
                                                          throws TencentCloudSDKException
```
    此接口（DescribeSubOrganizations）用于查询子机构信息。注：此接口仅可查询您所属机构应用号创建的子机构信息，不可跨应用/跨机构查询。
    
    Parameters:
    
    req - DescribeSubOrganizationsRequest
    
    Returns:
    
    DescribeSubOrganizationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsers
```
public DescribeUsersResponse DescribeUsers(DescribeUsersRequest req)
                                    throws TencentCloudSDKException
```
    此接口（DescribeUsers）用于查询应用号下的个人用户信息。注：此接口仅可查询您所属机构应用号创建的个人用户信息，不可跨应用/跨机构查询。
    
    Parameters:
    
    req - DescribeUsersRequest
    
    Returns:
    
    DescribeUsersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DestroyFlowFile
```
public DestroyFlowFileResponse DestroyFlowFile(DestroyFlowFileRequest req)
                                        throws TencentCloudSDKException
```
    通过此接口（DestroyFlowFile）可删除指定流程中的合同文件。注：调用此接口前，请确保此流程已属于归档状态。您可通过查询流程信息接口（DescribeFlow）进行查询。
    
    Parameters:
    
    req - DestroyFlowFileRequest
    
    Returns:
    
    DestroyFlowFileResponse
    
    Throws:
    
    TencentCloudSDKException
  - GenerateOrganizationSeal
```
public GenerateOrganizationSealResponse GenerateOrganizationSeal(GenerateOrganizationSealRequest req)
                                                          throws TencentCloudSDKException
```
    生成企业电子印章
    
    Parameters:
    
    req - GenerateOrganizationSealRequest
    
    Returns:
    
    GenerateOrganizationSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - GenerateUserSeal
```
public GenerateUserSealResponse GenerateUserSeal(GenerateUserSealRequest req)
                                          throws TencentCloudSDKException
```
    此接口（GenerateUserSeal）用于生成个人签名图片。注意： 1. 个人签名由用户注册时预留的姓名信息生成，不支持自定义签名内容。 2. 个人用户仅支持拥有一个系统生成的电子签名。
    
    Parameters:
    
    req - GenerateUserSealRequest
    
    Returns:
    
    GenerateUserSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyOrganizationDefaultSeal
```
public ModifyOrganizationDefaultSealResponse ModifyOrganizationDefaultSeal(ModifyOrganizationDefaultSealRequest req)
                                                                    throws TencentCloudSDKException
```
    此接口 (ModifyOrganizationDefaultSeal) 用于重新指定企业默认印章。
    
    Parameters:
    
    req - ModifyOrganizationDefaultSealRequest
    
    Returns:
    
    ModifyOrganizationDefaultSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySeal
```
public ModifySealResponse ModifySeal(ModifySealRequest req)
                              throws TencentCloudSDKException
```
    此接口（ModifySeal）用于修改指定印章ID的印章图片和名称。注：印章类型暂不支持修改，如需调整，请联系客服经理或通过创建印章接口（CreateSeal）进行创建新印章。
    
    Parameters:
    
    req - ModifySealRequest
    
    Returns:
    
    ModifySealResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubOrganizationInfo
```
public ModifySubOrganizationInfoResponse ModifySubOrganizationInfo(ModifySubOrganizationInfoRequest req)
                                                            throws TencentCloudSDKException
```
    此接口（ModifySubOrganizationInfo）用于更新子机构信息。注：若修改子机构名称或更新机构证件照片，需要重新通过子机构实名接口（VerifySubOrganization）进行重新实名。
    
    Parameters:
    
    req - ModifySubOrganizationInfoRequest
    
    Returns:
    
    ModifySubOrganizationInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyUser
```
public ModifyUserResponse ModifyUser(ModifyUserRequest req)
                              throws TencentCloudSDKException
```
    此接口（ModifyUser）用于更新个人用户信息。注：若修改用户姓名，需要重新通过个人用户实名接口（VerifyUser）进行重新实名。
    
    Parameters:
    
    req - ModifyUserRequest
    
    Returns:
    
    ModifyUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyUserDefaultSeal
```
public ModifyUserDefaultSealResponse ModifyUserDefaultSeal(ModifyUserDefaultSealRequest req)
                                                    throws TencentCloudSDKException
```
    此接口 (ModifyUserDefaultSeal) 用于重新指定个人默认印章。
    
    Parameters:
    
    req - ModifyUserDefaultSealRequest
    
    Returns:
    
    ModifyUserDefaultSealResponse
    
    Throws:
    
    TencentCloudSDKException
  - RejectFlow
```
public RejectFlowResponse RejectFlow(RejectFlowRequest req)
                              throws TencentCloudSDKException
```
    此接口（RejectFlow）用于用户拒绝签署合同流程。
    
    Parameters:
    
    req - RejectFlowRequest
    
    Returns:
    
    RejectFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendFlow
```
public SendFlowResponse SendFlow(SendFlowRequest req)
                          throws TencentCloudSDKException
```
    此接口（SendFlow）用于指定签署者及签署内容，后续可通过生成签署接口（CreateSignUrl）获取签署url。
    
    Parameters:
    
    req - SendFlowRequest
    
    Returns:
    
    SendFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendFlowUrl
```
public SendFlowUrlResponse SendFlowUrl(SendFlowUrlRequest req)
                                throws TencentCloudSDKException
```
    发送流程并获取签署URL
    
    Parameters:
    
    req - SendFlowUrlRequest
    
    Returns:
    
    SendFlowUrlResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendSignInnerVerifyCode
```
public SendSignInnerVerifyCodeResponse SendSignInnerVerifyCode(SendSignInnerVerifyCodeRequest req)
                                                        throws TencentCloudSDKException
```
    此接口用于发送签署验证码
    
    Parameters:
    
    req - SendSignInnerVerifyCodeRequest
    
    Returns:
    
    SendSignInnerVerifyCodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - SignFlow
```
public SignFlowResponse SignFlow(SignFlowRequest req)
                          throws TencentCloudSDKException
```
    此接口（SignFlow）可用于对流程文件进行签署。
    
    Parameters:
    
    req - SignFlowRequest
    
    Returns:
    
    SignFlowResponse
    
    Throws:
    
    TencentCloudSDKException
  - UploadFiles
```
public UploadFilesResponse UploadFiles(UploadFilesRequest req)
                                throws TencentCloudSDKException
```
    此接口（UploadFiles）用于文件上传。
    
    Parameters:
    
    req - UploadFilesRequest
    
    Returns:
    
    UploadFilesResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifySubOrganization
```
public VerifySubOrganizationResponse VerifySubOrganization(VerifySubOrganizationRequest req)
                                                    throws TencentCloudSDKException
```
    此接口（VerifySubOrganization）用于通过子机构的实名认证。注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
    
    Parameters:
    
    req - VerifySubOrganizationRequest
    
    Returns:
    
    VerifySubOrganizationResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyUser
```
public VerifyUserResponse VerifyUser(VerifyUserRequest req)
                              throws TencentCloudSDKException
```
    第三方应用可通过此接口（VerifyUser）将腾讯电子签个人用户的实名认证状态设为通过。注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
    
    Parameters:
    
    req - VerifyUserRequest
    
    Returns:
    
    VerifyUserResponse
    
    Throws:
    
    TencentCloudSDKException

Class EssbasicClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

EssbasicClient

EssbasicClient

Method Detail

ArchiveFlow

CancelFlow

CheckBankCard2EVerification

CheckBankCard3EVerification

CheckBankCard4EVerification

CheckBankCardVerification

CheckFaceIdentify

CheckIdCardVerification

CheckMobileAndName

CheckMobileVerification

CheckVerifyCodeMatchFlowId

CreateFaceIdSign

CreateFlowByFiles

CreateH5FaceIdUrl

CreatePreviewSignUrl

CreateSeal

CreateServerFlowSign

CreateSignUrl

CreateSubOrganization

CreateSubOrganizationAndSeal

CreateUser

CreateUserAndSeal

DeleteSeal

DescribeCatalogApprovers

DescribeCatalogSignComponents

DescribeCustomFlowIds

DescribeCustomFlowIdsByFlowId

DescribeFaceIdPhotos

DescribeFaceIdResults

DescribeFileIdsByCustomIds

DescribeFileUrls

DescribeFlow

DescribeFlowApprovers

DescribeFlowFiles

DescribeSeals

DescribeSubOrganizations

DescribeUsers

DestroyFlowFile

GenerateOrganizationSeal

GenerateUserSeal

ModifyOrganizationDefaultSeal

ModifySeal

ModifySubOrganizationInfo

ModifyUser

ModifyUserDefaultSeal

RejectFlow

SendFlow

SendFlowUrl

SendSignInnerVerifyCode

SignFlow

UploadFiles

VerifySubOrganization

VerifyUser