/extractFacial

Description

Service that performs face detection and validation from an open or tokenized image.

Request:

curl --location '{IDENTITY_API_BASE_URL}/services/extractFacial' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
  "tokenBuffer": "{TOKEN_BUFFER}"
}'

Request parameters:

Parameter	Type (Content)	Required	Description
tokenBuffer	String (Base64)	Yes	Base64 encoded or tokenized image for face detection.

Example response:

{
    "serviceResultCode": 0,
    "serviceResultLog": "Service request successfully processed",
    "serviceTime": "864",
    "serviceFacialExtractionResult": "{\"faceConfidence\":0.9999948143959045,\"age\":30,\"glasses\":\"None\",\"gender\":\"Male\",\"iod\":154}",
    "serviceTransactionId": "b2f6297b-01ca-4aa3-afd7-6cb3c9d74141"
}

Response fields:

Identifier	Type	Description
serviceResultCode	Integer	Code indicating the overall result of the service execution.
serviceResultLog	String	Descriptive field of the result or error message if any.
serviceTime	String	Processing time of the request.
serviceTransactionId	String	Transaction ID associated with the request processed by the API.
serviceFacialExtractionResult	JSON	Object representing face detection and validation.
age	Integer	Indicates the possible detected age.
glasses	String	Indicates glasses detection. Possible values: Eye, None, Sun
gender	String	Returns detected gender. Possible values: Male, Female, None
iod	Integer	Indicates interpupillary distance.
faceConfidence	Float	Indicates the confidence level of the evaluated face.

caution

Please note that all values returned are estimates based on the facial image provided. Actual accuracy and reliability may vary depending on the quality and characteristics of the input image.