> ## 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.

# Get status

> Check Application progress, signing acceptance and signed-file readiness.

Use this endpoint for polling without retrieving protected answers or a merchant completion URL. Read Application status, `signing.accepted` and `artifacts.state` separately. Signing remains accepted if file finalization fails; contradictory evidence is unavailable, not proof of readiness.

Poll with backoff and honor `Retry-After` on `429`. GETs share the 120-attempt per-caller/60-second limit, including across key replacement. No query parameters are accepted. See [status and artifact states](https://developers.paylinedata.com/retrieve-applications.md#poll-status-through-the-api).


## OpenAPI

````yaml /openapi/applications-v1.json get /applications/{applicationId}/status
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}/status:
    get:
      summary: Poll signing acceptance and independent artifact readiness
      description: >-
        Accepted signing stays accepted if finalization fails. No protected
        answers, private storage identifiers or merchant URL. Contradictory
        evidence is unavailable. No query parameters.
      operationId: getApplicationStatus
      parameters:
        - in: path
          name: applicationId
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Safe current lifecycle and immutable artifact metadata.
          headers:
            Cache-Control:
              schema:
                const: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
              examples:
                unsigned:
                  summary: Unsigned Application
                  value:
                    applicationId: a7d12cb4-2430-4e9d-a414-89fe4f52ee10
                    status: draft
                    archivedAt: null
                    ownerUserId: null
                    assigneeUserId: null
                    signing:
                      accepted: false
                      acceptedAt: null
                      disposition: null
                    artifacts:
                      state: not_started
                      versionId: null
                      items: []
                finalizing:
                  summary: Signing accepted; PDFs processing
                  value:
                    applicationId: a7d12cb4-2430-4e9d-a414-89fe4f52ee10
                    status: submitted
                    archivedAt: null
                    ownerUserId: null
                    assigneeUserId: null
                    signing:
                      accepted: true
                      acceptedAt: '2026-10-30T18:15:00Z'
                      disposition: null
                    artifacts:
                      state: finalizing
                      versionId: null
                      items: []
                failed:
                  summary: Signing remains accepted after a file failure
                  value:
                    applicationId: a7d12cb4-2430-4e9d-a414-89fe4f52ee10
                    status: submitted
                    archivedAt: null
                    ownerUserId: null
                    assigneeUserId: null
                    signing:
                      accepted: true
                      acceptedAt: '2026-10-30T18:15:00Z'
                      disposition: null
                    artifacts:
                      state: finalization_failed
                      versionId: null
                      items: []
                finalized:
                  summary: Signed files ready
                  value:
                    applicationId: a7d12cb4-2430-4e9d-a414-89fe4f52ee10
                    status: submitted
                    archivedAt: null
                    ownerUserId: null
                    assigneeUserId: null
                    signing:
                      accepted: true
                      acceptedAt: '2026-10-30T18:15:00Z'
                      disposition: null
                    artifacts:
                      state: finalized
                      versionId: 3a62d6eb-5226-4d13-9c75-22edb84de811
                      items:
                        - kind: signed_pdf
                          mediaType: application/pdf
                          downloadPath: >-
                            /api/v1/applications/a7d12cb4-2430-4e9d-a414-89fe4f52ee10/artifacts/3a62d6eb-5226-4d13-9c75-22edb84de811/signed_pdf
                        - kind: esignature_certificate
                          mediaType: application/pdf
                          downloadPath: >-
                            /api/v1/applications/a7d12cb4-2430-4e9d-a414-89fe4f52ee10/artifacts/3a62d6eb-5226-4d13-9c75-22edb84de811/esignature_certificate
        '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'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: invalid_request
                      message: The request is invalid.
                      fields: []
                      retryable: false
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
        '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'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: unauthenticated
                      message: Authentication is required.
                      fields: []
                      retryable: false
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
        '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'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: capability_denied
                      message: This operation is unavailable.
                      fields: []
                      retryable: false
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
        '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'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: not_found
                      message: Application not found.
                      fields: []
                      retryable: false
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
        '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
              example: 30
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: rate_limited
                      message: The request rate limit was reached.
                      fields: []
                      retryable: true
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
        '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'
              examples:
                error:
                  summary: Illustrative error; support reference is synthetic
                  value:
                    error:
                      code: service_unavailable
                      message: The service is temporarily unavailable.
                      fields: []
                      retryable: true
                    supportReference: c01b0f09-68f5-43e7-8685-a1994c07ed91
      x-codeSamples:
        - lang: curl
          label: Server request · private output
          source: >-
            set +x

            umask 077

            : "${PAYLINE_API_BASE:?Use the trusted API base from Developer
            Settings}"

            : "${PAYLINE_API_KEY:?Load your Test key through your secret
            manager}"

            : "${APPLICATION_ID:?Use the ID from successful creation}"

            curl --silent --show-error --fail-with-body --request GET \
              --url "$PAYLINE_API_BASE/applications/$APPLICATION_ID/status" \
              --header "Authorization: Bearer $PAYLINE_API_KEY" \
              --output status.json
components:
  schemas:
    StatusResponse:
      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
        archivedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        ownerUserId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        assigneeUserId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        signing:
          type: object
          additionalProperties: false
          properties:
            accepted:
              type: boolean
            acceptedAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
            disposition:
              enum:
                - null
                - voided
                - superseded
          required:
            - accepted
            - acceptedAt
            - disposition
        artifacts:
          type: object
          additionalProperties: false
          properties:
            state:
              enum:
                - not_started
                - finalizing
                - finalization_failed
                - finalized
                - voided
                - superseded
                - unavailable
            versionId:
              anyOf:
                - type: string
                  format: uuid
                - type: 'null'
            items:
              type: array
              maxItems: 2
              items:
                type: object
                additionalProperties: false
                properties:
                  kind:
                    enum:
                      - signed_pdf
                      - esignature_certificate
                  mediaType:
                    const: application/pdf
                  downloadPath:
                    type: string
                    pattern: ^/api/v1/applications/
                required:
                  - kind
                  - mediaType
                  - downloadPath
          required:
            - state
            - versionId
            - items
      required:
        - applicationId
        - status
        - archivedAt
        - ownerUserId
        - assigneeUserId
        - signing
        - artifacts
    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
  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.