Database ID Validation Api and Response Code List

Here are the Database ID Validation Request Api Sample:

curl -X POST \
-H "X-ADVAI-KEY: {Your Access Key}" \
-H "Content-Type: application/json" \
-D '{
        "birthPlace":"Shanghai",
        "name":"KRISTIN EKA DAMAYANTI",
        "idNumber":"1771045810910002",
        "birthDate":"1991-10-18",
        "address":"KP KALAHANG TEAAAH"
        "faceImage": "iVjfkldsajl......"
    }' \
"https://api.advance.ai/openapi/face-identity/v2/database-id-validation"

Request:

faceImage	`string` faceImage: String, Selfie image in Base64 format. Minimum resolution of 400 x 400. Maximum resolution of 4096 x 4096, with size less than 2mb
idNumber	`string` The NIK number of the person; should be 16-digits number only; no negative number allowed; no float number allowed; cannot be empty; cannot start with 0
name	`string` `optional` Individuals name based on KTP registered.
birthPlace	`string` `optional` Individuals birth place based on KTP registered.
birthDate	`string` `optional` Individuals birth date based on KTP registered in yyyy-MM-dd format
address	`string` `optional` Individuals address based on KTP registered

Response :

code	Response 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	`idNumber` : registered or not_registered
	`facePercent` the similarity between the input face image and the found face image in our system,the range is 0.0 to 100.0. A rate closer to 100.0 indicates a higher similarity between the two faces.
	`name` : The verification result is a score percentage (0 - 100). If the name input is matched, it will return a high percentage, and vice versa. Return null if not provided
	`birthDate` :true or false. The birthDate is correct or not. Return null if not provided
	`birthPlace` : The verification result is a score percentage (0 - 100). If the birthPlace input is matched, it will return a high percentage, and vice versa. Return null if not provided
	`address` : The verification result is a score percentage (0 - 100). If the address input is matched, it will return a high percentage, and vice versa. Return null if not provided
extra	Extra response info (Exception Message)

Status Code:

Our API responses will contain a Status Code indicating the result of the API call, whether it was successful, or an error occurred during the process
Each API will also have its own unique Status Codes that can only be found in the responses of the API
Your API usage will be charged based on the response Status Code, each Status Code listed in our API document will have either a free or pay tag with it
free means you will not be charged and paymeans that you will be charged
pay means you will be charged if the API response contains the said status code
Below are the commonly used Status Codes, these status codes could appear in all our API responses, so please remember to add a handler for these Status Codes

Status Code	Message
`SUCCESS`	`pay` OK
`ERROR`	`free` Server error
`EMPTY_PARAMETER_ERROR`	`free` Parameter should not be empty
`INSUFFICIENT_BALANCE`	`free` Insufficient balance, please top up or contact your sales manager for help
`SERVICE_BUSY`	`free` Messages may look like: Rate limit is exceeded, please retry after the suggested time in HTTP Header. Retry-After :10s p.s. Please also note that this code may migrate to HTTP 429 Too Many Requests in the future. Quota exceeded: You have exceeded the daily quota for free queries, please contact out tech support for help
`IAM_FAILED`	`free` Access denied. Messages may look like: You are not authorized by the Identity and Access Management system Access Key not found Token not found or expired Access Key not found or expired Account not authorized for this country Account not authorized for this domain Account is expired. Please contact your sales manager for help Account is disabled. Please contact your sales manager for help
`PARAMETER_ERROR`	`free` The message is detailed error description, may includes: Parameter should not be empty Invalid phone number, please check your phone number format etc. p.s. Mobile number format should be country code + phone number(without leading 0 or dash or space e.g. +xx12345678); fixed-line number should be country code + area code + number(without leading 0)
`OVER_QUERY_LIMIT`	`free` Messages may look like: Quota exceeded. you have exceeded free query quota, please contact your sales manager for help Quota exceeded: You have exceeded free query quota for test account, please contact your sales manager for help
`CLIENT_ERROR`	`free` HTTP client error. Messages may look like: HTTP 400 - Bad Request HTTP 404 - Not Found HTTP 405 - Method Not Allowed etc. If you get this error, please check the API document or contact our tech support for help.
`RETRY_LATER`	`free` Query failed, please retry after the suggested time in HTTP Header. Retry-After :10s

Status info Body Error Code:

Code	Description
200	Success
1001	invalid parameter
1002	data source not found
1003	external source timeout
1004	external source error
1005	internal server error
1006	data source not valid (the data is there but can't display where is the data of the dead, double or inactive data)

Database ID Validation Api and Response Code List

Articles in this section

Comments