Request

Please begin exploring the api guide using this reference guide (click here)

Please obtain Token from here

Image Quality Requirements

The services check and extract the necessary information from the uploaded images, hence please ensure the uploaded images satisfy the following criteria:

Is in one of the following image formats: PNG / JPG / JPEG
Below 2 MB file size
Minimum resolution of 256 x 256
Maximum resolution of 4096 x 4096

Response

Response Description

Parameter	Description
code	ID Forgery Detection Status Code
transactionId	the request id, the max length is 64
pricingStrategy	whether the request will be charged, enum type: FREE, PAY
message	Status Code Explanation
data	result : pass, this refers the test has passed, ID is not forged, result: fail, this refers the test has failed, ID is forged detail : It will be null if result is pass. If result is fail, reasons could include: poor_quality, photocopy, retake, screenshot
extra	Extra response info (Exception Message)

Response Code

Status code	Message
SUCCESS	-
NO_SUPPORTED_CARD	No supported card detected from the image
PARAMETER_ERROR	Parameter should not be empty Invalid image format,image format should be one of jpeg/jpg/png,and request content type should be image/jpeg or image/png Invalid image size,max image size should be less than 2M,and image dimension should be between 256 256 and 4096 4096 Timestamp error Signature error
ACCOUNT_DISABLED	Account Disabled
CLIENT_ERROR	HTTP 400 - Bad Request