> ## Documentation Index
> Fetch the complete documentation index at: https://developers.paylinedata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Recover current handoff without issuance or renewal



## OpenAPI

````yaml /openapi/applications-v1.json get /applications/{applicationId}/handoff
openapi: 3.1.0
info:
  title: Applications API — creation, recovery, retrieval and explicit reissue
  version: 1.0.0
  description: >-
    10N-909/910/911. Current answers and signed evidence are separate; retrieval
    and downloads require a committed sensitive-access audit. Artifact objects
    are bounded to 20 MiB, checksum/size verified before audit commit, then
    streamed without exposing storage URLs. GET status contains no protected
    values or merchant credential URL. Unreadable current authority returns
    protected_data_unavailable; no snapshot fallback. Artifact lookup is 404 if
    inaccessible, 409 artifact_not_ready before completion, or 503
    artifact_unavailable for integrity/storage failure. Clerk organization API
    keys and current local capabilities required. Tenant/environment/stable
    caller come from verified authority. 30 create attempts, 30 separate reissue
    attempts and 120 shared GET attempts per 60-second fixed window per stable
    caller; key replacement does not reset counters. Create body cap 65,536
    UTF-8 bytes; reissue body cap 1,024 UTF-8 bytes with 8-second read deadline,
    strings 2,048 characters, numeric pricing overrides 128 characters. Unknown
    fields rejected. Every implemented response is no-store. Persist requestId
    before the first attempt; after network failure/503 retry the original
    request, never generate a new ID. Schema defaults intentionally absent.
    Existing UI and signing remain unchanged. Protected values must never be
    logged by clients.
servers:
  - url: https://sandbox.paylinedata.com/api/v1
    description: Isolated Sandbox
  - url: https://dashboard.paylinedata.com/api/v1
    description: Production; separate activation required
security:
  - PartnerApiKey: []
paths:
  /applications/{applicationId}/handoff:
    get:
      summary: Recover current handoff without issuance or renewal
      operationId: getApplicationHandoff
      parameters:
        - in: path
          name: applicationId
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Current authorized handoff; expired/revoked/unavailable URL is null.
            Signing purpose is confirmation.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoffResponse'
        '400':
          description: Safe 400 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Safe 401 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Safe 403 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Safe 404 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Safe 409 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Safe 413 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Safe 415 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Safe 422 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Safe 429 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
            Retry-After:
              schema:
                type: integer
                minimum: 1
                maximum: 60
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Safe 503 error. No submitted values or credentials.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    HandoffResponse:
      type: object
      additionalProperties: false
      properties:
        applicationId:
          type: string
          format: uuid
        status:
          enum:
            - draft
            - in_progress
            - submitted
            - in_review
            - needs_information
            - pending
            - approved
            - declined
            - boarded
            - live
            - dormant
            - closed
        handoff:
          $ref: '#/components/schemas/Handoff'
      required:
        - applicationId
        - status
        - handoff
    Error:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              enum:
                - invalid_request
                - unauthenticated
                - capability_denied
                - not_found
                - request_conflict
                - handoff_changed
                - signing_input_locked
                - already_signed
                - reissue_ineligible
                - payload_too_large
                - unsupported_media_type
                - validation_failed
                - rate_limited
                - operation_unconfirmed
                - protected_data_unavailable
                - artifact_not_ready
                - artifact_unavailable
                - service_unavailable
            message:
              type: string
            fields:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  path:
                    type: string
                  code:
                    type: string
                required:
                  - path
                  - code
            retryable:
              type: boolean
          required:
            - code
            - message
            - fields
            - retryable
        supportReference:
          type: string
          format: uuid
      required:
        - error
        - supportReference
    Handoff:
      type: object
      additionalProperties: false
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        state:
          enum:
            - active
            - expired
            - revoked
            - pending
            - unavailable
        url:
          anyOf:
            - type: string
              format: uri
            - type: 'null'
          description: >-
            Sensitive merchant credential URL; never log. Null when access
            unavailable. Recovery never renews expiry.
        issuedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        expiresAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        purpose:
          enum:
            - completion_or_signing
            - confirmation
      required:
        - id
        - state
        - url
        - issuedAt
        - expiresAt
        - purpose
  securitySchemes:
    PartnerApiKey:
      type: http
      scheme: bearer
      bearerFormat: Clerk organization API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.