Error codes

Reference for every error code returned by the Bodygram Platform when a scan fails — grouped by category, with guidance for each.

When a scan can't be completed, the Bodygram Platform API returns an error object on the Scan instead of measurements. This happens both when a CreateScanRequest fails to create a scan and when a GetScanRequest fetches a scan that ultimately failed.

In that case:

Scan.status is "failure"
Scan.error.code is one of the codes listed below
Scan.error.type is the category — format, quality, face, person, posing, or other

{
  "entry": {
    "id": "scan_testIDFHsFggF",
    "status": "failure",
    "error": {
      "code": "rightPhotoFacingWrongDirection",
      "type": "posing"
    }
  }
}

Posing errors

For every error of type posing, consult the Posing guidelines for how to position the person correctly, and retake the photos.

Format errors

Returned when an uploaded image can't be read as a valid scan input.

Code	Explanation
`noEXIF`	An image is missing EXIF data.
`invalidPhotoFormat`	Invalid image format. Please consult the photo format requirements in the Posing guidelines.

Quality errors

Returned when an image is technically valid but too dark, bright, or blurry to process accurately.

Code	Explanation
`imageTooDark`	Background too dark. Please take pictures again in a well-lit area.
`imageTooBright`	Background too bright. Please take pictures again in a darker area.
`imageTooBlurry`	Image is too blurry. Please hold the device steady and take pictures again.

Face errors

Returned when the face can't be located in the image.

Code	Explanation
`faceNotDetected`	Failed to detect a face. Please be sure the face is visible and try again.

Person errors

Returned when the wrong number of people are detected in the image.

Code	Explanation
`personNotDetected`	No person detected. Please follow the Posing guidelines and retake the photos.
`multiplePeopleDetected`	Multiple people detected. Please avoid taking photos with other people in the frame and retake the photos.

Posing errors

Returned when a person is detected but not posed correctly. Review the Posing guidelines and retake the affected photo.

Code	Explanation
`rightPhotoFacingWrongDirection`	In the right photo, the person is facing in the wrong direction.
`frontPhotoNotInFrame`	In the front photo, the person is not entirely within the photo.
`rightPhotoNotInFrame`	In the right photo, the person is not entirely within the photo.
`frontPhotoLeftArmAngle`	In the front photo, the person's left arm is not at the correct angle.
`frontPhotoRightArmAngle`	In the front photo, the person's right arm is not at the correct angle.
`headNotInFrame`	In the front photo, the person's head is not entirely within the photo.
`leftArmNotInFrame`	In the front photo, the person's left arm is not entirely within the photo.
`rightArmNotInFrame`	In the front photo, the person's right arm is not entirely within the photo.
`leftLegNotInFrame`	In the front photo, the person's left leg is not entirely within the photo.
`rightLegNotInFrame`	In the front photo, the person's right leg is not entirely within the photo.
`feetNotInFrame`	In the front photo, the person's feet are not entirely within the photo, or are not clearly visible.

Other errors

Code	Explanation
`unknown`	An internal error has occurred. Please wait and then retry the scan. If the error persists, contact Bodygram.

Format errors

Quality errors

Face errors

Person errors

Posing errors

Other errors

On this page