Sign in
Start free7-day free trial
Live API contract
API REFERENCE / Prefill links

Retrieve a prefill link and usage status

GET/v1/prefill-links/{id}

One prefill link. A non-null usedAt means the link has been signed against and will no longer prefill anything. Read with prefill:write. there is no separate read scope, and the response carries the link's own token.

Authentication

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

prefill:write
Authentication and API keys →

Parameters

idpathrequired
string · uuid

Responses

200 Response schema

application/json

idstring · uuidrequired
urlstringrequired
expiresAtstring · date-timerequired
usedAtstring | nullrequired
View complete response schema
HTTP 200 schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
    },
    "url": {
      "type": "string"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "usedAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "url",
    "expiresAt",
    "usedAt"
  ],
  "additionalProperties": false
}

401 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 401 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
}

403 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 403 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
}

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
}

422 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 422 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
}

429 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 429 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 prefill links guide for ordering, verification and recovery. Browse the other prefill links endpoints when you need the next operation.