Skip to main content
GET
/
api
/
v2
/
sr
/
{sr_uuid}
/
side-groups
Get Requirements
curl --request GET \
  --url https://api.example.com/api/v2/sr/{sr_uuid}/side-groups \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-token: <api-key>'
{
  "success": true,
  "message": "Requirements retrieved successfully.",
  "data": {
    "side_groups": [
      {
        "uuid": "sidegroup-uuid-1",
        "name": "Essential Views",
        "description": "Required product angles for authentication",
        "lock": false,
        "sides": [
          {
            "uuid": "side-uuid-1",
            "name": "Front",
            "description": "Front view of the product",
            "ordinal": 0,
            "required": true,
            "side_group_id": "sidegroup-uuid-1",
            "overlay_image": "https://media.legitmark.com/static/overlays/front-overlay.png",
            "example_image": "https://media.legitmark.com/static/examples/front-example.jpg",
            "thumbnail_image": "https://media.legitmark.com/static/thumbnails/front-thumb.jpg",
            "active": true
          },
          {
            "uuid": "side-uuid-2",
            "name": "Back",
            "description": "Back view of the product",
            "ordinal": 1,
            "required": true,
            "side_group_id": "sidegroup-uuid-1",
            "overlay_image": "https://media.legitmark.com/static/overlays/back-overlay.png",
            "example_image": "https://media.legitmark.com/static/examples/back-example.jpg",
            "thumbnail_image": "https://media.legitmark.com/static/thumbnails/back-thumb.jpg",
            "active": true
          }
        ]
      },
      {
        "uuid": "sidegroup-uuid-2",
        "name": "Detail Shots",
        "description": "Optional detail views for enhanced verification",
        "lock": false,
        "sides": [
          {
            "uuid": "side-uuid-3",
            "name": "Logo Close-up",
            "description": "Close-up view of the brand logo",
            "ordinal": 0,
            "required": false,
            "side_group_id": "sidegroup-uuid-2",
            "overlay_image": "https://media.legitmark.com/static/overlays/logo-overlay.png",
            "example_image": "https://media.legitmark.com/static/examples/logo-example.jpg",
            "thumbnail_image": "https://media.legitmark.com/static/thumbnails/logo-thumb.jpg",
            "active": true
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key for application authentication (format: leo_xxxxxxxxx)

​
x-user-token
string
header
required

Secure user token (Non-PII format: lm_usr_xxxxx) - PROPOSED: Not yet implemented

Path Parameters

​
sr_uuid
string<uuid>
required

Service request UUID from create response

Query Parameters

​
include_inactive
boolean
default:false

Include inactive sides in the response

​
organized
boolean
default:false

Return organized format with hierarchy levels

Response

Side groups and requirements retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Requirements retrieved successfully."

​
data
object
​
metadata
object