Request return frames

Last updated: October 28, 2024

You can optionally request the image of the user that is captured during an enroll validate or claim validate process. The following frame will be provided in the API response:

  • LA: last frame

  • GPA: 4th frame

Note

This is an optional feature that is be enabled per service provider, contact iProov support or the customer success team.

Image formats

The following image formats are supported in base64:

  • PNG (Default)

  • JPEG

Response schema

Response schema Description
frame_available

  • Present and True if the frame return functionality is enabled and the frame is available.

  • Not present if the feature is disabled.
frame

  • If frame_available is Present and True:
    returns a base64 PNG frame.
frame_jpeg

  • Default: not present.

  • If JPEG functionality is enabled, returns a base64 JPEG frame.

 

Next step

Management API services