Integration Guide for Global
Overview
The Global ID Forgery service involves two steps:
- Detection: Submit the relevant document images for verification purpose. You will receive the ifdid which would be used as the identifier for the second step. (click here)
- Query: Obtain the forgery detection result of the document by querying using the ifdid identifier. If forgery is detected, all detected forgery types will be listed in the result response (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
Step 1: Detection
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 | ifdid: An identifier for the service’s query |
| extra | Extra response info (Exception Message) |
Response Code
Status code | Message |
|---|---|
SUCCESS | OK |
NO_SUPPORTED_CARD | No supported card detected from the image |
PARAMETER_ERROR | Parameter should not be empty Unsupported country or region 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 |
Step 2: Query
Response Description
Parameter | Description |
|---|---|
code | 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, detail : It will be null if result is pass. If result is fail, reasons could include: poor quality, photocopy, retake, screenshot, edited, unsupported, others |
extra | Extra response info (Exception Message) |
Fail Reason
| Fail Value | Description |
|---|---|
| poor quality | The image of the card is not clearly visible, or the card is incomplete or compromised. |
| screenshot | The image is a screenshot. |
| retake | The image is taken from another screen. |
| photocopy | The image is a black and white , or color photocopy. |
| edited | The image of the card, or the information on the card has been edited or altered. |
| unsupported | The document type is not supported. |
| others | Document's authenticity is not verified for various reasons. |
Response Code
Status code | Message |
|---|---|
SUCCESS | OK |
PARAMETER_ERROR | Parameter should not be empty Timestamp error Signature error |
DETECTING | This record is being detected |
DETECTION_FAIL | Detection fail,please resubmit later |
NO_RECORD | No query record |
RETRY_LATER | Query failed,please retry after the suggested time in HTTP Header |
ACCOUNT_DISABLED | Account Disabled |
CLIENT_ERROR | HTTP 400 - Bad Request |
Updated about 1 month ago