Skin analyze widget

curl --request POST 'https://core.getfaceage.com/api/v1/widget/skin-analyze/set-parameters' \
  --header 'Accept: application/json' \
  --form 'callbackUrl="https://www.your-domain.com/analyze-face-callback"' \
  --form 'faceAgeId="your_face_age_id"' \
  --form 'showCamera="true"' \
  --form 'showUpload="true"' \
  --form 'language="en"' \
  --form 'currency="$"' \
  --form 'gtag=""' \
  --form 'problems[0]="fineWrinkles"' \
  --form 'problems[1]="eyeWrinkles"'

{
  "status": true,
  "data": {
    "url": "https://panel.getfaceage.com/widget/skin-analyze?faceAgeId=your_face_age_id&type=skincare-analyzer&access=fineWrinkles,eyeWrinkles&showCamera=true&showUpload=true&showFacePoint=false&callbackUrl=your_callback_url"
  }
}

{
  "message": "Unauthenticated."
}

POST

widget

skin-analyze

set-parameters

curl --request POST 'https://core.getfaceage.com/api/v1/widget/skin-analyze/set-parameters' \
  --header 'Accept: application/json' \
  --form 'callbackUrl="https://www.your-domain.com/analyze-face-callback"' \
  --form 'faceAgeId="your_face_age_id"' \
  --form 'showCamera="true"' \
  --form 'showUpload="true"' \
  --form 'language="en"' \
  --form 'currency="$"' \
  --form 'gtag=""' \
  --form 'problems[0]="fineWrinkles"' \
  --form 'problems[1]="eyeWrinkles"'

{
  "status": true,
  "data": {
    "url": "https://panel.getfaceage.com/widget/skin-analyze?faceAgeId=your_face_age_id&type=skincare-analyzer&access=fineWrinkles,eyeWrinkles&showCamera=true&showUpload=true&showFacePoint=false&callbackUrl=your_callback_url"
  }
}

{
  "message": "Unauthenticated."
}

Use the skin analyze widget when you want Face Age as a hosted page instead of an embedded SDK — for example inside an iOS or Android app, or in an iframe.

Request a widget URL

Call this endpoint with your Face Age ID, your callback URL and the options you want. The response contains a widget URL.

Open the URL

Open the URL in your app’s web view, an iframe or a browser. The user takes a photo or uploads one, approves it, and the analysis starts.

Instructions and consent before the photo

Receive the results

The analysis results are shown to the user. When they click Done, Face Age sends the results and the uploaded photo to your callback URL.

Analysis results with skin age, skin health and concern masks

This endpoint does not use the secret key. It identifies your business with the Face Age ID from the API keys page of your business in the panel.

Body

Send the parameters as multipart/form-data.

string

required

URL where the analysis results are sent.

string

required

Your Face Age ID (API key), from the API keys page in the panel.

string

default:"en"

Language of the widget.

string

default:"$"

Currency symbol.

boolean

default:"true"

Allow users to take a photo with the camera.

boolean

default:"true"

Allow users to upload an image.

string

Google Analytics (GTM) ID to track the widget.

string[]

default:"all"

Skin issues to include in the analysis. Send as problems[0], problems[1], and so on.Options: fineWrinkles, eyeWrinkles, deepWrinkles, darkCircle, eyeBag, pores, pigment, redness, oiliness, dryness, sagginess, dullness, acne.

Response

boolean

true when the request succeeds.

string

Widget URL to open. Its query string carries your settings: faceAgeId, the selected problems (as access), showCamera, showUpload, showFacePoint and callbackUrl.

curl --request POST 'https://core.getfaceage.com/api/v1/widget/skin-analyze/set-parameters' \
  --header 'Accept: application/json' \
  --form 'callbackUrl="https://www.your-domain.com/analyze-face-callback"' \
  --form 'faceAgeId="your_face_age_id"' \
  --form 'showCamera="true"' \
  --form 'showUpload="true"' \
  --form 'language="en"' \
  --form 'currency="$"' \
  --form 'gtag=""' \
  --form 'problems[0]="fineWrinkles"' \
  --form 'problems[1]="eyeWrinkles"'

{
  "status": true,
  "data": {
    "url": "https://panel.getfaceage.com/widget/skin-analyze?faceAgeId=your_face_age_id&type=skincare-analyzer&access=fineWrinkles,eyeWrinkles&showCamera=true&showUpload=true&showFacePoint=false&callbackUrl=your_callback_url"
  }
}

{
  "message": "Unauthenticated."
}

Get started

Display modes

Analysis

Personalization

Integrations

Reference

Frameworks