ID Verification:CheckResult

API

• API name: CheckResult

• Request method: HTTPS POST

• Description: When the server-side receives a callback indicating that authentication is complete, call this API to retrieve the corresponding authentication status and information. This callback is sent when the client result code is 1001 or 1002. For more information, see Native SDK client result codes and sub-codes.

  Important

  The ID Verification service stores verification results for 30 days by default. Please retrieve them within this period, as they are automatically deleted afterward.

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

• Service endpoints

  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

  Asia Pacific SE 5 (Jakarta)

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

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

  China (Hong Kong)

  • Public endpoint: cloudauth-intl.cn-hongkong.aliyuncs.com

  • Internal endpoint: cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

  Asia Pacific SE 3 (Kuala Lumpur)

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

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

Online debugging and integration

You can use OpenAPI Explorer to directly call this API for debugging and generate SDK code examples.

Usage notes

1. Transaction ID storage: The TransactionId is the only trusted identifier for a server-side verification record. You must bind it to a business ID and store it persistently on your server.

2. Log retention and compliance: Verification result logs are stored for 30 days by default and are automatically deleted afterward. You must query the results within this period and store the relevant data according to your compliance requirements.

3. Conditions for returning the authentication image: The authentication image is returned only if IsReturnImage=Y and the face scan is successful. Because the Base64 content is large, keep the default value N if you do not need to display or store the image.

4. Logic for determining the authentication result: Code=Success only indicates that the API call was successful. The final authentication result is determined by the Result.Passed and Result.SubCode fields.

5. Fault tolerance for OCR field parsing: The OCR fields, number of document pages, and face attributes may vary based on the document type, regional capabilities, and SDK configuration. Your client must handle missing or newly added fields during parsing.

Field distribution

The CheckResult main return structure, liveness result, and OCR result fields are the same for both App SDK and Web SDK integrations.

Request parameters

Response parameters

{
  "ocrIdInfoData": {
    "01": {
      "ocrIdInfo": {
        "id_number": "083****767",
        "full_name": "MAC *** NG",
        "nationality": "Việt Nam",
        "date_of_expiry": "",
        "date_of_birth": "10/10/1999",
        "sex": "Nam"
      },
      "ocrIdPassed": "Y",
      "spoofInfo": {
        "spoofResult": "N"
      }
    },
    "02": {
      "ocrIdInfo": {
        "date_of_issue": "10/10/2022",
        "personal_identification": "Sẹo **** phải"
      },
      "ocrIdPassed": "Y",
      "spoofInfo": {
        "spoofResult": "N"
      }
    }
  },
  "ocrIdPassed": "Y"
}

{
  "procedurePriority": "keep"
}

{
  "01": {
    "ocrIdPassed": "Y",
    "idImage": "Base64_placeholder",
    "ocrIdInfo": {
      "expiryDate": "2030.01.01",
      "englishName": "SUN, xxx",
      "originOfIssue": "National Immigration Administration of the People's Republic of China",
      "placeOfIssue": "Beijing",
      "sex": "Male",
      "name": "Sun x",
      "idNumber": "CGxxxxxxxx",
      "issueDate": "2024.12.01",
      "birthDate": "1992.12.01"
    },
    "spoofInfo": {
      "spoofResult": "N",
      "spoofType": []
    }
  }
}

{
  "expiryDate": "2026-01-02",
  "originOfIssue": "Exit-Entry Administration of the Ministry of Public Security",
  "englishName": "ZHANG SAN",
  "sex": "Male",
  "name": "Zhang San",
  "idNumber": "H11111115",
  "issueDate": "2013-01-02",
  "birthDate": "1990-02-21"
}

{
    "given_name_s": "HYUNEUI",
    "surname_s": "MUN",
    "date_of_expiry_s": "2028-02-08",
    "date_of_birth_s": "1988-10-26",
    "sex_s": "M"
}

{
  "expiryDate": "2030.01.01",
  "englishName": "SUN, xxx",
  "originOfIssue": "National Immigration Administration of the People's Republic of China",
  "placeOfIssue": "Beijing",
  "sex": "Male",
  "name": "Sun x",
  "idNumber": "CGxxxxxxxx",
  "issueDate": "2024.12.01",
  "birthDate": "1992.12.01"
}

{
 "spoofResult": "Y",
 "spoofType": ["SCREEN_REMARK"]
}

Result.ExtInfo

Result.SubCode subcodes