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

# List tasks

> Lists the merchant-wide task inbox with URL-free verification-session summaries.



## OpenAPI

````yaml /openapi.json get /v3/tasks
openapi: 3.1.0
info:
  title: Swipelux API
  version: 3.1.0
servers:
  - url: https://platform.swipelux.com
    description: Production and sandbox; environment selected by API key
security:
  - apiKey: []
tags:
  - name: customers
    x-displayName: Customers
    description: >-
      Create, list, update, export, and archive individual and business
      customers and their related parties.
  - name: capabilities
    x-displayName: Capabilities
    description: >-
      Discover, request, inspect, and cancel customer capabilities and their
      institution applications.
  - name: accounts
    x-displayName: Accounts
    description: Create, inspect, update, and archive customer accounts.
  - name: recipients
    x-displayName: Recipients
    description: Create third-party recipients and their payout destinations.
  - name: Tasks
    x-displayName: Tasks
    description: Inspect customer, capability, application, account, and transfer tasks.
  - name: Task submissions
    x-displayName: Task submissions
    description: Submit and inspect immutable answers to customer tasks.
  - name: documents
    x-displayName: Documents
    description: Upload and inspect customer documents used in task submissions.
  - name: money-movement
    x-displayName: Money movement
    description: Create quotes, execute quote-backed transfers, and inspect transfer state.
  - name: rules
    x-displayName: Rules
    description: >-
      Standing instructions that act on incoming funds. A rule watches a
      custodial wallet account (`trigger`) and, when funds become available on
      it, transfers them to a target (`action`) — most commonly a sweep to a
      non-custodial wallet destination.


      Rules match at the account credit, not at the deposit rail: fiat deposits
      settle into the issued bank account's settlement wallet account, so a rule
      on that wallet account catches ACH/SEPA/SWIFT deposits, stablecoin
      deposits, and internal transfers alike.


      The action target reuses the money-movement vocabulary (`account` for the
      customer's own accounts, `destination` for recipient destinations). At
      most one non-archived rule may watch a given trigger account. Statuses:
      `active ⇄ paused → archived` — pause and resume through PATCH, archive
      (terminal) through DELETE.
  - name: sandbox
    x-displayName: Sandbox
    description: Simulate supported account, task, capability, and transfer outcomes.
  - name: institutions
    x-displayName: Institutions
    description: List institutions referenced by capabilities and applications.
  - name: webhooks
    x-displayName: Webhooks
    description: Configure webhook endpoints and inspect delivery activity.
externalDocs:
  description: Swipelux Documentation
  url: https://docs.swipelux.com
paths:
  /v3/tasks:
    get:
      tags:
        - Tasks
      summary: List tasks
      description: >-
        Lists the merchant-wide task inbox with URL-free verification-session
        summaries.
      operationId: listTasks
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor returned as `nextCursor` from the previous page.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Maximum number of records to return. Defaults to 25.
        - name: status
          in: query
          required: false
          description: Return only tasks with this closed status.
          schema:
            type: string
            enum:
              - action_required
              - in_review
              - satisfied
              - rejected
              - canceled
        - name: category
          in: query
          required: false
          description: Return only tasks in this open category.
          schema:
            type: string
        - name: scopeType
          in: query
          required: false
          description: Return only tasks with this scope type.
          schema:
            type: string
        - name: customerId
          in: query
          required: false
          description: Return only tasks owned by this customer.
          schema:
            type: string
        - name: originGroupId
          in: query
          required: false
          description: >-
            Return only tasks whose originGroupId exactly equals this opaque
            correlation value.
          schema:
            type: string
        - name: dueBefore
          in: query
          required: false
          description: Return only tasks due before this strict RFC 3339 timestamp.
          schema:
            type: string
            format: date-time
        - name: updatedAfter
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Return only records updated at or after this RFC 3339 timestamp. Use
            it to recover from missed webhooks by replaying a window of changes.
      responses:
        '200':
          description: Task inbox page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskPage'
        '400':
          description: Invalid task-list query.
          content:
            application/problem+json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - type
                  - title
                  - status
                  - code
                  - detail
                  - correlationId
                  - retryable
                properties:
                  type:
                    type: string
                    format: uri
                    description: Documentation URL for this stable problem code.
                  title:
                    type: string
                    description: Short human-readable problem title.
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                    description: HTTP status code.
                  code:
                    type: string
                    enum:
                      - unknown_parameter
                      - validation_error
                    description: Stable snake_case error code.
                  detail:
                    type: string
                    description: Actionable problem detail for legitimate callers.
                  correlationId:
                    type: string
                    description: Request correlation id. Mirrors `X-Request-Id`.
                  transferId:
                    type: string
                    description: >-
                      Existing transfer that consumed the quote. Present on
                      `quote_already_executed`.
                  retryable:
                    type: boolean
                    enum:
                      - false
                    description: Static retry guidance for this problem code.
                  errors:
                    type: array
                    description: Field-level validation errors.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - pointer
                        - code
                        - message
                      properties:
                        pointer:
                          type: string
                          description: JSON Pointer into the request body.
                        code:
                          type: string
                          description: Machine-readable field error code.
                        message:
                          type: string
                          description: Human-readable field error message.
                  statusReason:
                    type: object
                    description: >-
                      Structured reason for a state conflict when the failed
                      operation depends on the resource's current status.
                    required:
                      - code
                      - message
                      - actor
                      - retryable
                    properties:
                      code:
                        type: string
                        description: >-
                          Stable snake_case reason code from the documented
                          catalog.
                        example: sanctions_screening_failed
                      message:
                        type: string
                        description: Human-readable explanation of the current status.
                      actor:
                        type: string
                        enum:
                          - customer
                          - developer
                          - provider
                          - network
                          - swipelux
                        description: >-
                          Party whose action moves the resource forward: the end
                          customer, the developer integrating the API, the
                          underlying provider, payment network or rail, or
                          Swipelux. Closed enum — exhaustive; additions would be
                          a breaking change.
                      retryable:
                        type: boolean
                        description: >-
                          Whether retrying the blocked operation without
                          changing its inputs or state may succeed.
                  reviewAnswer:
                    type: string
                    nullable: true
                    description: Verification review answer when supplied by the verifier.
                  capabilities:
                    type: array
                    minItems: 1
                    items:
                      type: string
                    description: Capability ids that satisfy the failed operation.
                  blockingResources:
                    type: array
                    minItems: 1
                    description: >-
                      Customer resources that must be resolved before the
                      requested operation can proceed, sorted by type and id.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - type
                        - id
                        - requiredAction
                      properties:
                        type:
                          type: string
                          enum:
                            - account
                            - transfer
                        id:
                          type: string
                          description: Public id of the blocking resource.
                        requiredAction:
                          type: string
                          enum:
                            - archive_account
                            - cancel_transfer
                            - wait_for_transfer
                            - resolve_transfer
                          description: Next action required before retrying the operation.
        '401':
          description: Authentication is required.
          content:
            application/problem+json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - type
                  - title
                  - status
                  - code
                  - detail
                  - correlationId
                  - retryable
                properties:
                  type:
                    type: string
                    format: uri
                    description: Documentation URL for this stable problem code.
                  title:
                    type: string
                    description: Short human-readable problem title.
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                    description: HTTP status code.
                  code:
                    type: string
                    enum:
                      - unauthorized
                    description: Stable snake_case error code.
                  detail:
                    type: string
                    description: Actionable problem detail for legitimate callers.
                  correlationId:
                    type: string
                    description: Request correlation id. Mirrors `X-Request-Id`.
                  transferId:
                    type: string
                    description: >-
                      Existing transfer that consumed the quote. Present on
                      `quote_already_executed`.
                  retryable:
                    type: boolean
                    enum:
                      - false
                    description: Static retry guidance for this problem code.
                  errors:
                    type: array
                    description: Field-level validation errors.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - pointer
                        - code
                        - message
                      properties:
                        pointer:
                          type: string
                          description: JSON Pointer into the request body.
                        code:
                          type: string
                          description: Machine-readable field error code.
                        message:
                          type: string
                          description: Human-readable field error message.
                  statusReason:
                    type: object
                    description: >-
                      Structured reason for a state conflict when the failed
                      operation depends on the resource's current status.
                    required:
                      - code
                      - message
                      - actor
                      - retryable
                    properties:
                      code:
                        type: string
                        description: >-
                          Stable snake_case reason code from the documented
                          catalog.
                        example: sanctions_screening_failed
                      message:
                        type: string
                        description: Human-readable explanation of the current status.
                      actor:
                        type: string
                        enum:
                          - customer
                          - developer
                          - provider
                          - network
                          - swipelux
                        description: >-
                          Party whose action moves the resource forward: the end
                          customer, the developer integrating the API, the
                          underlying provider, payment network or rail, or
                          Swipelux. Closed enum — exhaustive; additions would be
                          a breaking change.
                      retryable:
                        type: boolean
                        description: >-
                          Whether retrying the blocked operation without
                          changing its inputs or state may succeed.
                  reviewAnswer:
                    type: string
                    nullable: true
                    description: Verification review answer when supplied by the verifier.
                  capabilities:
                    type: array
                    minItems: 1
                    items:
                      type: string
                    description: Capability ids that satisfy the failed operation.
                  blockingResources:
                    type: array
                    minItems: 1
                    description: >-
                      Customer resources that must be resolved before the
                      requested operation can proceed, sorted by type and id.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - type
                        - id
                        - requiredAction
                      properties:
                        type:
                          type: string
                          enum:
                            - account
                            - transfer
                        id:
                          type: string
                          description: Public id of the blocking resource.
                        requiredAction:
                          type: string
                          enum:
                            - archive_account
                            - cancel_transfer
                            - wait_for_transfer
                            - resolve_transfer
                          description: Next action required before retrying the operation.
        '403':
          description: The credential cannot read tasks.
          content:
            application/problem+json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - type
                  - title
                  - status
                  - code
                  - detail
                  - correlationId
                  - retryable
                properties:
                  type:
                    type: string
                    format: uri
                    description: Documentation URL for this stable problem code.
                  title:
                    type: string
                    description: Short human-readable problem title.
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                    description: HTTP status code.
                  code:
                    type: string
                    enum:
                      - forbidden
                    description: Stable snake_case error code.
                  detail:
                    type: string
                    description: Actionable problem detail for legitimate callers.
                  correlationId:
                    type: string
                    description: Request correlation id. Mirrors `X-Request-Id`.
                  transferId:
                    type: string
                    description: >-
                      Existing transfer that consumed the quote. Present on
                      `quote_already_executed`.
                  retryable:
                    type: boolean
                    enum:
                      - false
                    description: Static retry guidance for this problem code.
                  errors:
                    type: array
                    description: Field-level validation errors.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - pointer
                        - code
                        - message
                      properties:
                        pointer:
                          type: string
                          description: JSON Pointer into the request body.
                        code:
                          type: string
                          description: Machine-readable field error code.
                        message:
                          type: string
                          description: Human-readable field error message.
                  statusReason:
                    type: object
                    description: >-
                      Structured reason for a state conflict when the failed
                      operation depends on the resource's current status.
                    required:
                      - code
                      - message
                      - actor
                      - retryable
                    properties:
                      code:
                        type: string
                        description: >-
                          Stable snake_case reason code from the documented
                          catalog.
                        example: sanctions_screening_failed
                      message:
                        type: string
                        description: Human-readable explanation of the current status.
                      actor:
                        type: string
                        enum:
                          - customer
                          - developer
                          - provider
                          - network
                          - swipelux
                        description: >-
                          Party whose action moves the resource forward: the end
                          customer, the developer integrating the API, the
                          underlying provider, payment network or rail, or
                          Swipelux. Closed enum — exhaustive; additions would be
                          a breaking change.
                      retryable:
                        type: boolean
                        description: >-
                          Whether retrying the blocked operation without
                          changing its inputs or state may succeed.
                  reviewAnswer:
                    type: string
                    nullable: true
                    description: Verification review answer when supplied by the verifier.
                  capabilities:
                    type: array
                    minItems: 1
                    items:
                      type: string
                    description: Capability ids that satisfy the failed operation.
                  blockingResources:
                    type: array
                    minItems: 1
                    description: >-
                      Customer resources that must be resolved before the
                      requested operation can proceed, sorted by type and id.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - type
                        - id
                        - requiredAction
                      properties:
                        type:
                          type: string
                          enum:
                            - account
                            - transfer
                        id:
                          type: string
                          description: Public id of the blocking resource.
                        requiredAction:
                          type: string
                          enum:
                            - archive_account
                            - cancel_transfer
                            - wait_for_transfer
                            - resolve_transfer
                          description: Next action required before retrying the operation.
        '500':
          description: The task list could not be read.
          content:
            application/problem+json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - type
                  - title
                  - status
                  - code
                  - detail
                  - correlationId
                  - retryable
                properties:
                  type:
                    type: string
                    format: uri
                    description: Documentation URL for this stable problem code.
                  title:
                    type: string
                    description: Short human-readable problem title.
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                    description: HTTP status code.
                  code:
                    type: string
                    enum:
                      - internal_error
                    description: Stable snake_case error code.
                  detail:
                    type: string
                    description: Actionable problem detail for legitimate callers.
                  correlationId:
                    type: string
                    description: Request correlation id. Mirrors `X-Request-Id`.
                  transferId:
                    type: string
                    description: >-
                      Existing transfer that consumed the quote. Present on
                      `quote_already_executed`.
                  retryable:
                    type: boolean
                    enum:
                      - true
                    description: Static retry guidance for this problem code.
                  errors:
                    type: array
                    description: Field-level validation errors.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - pointer
                        - code
                        - message
                      properties:
                        pointer:
                          type: string
                          description: JSON Pointer into the request body.
                        code:
                          type: string
                          description: Machine-readable field error code.
                        message:
                          type: string
                          description: Human-readable field error message.
                  statusReason:
                    type: object
                    description: >-
                      Structured reason for a state conflict when the failed
                      operation depends on the resource's current status.
                    required:
                      - code
                      - message
                      - actor
                      - retryable
                    properties:
                      code:
                        type: string
                        description: >-
                          Stable snake_case reason code from the documented
                          catalog.
                        example: sanctions_screening_failed
                      message:
                        type: string
                        description: Human-readable explanation of the current status.
                      actor:
                        type: string
                        enum:
                          - customer
                          - developer
                          - provider
                          - network
                          - swipelux
                        description: >-
                          Party whose action moves the resource forward: the end
                          customer, the developer integrating the API, the
                          underlying provider, payment network or rail, or
                          Swipelux. Closed enum — exhaustive; additions would be
                          a breaking change.
                      retryable:
                        type: boolean
                        description: >-
                          Whether retrying the blocked operation without
                          changing its inputs or state may succeed.
                  reviewAnswer:
                    type: string
                    nullable: true
                    description: Verification review answer when supplied by the verifier.
                  capabilities:
                    type: array
                    minItems: 1
                    items:
                      type: string
                    description: Capability ids that satisfy the failed operation.
                  blockingResources:
                    type: array
                    minItems: 1
                    description: >-
                      Customer resources that must be resolved before the
                      requested operation can proceed, sorted by type and id.
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - type
                        - id
                        - requiredAction
                      properties:
                        type:
                          type: string
                          enum:
                            - account
                            - transfer
                        id:
                          type: string
                          description: Public id of the blocking resource.
                        requiredAction:
                          type: string
                          enum:
                            - archive_account
                            - cancel_transfer
                            - wait_for_transfer
                            - resolve_transfer
                          description: Next action required before retrying the operation.
components:
  schemas:
    TaskPage:
      type: object
      additionalProperties: false
      required:
        - data
        - nextCursor
        - hasMore
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Task'
        nextCursor:
          type: string
          nullable: true
        hasMore:
          type: boolean
    Task:
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - customerId
        - scope
        - subject
        - category
        - status
        - revision
        - remediationRound
        - reason
        - dueAt
        - deadline
        - notices
        - requirements
        - verificationSessions
        - tosSessions
        - completionPolicy
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        name:
          type: string
          minLength: 1
          description: Customer-facing task name.
        customerId:
          type: string
        scope:
          $ref: '#/components/schemas/TaskScope'
        subject:
          $ref: '#/components/schemas/TaskSubject'
        originGroupId:
          type: string
        category:
          type: string
          description: >-
            Task category. Open enum — values are added over time; clients must
            tolerate unknown values.
        status:
          type: string
          enum:
            - action_required
            - in_review
            - satisfied
            - rejected
            - canceled
          description: >-
            Task lifecycle status. Closed enum — exhaustive; additions would be
            a breaking change.
        revision:
          type: integer
          minimum: 1
        remediationRound:
          type: integer
          minimum: 0
        reason:
          $ref: '#/components/schemas/TaskReason'
        dueAt:
          type: string
          format: date-time
          nullable: true
        deadline:
          allOf:
            - $ref: '#/components/schemas/TaskDeadline'
          nullable: true
          description: Executable task deadline, or null when none is set.
        notices:
          type: array
          items:
            $ref: '#/components/schemas/TaskNotice'
        requirements:
          type: array
          items:
            $ref: '#/components/schemas/Requirement'
        verificationSessions:
          type: array
          items:
            $ref: '#/components/schemas/VerificationSession'
        tosSessions:
          type: array
          items:
            $ref: '#/components/schemas/VerificationSession'
        completionPolicy:
          allOf:
            - $ref: '#/components/schemas/TaskCompletionPolicyExpression'
          nullable: true
          description: >-
            Completion expression, or null when no completion policy is
            available.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    TaskScope:
      type: object
      additionalProperties: false
      required:
        - type
        - id
      properties:
        type:
          type: string
          description: Resource type whose workflow created the task.
        id:
          type: string
          description: Public resource id or semantic capability key.
    TaskSubject:
      type: object
      additionalProperties: false
      required:
        - type
        - id
      properties:
        type:
          type: string
          description: Resource type whose information the task concerns.
        id:
          type: string
          description: Public task-subject identifier.
    TaskReason:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - requestedBy
      properties:
        code:
          type: string
          description: Stable snake_case reason code.
        message:
          type: string
          description: Safe developer-facing explanation.
        requestedBy:
          type: string
          description: Party that requested the work; open enum.
    TaskDeadline:
      type: object
      additionalProperties: false
      required:
        - at
        - outcome
        - noticeCount
      properties:
        at:
          type: string
          format: date-time
        outcome:
          type: string
          enum:
            - none
            - auto_rejected
          description: Closed executable-deadline outcome.
        noticeCount:
          type: integer
          minimum: 0
    TaskNotice:
      type: object
      additionalProperties: false
      required:
        - at
        - type
        - noticeCount
      properties:
        at:
          type: string
          format: date-time
        type:
          type: string
          description: Open informational notice type.
        noticeCount:
          type: integer
          minimum: 0
    Requirement:
      type: object
      additionalProperties: false
      required:
        - id
        - key
        - status
        - request
      properties:
        id:
          type: string
        key:
          type: string
        section:
          type: string
        status:
          type: string
          enum:
            - action_required
            - in_review
            - accepted
            - rejected
            - canceled
            - superseded
          description: Closed requirement lifecycle status.
        request:
          $ref: '#/components/schemas/RequirementRequest'
        reviewFeedback:
          $ref: '#/components/schemas/ReviewFeedback'
    VerificationSession:
      type: object
      additionalProperties: false
      required:
        - id
        - key
        - type
        - status
      properties:
        id:
          type: string
          pattern: ^vfy_[0-9A-Za-z]+$
          description: Verification-session identifier (`vfy_...`).
        key:
          type: string
          minLength: 1
        type:
          type: string
          description: Open hosted-session type.
        status:
          type: string
          enum:
            - action_required
            - in_review
            - completed
            - rejected
            - canceled
          description: Closed verification-session status.
    TaskCompletionPolicyExpression:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - type
            - completion
          properties:
            type:
              type: string
              enum:
                - requirements
                - verification_sessions
                - tos_sessions
              description: Closed task child-collection leaf.
            completion:
              type: string
              enum:
                - all
              description: Every live member of the collection must complete.
        - type: object
          additionalProperties: false
          required:
            - mode
            - conditions
          properties:
            mode:
              type: string
              enum:
                - all_of
                - any_of
              description: Closed completion-policy group mode.
            conditions:
              type: array
              minItems: 2
              items:
                $ref: '#/components/schemas/TaskCompletionPolicyExpression'
      description: Defines which child collections must complete before the task completes.
    RequirementRequest:
      oneOf:
        - $ref: '#/components/schemas/ProfileRequirementRequest'
        - $ref: '#/components/schemas/TextRequirementRequest'
        - $ref: '#/components/schemas/DateRequirementRequest'
        - $ref: '#/components/schemas/SingleSelectRequirementRequest'
        - $ref: '#/components/schemas/MultiSelectRequirementRequest'
        - $ref: '#/components/schemas/BooleanRequirementRequest'
        - $ref: '#/components/schemas/AttestationRequirementRequest'
        - $ref: '#/components/schemas/DocumentRequirementRequest'
        - $ref: '#/components/schemas/ResourceReferenceRequirementRequest'
        - $ref: '#/components/schemas/AlternativesRequirementRequest'
      discriminator:
        propertyName: type
    ReviewFeedback:
      type: object
      additionalProperties: false
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable actionable feedback code.
        message:
          type: string
          description: Redacted developer-facing review feedback.
    ProfileRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - valueType
        - profilePointer
      properties:
        type:
          type: string
          enum:
            - profile
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        valueType:
          type: string
          enum:
            - string
            - number
            - boolean
            - date
            - country
            - money
            - address
            - tax_identifier
            - identity_document
            - object
            - array
          description: Canonical profile value type.
        itemValueType:
          type: string
          description: Element value type when valueType is array.
        profilePointer:
          type: string
          pattern: ^/
          description: Canonical customer or related-party JSON Pointer.
        constraints:
          type: object
          additionalProperties: false
          required: []
          properties:
            minLength:
              type: integer
              minimum: 0
            maxLength:
              type: integer
              minimum: 1
            pattern:
              type: string
    TextRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
      properties:
        type:
          type: string
          enum:
            - text
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        constraints:
          type: object
          additionalProperties: false
          required: []
          properties:
            minLength:
              type: integer
              minimum: 0
            maxLength:
              type: integer
              minimum: 1
            pattern:
              type: string
    DateRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
      properties:
        type:
          type: string
          enum:
            - date
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        constraints:
          type: object
          additionalProperties: false
          required: []
          properties:
            minimum:
              type: string
              format: date
            maximum:
              type: string
              format: date
    SingleSelectRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - options
      properties:
        type:
          type: string
          enum:
            - single_select
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        options:
          type: array
          minItems: 1
          items:
            type: object
            additionalProperties: false
            required:
              - value
              - label
            properties:
              value:
                type: string
                description: Stable submitted option value.
              label:
                type: string
                description: Human-readable option label.
              description:
                type: string
                description: Additional option guidance.
    MultiSelectRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - options
      properties:
        type:
          type: string
          enum:
            - multi_select
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        options:
          type: array
          minItems: 1
          items:
            type: object
            additionalProperties: false
            required:
              - value
              - label
            properties:
              value:
                type: string
                description: Stable submitted option value.
              label:
                type: string
                description: Human-readable option label.
              description:
                type: string
                description: Additional option guidance.
        constraints:
          type: object
          additionalProperties: false
          required: []
          properties:
            minItems:
              type: integer
              minimum: 0
            maxItems:
              type: integer
              minimum: 1
    BooleanRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
      properties:
        type:
          type: string
          enum:
            - boolean
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
    AttestationRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - text
        - version
      properties:
        type:
          type: string
          enum:
            - attestation
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        text:
          type: string
        version:
          type: string
        constraints:
          type: object
          additionalProperties: true
          not:
            required:
              - verificationLink
          description: URL-free public attestation constraints.
    DocumentRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - purpose
      properties:
        type:
          type: string
          enum:
            - document
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        purpose:
          type: string
        acceptedDocumentTypes:
          type: array
          minItems: 1
          items:
            type: string
        minDocuments:
          type: integer
          minimum: 1
          default: 1
        maxDocuments:
          type: integer
          minimum: 1
          default: 1
        constraints:
          type: object
          additionalProperties: false
          required: []
          properties:
            maxAgeDays:
              type: integer
              minimum: 1
            captureMethods:
              type: array
              minItems: 1
              items:
                type: string
            nameMatch:
              type: string
            acceptedFormats:
              type: array
              minItems: 1
              items:
                type: string
    ResourceReferenceRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - required
        - resourceType
      properties:
        type:
          type: string
          enum:
            - resource_reference
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
          description: Instruction shown to the person completing the task.
        required:
          type: boolean
          enum:
            - true
          description: Published non-alternative requests are required.
        allowsAbsence:
          type: boolean
          description: Whether an absence answer is accepted.
        resourceType:
          type: string
          enum:
            - related_party
          description: Referenced resource type.
        requiredRoles:
          type: array
          minItems: 1
          items:
            type: string
    AlternativesRequirementRequest:
      type: object
      additionalProperties: false
      required:
        - type
        - prompt
        - alternatives
      properties:
        type:
          type: string
          enum:
            - alternatives
          description: Requirement request discriminator.
        prompt:
          type: string
          minLength: 1
        alternatives:
          type: array
          minItems: 1
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - request
            properties:
              key:
                type: string
                minLength: 1
              request:
                oneOf:
                  - $ref: '#/components/schemas/ProfileRequirementRequest'
                  - $ref: '#/components/schemas/TextRequirementRequest'
                  - $ref: '#/components/schemas/DateRequirementRequest'
                  - $ref: '#/components/schemas/SingleSelectRequirementRequest'
                  - $ref: '#/components/schemas/MultiSelectRequirementRequest'
                  - $ref: '#/components/schemas/BooleanRequirementRequest'
                  - $ref: '#/components/schemas/AttestationRequirementRequest'
                  - $ref: '#/components/schemas/DocumentRequirementRequest'
                  - $ref: '#/components/schemas/ResourceReferenceRequirementRequest'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Swipelux API key. Obtain this from the Swipelux Dashboard.

````

## Related topics

- [List task history](/api-reference/tasks/list-customer-task-history.md)
- [List task submissions](/api-reference/task-submissions/list-customer-task-submissions.md)
- [Capabilities and tasks](/integration/onboarding/capabilities-and-requirements.md)
- [List customer tasks](/api-reference/tasks/list-customer-tasks.md)
- [List transfer-scoped tasks](/api-reference/money-movement/get-v3-transfers-by-transfer-id-tasks.md)