OCR API V2.0

Base URL

Singapore: https://sg.apitd.net/verification/kyc/ocr/v1

API

URL	Request Methods	Content Type	Output Format	Character Set
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

Authentication

Parameter	Type	Description	Required/Optional	Notes
partner_code	String	Partner Code	Required	Assigned by TD
partner_key	String	Partner Key	Required	Assigned by TD

Request Parameter

Parameter	Type	Description	Required/Optional	Notes
image	String	ID card image	Required	Base64 encoded image character stream of JPG, JPEG, PNG, the image cannot exceed 2M
country	String	Country	Required	Two-digit country code (uppercase). Compliant with ISO 3166 standard, such as Mexico: MX
scene	String	Scene Type	Required	Enumeration:

name_id
name_phone_id
name_bank_card
name_id_bank_card
name_id_phone_bank_card | | options | String | Additional feature output | Optional | Enumeration:
images: to output document image, portraits, signature etc.
image_quality: to output image quality related parameters
document_forgery: Returns forgery detection parameters

Support multiple selections, separated by commas, for example: images, image_quality, document_forgery |

OCR Image Specifications and Requirements

Requirement Category	Specific Guidelines and Requirements
Document Placement	- Ensure the document is centered in the image, with all four edges clearly visible and not obscured or cropped.

Maintain the original aspect ratio of the document to avoid distortion.
Avoid using non-authentic online samples (such as images found on the internet), blurry photographs, incomplete document edges, or severely distorted images. | | Image Quality | - Capture the image in an environment with adequate and even lighting, avoiding direct strong light or shadows.
Use a single, preferably light-colored background without complex patterns or textures.
Ensure the test image is clear, without blurriness or overexposure issues. | | Image Specifications | - The file size of the image should ideally be between 100KB and 500KB to ensure fast upload speeds and efficient processing, while avoiding excessive compression that could degrade recognition quality. |

Examples of Acceptable Pictures:

Examples of Non-acceptable Pictures:

Response Parameter

Parameter	Type	Description	Notes
code	Integer	API status code
message	String	Status information	When the API is in an abnormal state, the specific abnormal reasons are returned
sequence_id	String	Unique response code	To track the unique identification of each request
result	String	Verification result	Enumeration:

success: if document type can be recognized, document is not expired, MRZ (if applicable) is valid and the format of text fields is valid
error: if any one of the above document type, expiry, MRZ and text fields check fails
not performed: checks are not performed | | status_info | Object | Verification details | Details of above result including verification details of document type, expiry, MRZ and text fields | | document_type_info | Object | Document type information | Default parameter | | card_info | Object | ID card information | OCR results for the identification document | | image_info | Object | Image information | Returned when related input parameter is selected | | image_quality_info | Object | Image quality information | Returned when related input parameter is selected | | document_forgery_info | Object | Document forgery detection | Returned when related input parameter is selected |

Data Objects

StatusInfo

Parameter	Type	Description	Notes
doc_type	Integer	Check whether the document type can be correctly identified	Refer to the CheckResult data dictionary
expiry	Integer	Check whether the document has expired	Refer to the CheckResult data dictionary
mrz	Integer	Check whether the MRZ (Machine Readable Zone) is correctly recognized	Refer to the CheckResult data dictionary
text	Integer	Check whether the text format of the fields on the document meets the requirements	Refer to the CheckResult data dictionary

Example:

{
    "doc_type": 1,
    "expiry": 0,
    "mrz": 1,
    "text": 1
}

DocumentTypeInfo

Parameter	Type	Description	Notes
document_name	String	Detailed document name
document_description	String	Document type	Identity Card, Passport, Driving License etc

Example:

{
    "document_name": "Philippines - ePassport (2016)",
    "document_description": "Passport"
}

API Status Code

Code	Message	Description
200	Success	Call Successfully
301	Service not purchased	No purchase of the service
302	Traffic blocked	Traffic blocked
303	Traffic insufficient	Traffic insufficient
304	Service expired	Service expired
305	Daily maximum volume reached	Daily maximum volume reached
12601	Detection failed	Cannot recognize this image
12602	Document detected as having bad quality	The document has been detected but the quality is low (Only applies to Indonesian OCR service)
11350	Internal error	Internal error
11301	`{parameter}` empty	`{parameter}` empty
11304	The country partner located is not open	The country partner located is not open
11340	`{parameter}` error	`{parameter}` error

Response Example

Request:

{
    "image": "/9j/4AAQSkZJRgABAQAAeAB4AAD/********XLiqqauzsw1J3sf/2Q==",
    "country": "GB",
    "scene": "Ocr",
    "options": "images,image_quality,document_forgery"
}

Success (Indonesian):

{
    "result": "success",
    "code": 200,
    "sequence_id": "1721890950247464I31676CAC******",
    "message": "success",
    "card_info": {
        "birthday": "26-05-19**",
        "address": "KP.C****",
        "occupation": "WIRA****",
        "gender": "LAKI-LAKI",
        "city": "KABU****",
        "expiry_date": "SE****",
        "issue_location": "B****",
        "religion": "IS****",
        "nik": "327****60577****",
        "marital_status": "KAWIN",
        "birthplace": "BA****",
        "nationality": "WN****",
        "issue_date": "28-02-20**",
        "province": "JAWA****",
        "street": "MEGAMEND****",
        "blood_type": "-",
        "name": "M.TAUFAN****",
        "village": "CIPAY****",
        "rt_rw": "005/****"
    },
    "document_forgery_info": {
        "result": "fail",
        "detail": [
            "black_white_print"
        ]
    }
}