All Products
Search

This Product

    ID Verification:CREDENTIAL_DETECT

    Document Center

    ID Verification:CREDENTIAL_DETECT

    Last Updated:Sep 10, 2026

    This topic describes the Credential Detection API, which analyzes credential images for risks such as forgery, tampering, screenshots, and photos of screens.

    API information

    • API name: CredentialVerifyIntl

    • Description: Detects risks such as forgery, tampering, screenshots, and photos of screens in credential images.

    • Request method: POST

    • Protocol: HTTPS

    • QPS limit: Each API has its own QPS limit. For more information, see QPS limits of ID Verification server-side APIs.

    • Service address:

      Note

      • Benefits of internal network access: An internal network is a private communication network connecting Alibaba Cloud products within the same region. If your application server is deployed in the same region, use the internal endpoint to access the ID Verification service for enhanced security and stability.

      • Optimizing overseas access: Overseas network environments can be complex. Refer to Optimize server network latency to tune your integration and reduce network latency and request failures.

      Asia Pacific SE 1 (Singapore)

      • Public endpoint: cloudauth-intl.ap-southeast-1.aliyuncs.com

      • Internal endpoint: cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com

    Note

    1. Credential Detection is an AI-powered predictive service. It achieves a 90% accuracy rate on our internal test dataset. The actual accuracy may vary based on specific scenarios and image samples.

    2. The service is more effective at detecting manipulations in images captured by a camera compared to digitally generated or edited images.

    3. The detection result is not the sole basis for determining a credential's authenticity. Use it as a supplementary tool to improve manual review efficiency.

    4. Credential Detection is widely used in electronic document review for scenarios such as payment acquiring and e-commerce merchant onboarding. It effectively improves the efficiency of manual review. If you have requirements for other use cases, contact your account manager.

    Online debugging and integration

    Note

    Before debugging and integration, read the Use OpenAPI document to learn how to call APIs on the OpenAPI platform and obtain the SDK.

    You can use OpenAPI Explorer to debug this API online and generate an SDK code example.

    Request parameters

    The image specified by the ImageUrl or ImageFileObject parameter must meet the following requirements:

    • Image format: PNG, JPG, JPEG, BMP, and WebP.

    • Image dimensions: The width and height of the image must be greater than 15 pixels and less than 8192 pixels. The aspect ratio must be less than 50.

      Note

      For optimal detection results, we recommend that both the width and height of the image are greater than 500 pixels.

    • Image size: The image file must not exceed 10 MB when using ImageUrl or 3 MB when using ImageFileObject.

      Note

      Large images can increase API response time. We recommend using images smaller than 3 MB.

    Parameter

    Type

    Required

    Description

    Example

    CredType

    String

    Yes

    The credential type. Valid values:

    • 03: Enterprise qualification

    • 04: Transaction proof

    03

    CredName

    String

    Yes

    The credential name, specified by a numeric code. Valid values:

    • Starts with 03 for enterprise qualification:

      • 0301: Business license in the Chinese mainland

    • Starts with 04 for transaction proof:

      • 0401: Bank transaction record

      • 0402: Pay slip

      • 0403: Utility bill

      • 0405: Credit card bill

      • 0499: Other

    Note

    If you require support for additional credential types, contact your account manager.

    0301

    ProductCode

    String

    Yes

    The invocation mode. Valid value:

    • ANTI_FAKE_CHECK: Image quality check and tampering detection.

    ANTI_FAKE_CHECK

    ImageUrl

    String

    Yes

    Important

    Specify either the ImageUrl or ImageFileObject parameter.

    The URL of the image.

    https://example.com/test.jpg

    ImageFileObject

    InputStream

    The image file stream.

    To upload a file using this parameter, you must call the Advance API operation and pass a valid InputStream object. For more information, see Special scenario: Configure the Advance API for file uploads.

    An InputStream object that represents the image.

    Response parameters

    Parameter

    Type

    Description

    Example

    RequestId

    String

    The request ID.

    130A2C10-B9EE-4D84-88E3-5384********

    Code

    String

    The response code. For more information, see Server-side HTTP status codes.

    Important

    • This parameter indicates whether the API call was successful.

    • Check the fields in the ResultObject for the business verification result.

    Success

    Message

    String

    A detailed description of the response code.

    success

    ResultObject

    Result

    String

    • 0: Low-risk

    • 1: High-risk

    • 2: Suspicious

    1

    RiskTag

    String

    The risk tag. Multiple tags are separated by commas (,). Valid values:

    • PS: Edited image

    • SCREEN_PHOTO: Photo of a screen

    • SCREENSHOT: Screenshot

    • ORIGINAL_PHOTO: Non-original image

    PS

    RiskScore

    Map<String,String>

    The predicted risk score for each risk tag. Values range from 0 to 1. A higher score indicates a greater likelihood of the corresponding risk.

    {
  "PS": "0.0211",
  "SCREEN_PHOTO": "0.0101",
  "SCREENSHOT": "0.0521",
  "ORIGINAL_PHOTO": "0.0861"
}

    MaterialInfo

    String

    Other information. This parameter is reserved.