Sign in
Start free7-day free trial
Live API contract
API REFERENCE / Waiver records

Retrieve a captured photo

GET/v1/waivers/{id}/photos/{blockId}

The image captured by one photo_capture or id_capture block, streamed as PNG or JPEG. Signature and initials images are not reachable here. 404 when the waiver, the block, or the stored object is absent.

Authentication

Send an organization-scoped API key in the Authorization header. Keep credentials on your server.

waivers:read
Authentication and API keys →

Parameters

idpathrequired
string · uuid
blockIdpathrequired
string

Responses

404 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 404 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

Authentication and validation failures use the shared error envelope. Save the request ID when diagnosing a failed call.

Build the surrounding workflow

Read the waiver records guide for ordering, verification and recovery. Browse the other waiver records endpoints when you need the next operation.