DescribeCrossBorderCompliance

Last updated: 2021-07-06 16:39:16

    1. API Description

    Domain name for API request: vpc.tencentcloudapi.com.

    This API is used to query the compliance review requests created by the user.
    A service provider can query all review requests created by any APPID under its account. Other users can only query their own review requests.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeCrossBorderCompliance.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    ServiceProvider No String (Exact match) Service provider. Valid values: UNICOM.
    ComplianceId No Integer (Exact match) ID of compliance review request.
    Company No String (Fuzzy match) Company name.
    UniformSocialCreditCode No String (Fuzzy match) Unified Social Credit Code.
    LegalPerson No String (Fuzzy match) Legal person.
    IssuingAuthority No String (Fuzzy match) Issuing authority.
    BusinessAddress No String (Fuzzy match) Business address.
    PostCode No Integer (Exact match) Zip code.
    Manager No String (Fuzzy match) Operator.
    ManagerId No String (Exact match) Operator ID card number.
    ManagerAddress No String (Fuzzy match) Operator address.
    ManagerTelephone No String (Exact match) Operator phone number.
    Email No String (Exact match) Email.
    ServiceStartDate No String (Exact match) Service start date, such as 2020-07-28.
    ServiceEndDate No String (Exact match) Service end date, such as 2020-07-28.
    State No String (Exact match) Status. Valid values: PENDING, APPROVED, and DENY.
    Offset No Integer The offset value
    Limit No Integer Quantity of returned items

    3. Output Parameters

    Parameter Name Type Description
    CrossBorderComplianceSet Array of CrossBorderCompliance List of compliance review requests.
    TotalCount Integer Total number of compliance review requests.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a compliance review request

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeCrossBorderCompliance
    &ServiceProvider=UNICOM
    &Company=Guangzhou Tencent Technology Co., Ltd
    &UniformSocialCreditCode=91440101327598294H
    &LegalPerson=Zhang Ying
    &IssuingAuthority=Guangzhou Haizhu District Administration for Market Regulation
    &BusinessAddress=Commercial Street F5-1, No. 397-72, Middle Xingang Road, Haizhu District, Guangzhou City, China
    &PostCode=510320
    &Manager=Tom
    &ManagerId=360732199007108888
    &ManagerAddress=No. 8888, Middle Xingang Road, Haizhu District, Guangzhou City, China
    &ManagerTelephone=020-81167888
    &Email=test@tencent.com
    &ServiceStartDate=2020-07-29
    &ServiceEndDate=2021-07-29
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "CrossBorderComplianceSet": [
        {
          "ComplianceId": 10013,
          "ServiceProvider": "UNICOM",
          "Company": "Guangzhou Tencent Technology Co., Ltd",
          "UniformSocialCreditCode": "91440101327598294H",
          "LegalPerson": "Zhang Ying",
          "IssuingAuthority": "Guangzhou Haizhu District Administration for Market Regulation",
          "BusinessLicense": "https://cross-border-connection-1258344699.cos.ap-guangzhou.myqcloud.com/BusinessLicense.png?q-sign-algorithm=sha1&q-ak=AKIDLYWGm2QAuUZP1NqFm6OaEcjaCYkVuMRF&q-sign-time=1596446068%3B1596449728&q-key-time=1596446068%3B1596449728&q-header-list=&q-url-param-list=&q-signature=d6f3d34ec6cdb4e7a84b29d96ebab0ceb649e441",
          "BusinessAddress": "Commercial Street F5-1, No. 397-72, Middle Xingang Road, Haizhu District, Guangzhou City, China",
          "PostCode": 510320,
          "Manager": "Tom",
          "ManagerId": "360732199007108888",
          "ManagerIdCard": "https://cross-border-connection-1258344699.cos.ap-guangzhou.myqcloud.com/ManagerIdCard.png?q-sign-algorithm=sha1&q-ak=AKIDLYWGm2QAuUZP1NqFm6OaEcjaCYkVuMRF&q-sign-time=1596446068%3B1596449728&q-key-time=1596446068%3B1596449728&q-header-list=&q-url-param-list=&q-signature=0eef108d574b332046de78b260c84844159b1fc1",
          "ManagerAddress": "No. 8888, Middle Xingang Road, Haizhu District, Guangzhou City, China",
          "ManagerTelephone": "020-81167888",
          "Email": "test@tencent.com",
          "ServiceHandlingForm": "https://cross-border-connection-1258344699.cos.ap-guangzhou.myqcloud.com/ServiceHandlingForm.png?q-sign-algorithm=sha1&q-ak=AKIDLYWGm2QAuUZP1NqFm6OaEcjaCYkVuMRF&q-sign-time=1596446068%3B1596449728&q-key-time=1596446068%3B1596449728&q-header-list=&q-url-param-list=&q-signature=8083e838f07cbc5db0d8604962c2148067604311",
          "AuthorizationLetter": "https://cross-border-connection-1258344699.cos.ap-guangzhou.myqcloud.com/AuthorizationLetter.png?q-sign-algorithm=sha1&q-ak=AKIDLYWGm2QAuUZP1NqFm6OaEcjaCYkVuMRF&q-sign-time=1596446068%3B1596449728&q-key-time=1596446068%3B1596449728&q-header-list=&q-url-param-list=&q-signature=e66ea70810c159dcd2c4fe576194e87ea4e11fbb",
          "SafetyCommitment": "https://cross-border-connection-1258344699.cos.ap-guangzhou.myqcloud.com/SafetyCommitment.png?q-sign-algorithm=sha1&q-ak=AKIDLYWGm2QAuUZP1NqFm6OaEcjaCYkVuMRF&q-sign-time=1596446068%3B1596449728&q-key-time=1596446068%3B1596449728&q-header-list=&q-url-param-list=&q-signature=991615e1b56f1ab107f6840dd7bfe20230825f55",
          "ServiceStartDate": "2020-07-29",
          "ServiceEndDate": "2021-07-29",
          "State": "PENDING",
          "CreatedTime": "2020-08-03 16:59:45"
        }
      ],
      "TotalCount": 1,
      "RequestId": "c3e0aa8b-5dce-467d-a63f-242126b3eabf"
    }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter A parameter error occurred.
    InvalidParameterValue.Range The parameter value is not in the specified range.