Call this API to get a license.

Request Example:

curl -X POST \
-H "X-ACCESS-TOKEN: `{Your Access Token}`" \
-H "Content-Type: application/json" \
-d '{"licenseEffectiveSeconds": 600,"applicationId": "appId1,appId2" }' \
"https://api.advance.ai/openapi/liveness/v1/auth-license"

Request Url

https://api.advance.ai/openapi/liveness/v1/auth-license
POST (application/json)

https://sg-api.advance.ai/intl/openapi/face-identity/v1/auth-license
POST (application/json)

https://th-api.advance.ai/th/openapi/face-identity/v1/auth-license
POST (application/json)

https://my-api.advance.ai/my/openapi/face-identity/v1/auth-license
POST (application/json)

https://th-api.advance.ai/th/openapi/face-identity/v1/auth-license
POST (application/json)

https://ph-api.advance.ai/ph/openapi/face-identity/v1/auth-license
POST (application/json)

https://mex-api.advance.ai/mex/openapi/face-identity/v1/auth-license
POST (application/json)

https://col-api.advance.ai/col/openapi/face-identity/v1/auth-license
POST (application/json)

** The endpoint URI may vary by country.**

Request Header Parameters

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

Request Parameters

Parameter	Description
licenseEffectiveSeconds	`int` [Optional] The license effective period, defaults to 600 seconds, maximum 86400 seconds. Unit is seconds.
applicationId	`string` [Optional] The list of valid applicationId.

Response Description

Parameter	Description
code	H5 Document Verification Status Code
transactionId	The request id, the max length is 64
pricingStrategy	Always return `FREE` for this API
message	Status Code Explanation
data	`license` Authorization code within validity period
	`expireTimestamp` Expiration timestamp
	`expiredTime` Expiration timestamp
extra	Extra response info (Exception Message)

Response Code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Parameter error, please check you input.
ACCESS_DENIED	Access denied
SERVICE_DISABLED	Service disabled
ERROR	Server error

Response Examples

SUCCESS

{
    "code":"SUCCESS",
    "transactionId": "196eb0c777789e58",
    "pricingStrategy": "PAY",
    "message":"OK",
    "data":{
        "license":"jpgEkQQFKD+EXHBmIFLOycYOMkohFVyJzhfq5M0F95pp3EDcLf8Z31e4xqyeyhNXfW......",
        "expireTimestamp": 1603164618149
    },
    "extra":null
}

ACCESS_DENIED

{
     "code": "ACCESS_DENIED",
     "message": "Access denied",
     "transactionId": "eb0c771967789e58",
     "data": null,
     "extra": null,
     "pricingStrategy": "FREE"
}

SERVICE_DISABLED

{
     "code": "SERVICE_DISABLED",
     "message": "Service disabled",
     "transactionId": "789196eb0c777e58",
     "data": null,
     "extra": null,
     "pricingStrategy": "FREE"
}

ERROR

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