tencent cloud

All product documents
APIs
DocumentationAPIsOptical Character RecognitionCard and Document OCR APIsRecognizeIndonesiaIDCardOCR
RecognizeIndonesiaIDCardOCR
Last updated: 2024-06-13 18:18:15
RecognizeIndonesiaIDCardOCR
Last updated: 2024-06-13 18:18:15

1. API Description

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

This API is used to recognize an Indonesian identity card.

The API request rate is limited to 20 requests/sec by default.

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 Params. The value used for this API: RecognizeIndonesiaIDCardOCR.
Version Yes String Common Params. The value used for this API: 2018-11-19.
Region No String Common Params. This parameter is not required for this API.
ImageBase64 No String The Base64-encoded value of an image.
Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
Either the ImageUrl or ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.
ImageUrl No String The URL of the image.
Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
We recommend that you store the image in Tencent Cloud for higher download speed and stability.
For a non-Tencent Cloud URL, the download speed and stability may be affected.
ReturnHeadImage No Boolean Whether to return the identity photo.
Scene No String The scene, which defaults to V1.
Valid values:
V1
V2

3. Output Parameters

Parameter Name Type Description
NIK String The Single Identity Number.
Nama String The full name.
TempatTglLahir String The place and date of birth.
JenisKelamin String The gender.
GolDarah String The blood type.
Alamat String The address.
RTRW String The street.
KelDesa String The village.
Kecamatan String The region.
Agama String The religion.
StatusPerkawinan String The marital status.
Perkerjaan String The occupation.
KewargaNegaraan String The nationality.
BerlakuHingga String The expiry date.
IssuedDate String The issue date.
Photo String The photo.
Provinsi String The province, which is supported when the value of Scene is V2.
Kota String The city, which is supported when the value of Scene is V2.
WarnCardInfos Array of Integer Card Warning Information

-9101 Alarm for covered certificate,
-9102 Alarm for photocopied certificate,
-9103 Alarm for photographed certificate,
-9107 Alarm for reflective certificate,
-9108 Alarm for blurry image,
-9109 This capability is not enabled.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 RecognizeIndonesiaIDCardOCR

This example shows you how to recognize an Indonesian identity card.

Input Example

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeIndonesiaIDCardOCR
<Common request parameters>

{
    "ReturnHeadImage": "false",
    "ImageUrl": "https://xx/a.jpg"
}

Output Example

{
    "Response": {
        "Agama": "ATHOLIK",
        "Alamat": "BANJARSARI",
        "BerlakuHingga": "SEUMUR HIDUP",
        "GolDarah": "O",
        "IssuedDate": "15-05-2015",
        "JenisKelamin": "LAKEI AKI",
        "Kecamatan": "",
        "KelDesa": "PAKEMBINANGUN",
        "KewargaNegaraan": "INM",
        "NIK": "360000000006",
        "Nama": "",
        "Perkerjaan": "KARYAWAN SWASTA",
        "Photo": "",
        "RTRW": "00/000",
        "RequestId": "0000-0000-0000-0001",
        "StatusPerkawinan": "KAWFN",
        "TempatTglLahir": "JAKARTA 13-01-1987",
        "Provinsi": "DKI JAKARTA",
        "Kota": "DKI JAKARTA"
    }
}

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
FailedOperation.DownLoadError File download failed.
FailedOperation.ImageDecodeFailed Image decoding failed.
FailedOperation.OcrFailed OCR failed.
FailedOperation.UnKnowError Unknown error.
FailedOperation.UnOpenError The service is not activated.
FailedOperation.WarningServiceFailed
InvalidParameter.EngineImageDecodeFailed Image decoding failed.
InvalidParameterValue.InvalidParameterValueLimit Incorrect parameter value.
LimitExceeded.TooLargeFileError The file is too large.
ResourcesSoldOut.ChargeStatusException Exceptional billing status.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon