Call this API to get the info of a face by id.

Request Example:

curl -X GET \
  https://sg-api.advance.ai/intl/openapi/face-search/facereferences?id=1 \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

https://sg-api.advance.ai/intl/openapi/face-search/facereferences
GET

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

Request Parameters

Parameter	Description
id	`string` the unique id of the face.

Response Description

Parameter	Description
code	`enum` Status Code.
transactionId	`string` The request id, the max length is 64.
pricingStrategy	`enum` Whether the request will be charged, enum type: `FREE`, `PAY`
message	`string` The error message used to debug.
data	`object` The face info. Refer to faceSet.
extra	`object` Extra response info (Exception Message).

face

Parameter	Description
id	`string` The unique id of face.
createdAt	`string` The create time of the faceSet. in the format of ISO 8601 .
lastUpdatedAt	`string` The last update time of the faceSet. in the format of ISO 8601 .
deletedAt	`string` The deleted time of the faceSet. in the format of ISO 8601 .
faceImageId	`string` The id of face image.
faceImageUrl	`string` The url of face image. The url will expire in one hour.
externalReferenceId	`string` The unique id used to track this request.
idNumber	`string` The identity number of face.
idCardType	`string` The identity card type of face.
country	`string` The alpha-2 country code. Refer to ISO ALPHA-2 Country Code .
name	`string` The name of this face.

Response Code

Status Code	Message
SUCCESS	`free` OK.
PARAMETER_ERROR	`free` Parameter error, please check your request whether has illegal parameters.
ERROR	`free` Server error.

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "id": "1",
        "createdAt": "2024-08-08T03:36:48.89",
        "lastUpdatedAt": "2024-08-08T03:36:49.297",
        "deletedAt": null,
        "faceImageId": "66b43d50d5f270562e9f0021.jpg",
        "faceImageUrl": "https://i.pinimg.com/236x/b5/78/1c/b5781c2dc5d552d3764b103987eb2fa6.jpg",
        "externalReferenceId": "8c028f02-7117-4af5-860f-b45c1a8b225a",
        "idNumber": "948",
        "idCardType": "y",
        "country": "BF",
        "name": "Mr. Alyce"
    },
    "extra": null
}

PARAMETER_ERROR

{
    "code": "PARAMETER_ERROR",
    "message": "Face not found, id: 1",
    "data": null,
    "extra": null,
    "pricingStrategy": "FREE"
}