Call this API to start an Address Verification.

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/address-verification/start-verification \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}' \
  -d '{
    "callbackUrl": "https://www.example.com/callback",
    "bizId": "7ac66c0f148de9519b8bd264312c4d64", 
    "userId":"8e44f0089b076e18a718eb9ca3d94674",
    "region":"PHL",
    "proofFileBase64":"YWJjZGVmZw==", // use real image base64 string  
 		"firstName": "Thomas",
    "middleName": "Alva",
    "lastName": "Edison",
    "fullName": "Thomas Alva Edison"
    "bizCode":"WhiteCard"
}'

Request Url

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

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

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

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

https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/address-verification/start-verification
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 result is all completed (include Id forgery result).Max Length 2048 characters. 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` The unique userId to identify the user who is performing the Verification.
region	`string` The region of the service support, typically aligned with the address's residence. Refer to ISO ALPHA-3 Country Code
bizCode	`string` [Optional] The business type of the user. max size of the length is 32. only support characters a-zA-z0-9
proofFileBase64	`string` The proof file bytes encoded by Base64. Please provide either proofFileBase64 or proofFileUrl.
proofFileUrl	`string` The proof file url. Should not expire in 1 hour. Max Length 2048 characters. Please provide either proofFileBase64 or proofFileUrl.
proofFileBase64s	`array` An array of Base64-encoded images. Supports JPG/PNG/JPEG/WEBP formats, with a maximum of `5` images,and the total size of all images must not exceed 30MB.This field is `mutually exclusive` with the single-image fields (proofFileBase64 / proofFileUrl); passing them simultaneously will return an `PARAMETER_ERROR` error. This field can be passed together with proofFileUrls. If both are provided, proofFileBase64s `takes precedence`. If this field is empty or null, the system will fall back to proofFileUrls.
proofFileUrls	`array` An array of image URLs. The backend will download the images sequentially. Supports JPG/PNG/JPEG/WEBP formats, with a maximum of `5` images,and the total size of all images must not exceed 30MB. This field is `mutually exclusive` with the single-image fields (proofFileBase64 / proofFileUrl); passing them simultaneously will return an `PARAMETER_ERROR` error. If proofFileBase64s is also provided, it will `take precedence`, and this field will be ignored.
issueDate	`string` [Optional] The issue date of the proof, in the format of "yyyy-MM-dd", iles are valid for the last 3 months by default.
firstName	`string` [Optional] the first name.
middleName	`string` [Optional] the middle name.
lastName	`string` [Optional] the last name.
fullName	`string` [Optional] the full name.

Response Description

Parameter	Description
code	Response Code.
transactionId	The request id of this API call, the max length is 64.
pricingStrategy	`Deprecated` Always return `FREE`
message	Status Code Explanation
data	`signatureId`, the business id of this verification, need to be used in get-result API later.

Response Code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Parameter error, please check you input.
	Parameter should not be empty
	Region is wrong
	Invalid issueDate format. Expected yyyy-MM-dd
	No image found
	Invalid image format, image format should be one of jpeg/jpg/png/pdf
	Invalid image size, max image size should be less than 16M
	Invalid issue_day_window_months: 7. Supported: 3, 4, 5, 6.
ERROR	Server error

Response Examples

SUCCESS

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

REGION_WRONG

{
    "code":"REGION_WRONG",
    "message":"Region is wrong",
    "data":null,
    "extra":null,
    "transactionId":"0f74aeb4dd3f1d48",
    "pricingStrategy":"FREE"
}

PARAMETER_ERROR

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter error,please check you input.",
    "data":null,
    "extra":null,
    "transactionId":"ba134d6112c57a4c",
    "pricingStrategy":"FREE"
}

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter should not be empty",
    "data":null,
    "extra":null,
    "transactionId":"dfcdc346a81f404f",
    "pricingStrategy":"FREE"
}

ERROR Response

{
    "code":"ERROR",
    "message":"Server error",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"
}