Call this API to do a ID Verification without AAI's Frontend.

Request Example:

curl -X POST \
  https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/idv \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d '{
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64", 
"userId":"8e44f0089b076e18a718eb9ca3d94674",
"region":"THA",
"docType": "TH-ID-N",
"frontImageBase64":"YWJjZGVmZw==", // use real image base64 string
"faceImageBase64":"YWJjZGVmZw==", // use real image base64 string
"bizCode":"WhiteCard"
}'

Request Url

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/idv
POST (application/json)

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/idv
POST (application/json)

https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/idv
POST (application/json)

https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/idv
POST (application/json)

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token

Request Parameters

Parameter	Description
callbackUrl	`string` [Optional] The target URL to notify the caller after the H5 Identity Verification finished. Refer to Callback Notification.
bizId	`string` The unique business id to identify the business transaction that triggered this Identity Verification processing, such as order id.
userId	`string`[Optional] The unique userId to identify the user who is performing the Identity Verification.
region	`string` The region of the service support. Refer to ISO ALPHA-3 Country Code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
docType	`string`[Optional] suggests the docType that user may use. refer to Region and DocType.
frontImageBase64	`string` The front image of the document. Please provide either frontImageBase64 or frontImageUrl. Refer to Image Requriements.
frontImageUrl	`string` The front image of the document. Should not expire in 1 hour. Please provide either frontImageBase64 or frontImageUrl. Refer to Image Requriements .
backImageBase64	`string` The back image of the document. [Required] when the docType is two-sides. Please provide either backImageBase64 or backImageUrl. Refer to Image Requriements .
backImageUrl	`string` The back image of the document. Should be valid for at least 1 hour. Please provide either backImageBase64 or backImageUrl. Refer to Image Requriements .
faceImageBase64	`string` The face image that will compares with document image. Please provide either faceImageBase64 or faceImageUrl. Refer to Image Requriements .
faceImageUrl	`string` The face image that will compares with document image. Should be valid for at least 1 hour. Please provide either faceImageBase64 or faceImageUrl. Refer to Image Requriements .
bizCode	`string` [Optional ] The business type of the user. max size of the length is 32. only support characters a-zA-z0-9

Support Global Passport

Response Description

the response data structure is similar with Get Result API's Response.

Parameter	Description
code	Response's Status Code
transactionId	The request id, the max length is 64
pricingStrategy	`Deprecated`, Always return `FREE`
message	Status Code Explanation
data	`object` : the business result
extra	Extra response info (Exception Message)

Response.code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Parameter error, please check you input.
	Parameter should not be empty
	Region is wrong
	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
	The image download has exceeded 3 seconds. Please check the network and operate again.
ERROR	Server error.

Response.data

Field	Description
signatureId	`string`, the signatureId of this identity verification transaction.

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "signatureId":"f302f5d2454a85c2",
  },
  "extra": null,
  "transactionId": "d3fde1547eeaf226",
  "pricingStrategy": "FREE"
}

PARAMETER_ERROR

{
    "code":"PARAMETER\_ERROR",
    "message":"Region is wrong",
    "data":null,
    "extra":null,
    "transactionId":"b6d722f7e9f553ae",
    "pricingStrategy":"FREE"
}