openapi: 3.0.0
info:
  title: Partner Verifications API
  version: 1.0.0
  description: |
    Order payroll, banking, and document-based income verifications.
security:
  - basicAuth: []
paths:
  /partners/v2/users:
    post:
      summary: Create a user
      description: Creates a new user object for partner verification workflows.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerUserCreateRequest'
            example:
              client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
              first_name: Jane
              last_name: Doe
              ssn: 000-00-0000
              email: jane@example.com
              phone_number: '+15555555555'
              address:
                city: New York
                line1: 123 Main St
                line2: null
                state: NY
                country: US
                postal_code: null
              birth_date:
                year: 1990
                month: 1
                day: 13
              external_id: null
              external_metadata:
                suppress_verification: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerCreateUserResponse'
              example:
                user_token: <SECRET>
                id: 7a614711-066f-4b6b-b319-4c6236b5acc1
  /partners/v2/users/{id}:
    patch:
      summary: Update a user
      description: Updates a user object.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the user object to be updated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerUserUpdateRequest'
            example:
              email: jane@example.com
              phone_number: '+15555555555'
              external_id: ABC
              external_metadata:
                suppress_verification: true
                additional_id: '123'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerUser'
              example:
                id: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                created_at: '2023-03-09T04:54:35.170468Z'
                items_connected:
                  - item_123456789
                  - item_987654321
                employers_connected:
                  - Whole Goods
                  - Bullseye
                first_name: Jane
                last_name: Doe
                ssn: 000-00-0000
                email: jane@example.com
                phone_number: '+15555555555'
                address:
                  city: New York
                  line1: 123 Main St
                  line2: null
                  state: NY
                  country: US
                  postal_code: null
                birth_date:
                  year: 1990
                  month: 1
                  day: 13
                external_metadata:
                  suppress_verification: true
                  additional_id: '123'
                external_id: ABC
  /partners/v2/sessions:
    post:
      summary: Create a session
      description: >-
        Create a connection session and return a `link` URL that launches the
        frontend experience.


        Session links expire after one hour. A new session link can be created
        at any time by creating another session for the active verification.


        <Note>This endpoint is for payroll and banking verifications
        only.</Note>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerSessionCreateRequest'
            examples:
              payroll:
                summary: Example Request (Payroll)
                value:
                  verification: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                  configuration:
                    redirect_url: https://your-application.com/return
                    flow_id: 12ABCD3E
                    items:
                      - item_000000001
                      - item_000000002
                    language: EN
                    mobile_app: true
              banking:
                summary: Example Request (Banking)
                value:
                  verification: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                  configuration:
                    experience: 97f1eccb-241d-4052-8409-fab9e27a589b
                    single_use_url: false
                    redirect_url: https://your-application.com/return
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerSession'
              examples:
                payroll:
                  summary: Example Response (Payroll)
                  value:
                    verification: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    configuration:
                      experience: null
                      single_use_url: false
                      redirect_url: https://your-application.com/return
                      flow_id: 12ABCD3E
                      items:
                        - item_000000001
                        - item_000000002
                      language: EN
                      mobile_app: true
                    link: https://connect.argyle.com/?...
                    data_source: payroll
                banking:
                  summary: Example Response (Banking)
                  value:
                    verification: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    configuration:
                      experience: 97f1eccb-241d-4052-8409-fab9e27a589b
                      single_use_url: false
                      redirect_url: https://your-application.com/return
                    link: https://connect2.finicity.com?...
                    data_source: banking
  /partners/v2/verifications:
    post:
      summary: Order a verification
      description: >-
        Orders a new verification.


        <Note>

        [Create a
        user](/api-reference/verifications-partners-guide#create-a-user) or
        update an existing user with the required details before ordering
        payroll, banking, or document verifications.

        </Note>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerVerificationCreateRequest'
            examples:
              payroll:
                summary: Example Request (Payroll)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  report:
                    type: voie
                  loan: &ref_0
                    number: '1234'
                    borrower_id: ABC789
                    application_id: '2121313'
                    officer_email: john.doe@mortgage.com
                  billing: &ref_1
                    cost_center: '5'
              banking:
                summary: Example Request (Banking)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  report:
                    type: voai
                    configuration:
                      from_date: '2024-01-01T00:00:00Z'
                      income_stream_confidence_minimum: 50
                      report_custom_fields:
                        - label: loanID
                          value: '12345'
                          shown: true
                  loan: *ref_0
                  billing: *ref_1
              documents:
                summary: Example Request (Documents)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  employments:
                    - employer: Warehouse Services Inc
                      status: active
                      hire_date: '2023-02-01'
                      termination_date: null
                  report:
                    type: doc-voi-mortgage
                  loan: *ref_0
                  billing: *ref_1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerVerification'
              examples:
                payroll:
                  summary: Example Response (Payroll)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: voie
                      file_url: null
                      json_url: null
                    employments: []
                    loan: *ref_0
                    billing: *ref_1
                    data_source: payroll
                banking:
                  summary: Example Response (Banking)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: voai
                      file_url: null
                      json_url: null
                      configuration:
                        from_date: '2024-01-01T00:00:00Z'
                        income_stream_confidence_minimum: 50
                        report_custom_fields:
                          - label: loanID
                            value: '12345'
                            shown: true
                    employments: []
                    loan: *ref_0
                    billing: *ref_1
                    data_source: banking
                documents:
                  summary: Example Response (Documents)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: doc-voi-mortgage
                      file_url: null
                      json_url: null
                    employments:
                      - employer: Warehouse Services Inc
                        status: active
                        hire_date: '2023-02-01'
                        termination_date: null
                    loan: *ref_0
                    billing: *ref_1
                    data_source: documents
    get:
      summary: List all verifications
      description: Returns a paginated list of all verification objects.
      parameters:
        - name: user
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by user ID.
        - name: status_state
          in: query
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - PROCESSING
              - PAUSED
              - CANCELLED
              - COMPLETED
          description: Filter by verification status `state`.
        - name: status_code
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - documents_processing
              - more_data_required
              - report_available
              - waiting_on_third_party
              - report_generating
              - argyle_timeout
              - cancelled_by_client
              - completed
              - completed_with_errors
              - user_session_started
              - authenticated
          description: Filter by verification status `code`.
        - name: report_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - voie
              - voe
              - voa
              - voi
              - voai
              - voe-transactions
              - doc-voi-mortgage
          description: Filter by report `type`.
        - name: loan_number
          in: query
          required: false
          schema:
            type: string
          description: Filter by loan `number`.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >
            Number of verification objects returned [per
            page](/api-guide/overview#pagination). Default: 10. Maximum: 200.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            The URL returned in `next` or `previous` used to retrieve another
            [page](/api-guide/overview#pagination) of results.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type: string
                    nullable: true
                    description: URL for the next page of results, if available.
                  previous:
                    type: string
                    nullable: true
                    description: URL for the previous page of results, if available.
                  results:
                    type: array
                    description: Array of verification objects.
                    items:
                      $ref: '#/components/schemas/PartnerVerification'
              example:
                next: >-
                  https://api-sandbox.argyle.com/partners/v2/verifications?cursor=ZXhhbXBsZV9jdXJzb3I
                previous: null
                results:
                  - id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: 2a14ce6f-3aed-4c15-8ea2-92a17b6edb95
                      type: voie
                      file_url: null
                      json_url: null
                    employments: []
                    loan:
                      number: '1234'
                      borrower_id: ABC789
                      application_id: '2121313'
                      officer_email: john.doe@mortgage.com
                    billing:
                      cost_center: '5'
                    data_source: payroll
                  - id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc3333
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9345
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-10T05:14:06.081Z'
                    updated_at: '2023-03-10T13:03:06.081Z'
                    channel: api
                    status:
                      state: PROCESSING
                      code: authenticated
                      errors: []
                    report:
                      id: null
                      type: voai
                      file_url: null
                      json_url: null
                      configuration:
                        from_date: '2024-01-01T00:00:00Z'
                        income_stream_confidence_minimum: 50
                        report_custom_fields:
                          - label: loanID
                            value: '12345'
                            shown: true
                    employments: []
                    loan:
                      number: '1234'
                      borrower_id: ABC789
                      application_id: '2121313'
                      officer_email: john.doe@mortgage.com
                    billing:
                      cost_center: '5'
                    data_source: banking
  /partners/v2/verifications/refresh:
    post:
      summary: Refresh a verification
      description: >-
        Creates a new payroll, banking, or Doc VOI verification without
        requiring the user to reconnect or upload additional documents.


        For payroll and banking, a valid connection must already exist. For Doc
        VOI, the new report is generated from the user's existing uploaded
        documents.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerVerificationRefreshRequest'
            examples:
              payroll:
                summary: Example Request (Payroll)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  report:
                    type: voie
                  loan: *ref_0
                  billing: *ref_1
              banking:
                summary: Example Request (Banking)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  report:
                    type: voa
                    configuration:
                      from_date: '2025-01-01T00:00:00Z'
                  loan: *ref_0
                  billing: *ref_1
              documents:
                summary: Example Request (Documents)
                value:
                  user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                  report:
                    type: doc-voi-mortgage
                  loan: *ref_0
                  billing: *ref_1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerVerification'
              examples:
                payroll:
                  summary: Example Response (Payroll)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: voie
                      file_url: null
                      json_url: null
                    employments: []
                    loan: *ref_0
                    billing: *ref_1
                    data_source: payroll
                banking:
                  summary: Example Response (Banking)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: voa
                      file_url: null
                      json_url: null
                      configuration:
                        from_date: '2025-01-01T00:00:00Z'
                    employments: []
                    loan: *ref_0
                    billing: *ref_1
                    data_source: banking
                documents:
                  summary: Example Response (Documents)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PENDING
                      code: pending
                      errors: []
                    report:
                      id: null
                      type: doc-voi-mortgage
                      file_url: null
                      json_url: null
                    employments: []
                    loan: *ref_0
                    billing: *ref_1
                    data_source: documents
  /partners/v2/verifications/{id}:
    get:
      summary: Retrieve a verification
      description: Retrieves a verification.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the verification to be retrieved.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerVerification'
              example:
                id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                created_at: '2023-03-09T16:22:06.081Z'
                updated_at: '2023-03-09T16:22:06.081Z'
                channel: api
                status:
                  state: PROCESSING
                  code: authenticated
                  errors: []
                report:
                  id: null
                  type: voai
                  file_url: null
                  json_url: null
                  configuration:
                    from_date: '2024-01-01T00:00:00Z'
                    income_stream_confidence_minimum: 50
                    report_custom_fields:
                      - label: loanID
                        value: '12345'
                        shown: true
                employments: []
                loan:
                  number: '1234'
                  borrower_id: ABC789
                  application_id: '2121313'
                  officer_email: john.doe@mortgage.com
                billing:
                  cost_center: '5'
                data_source: banking
    patch:
      summary: Update a verification
      description: >
        Updates verification metadata or employments.


        <Note>

        After a verification is updated, it will re-enter the `PROCESSING`
        state.

        </Note>
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the verification to be updated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerVerificationUpdateRequest'
            examples:
              payroll:
                summary: Example Request (Payroll)
                value:
                  loan:
                    number: '5678'
                    borrower_id: '5678'
                    application_id: '2121313'
                    officer_email: john.doe@mortgage.com
                  billing:
                    cost_center: new_cost_center
              banking:
                summary: Example Request (Banking)
                value:
                  loan:
                    number: '5678'
                    borrower_id: '5678'
                    application_id: '2121313'
                    officer_email: john.doe@mortgage.com
                  billing:
                    cost_center: new_cost_center
              documents:
                summary: Example Request (Documents)
                value:
                  employments:
                    - employer: Warehouse Services Inc
                      status: previous
                      hire_date: '2015-08-28'
                      termination_date: '2023-05-01'
                    - employer: Amazon
                      status: active
                      hire_date: '2023-06-15'
                      termination_date: null
                  loan:
                    borrower_id: '5678'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerVerification'
              examples:
                payroll:
                  summary: Example Response (Payroll)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PROCESSING
                      code: authenticated
                      errors: []
                    report:
                      id: null
                      type: voie
                      file_url: null
                      json_url: null
                    employments: []
                    loan:
                      number: '5678'
                      borrower_id: '5678'
                      application_id: '2121313'
                      officer_email: john.doe@mortgage.com
                    billing:
                      cost_center: new_cost_center
                    data_source: payroll
                banking:
                  summary: Example Response (Banking)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PROCESSING
                      code: authenticated
                      errors: []
                    report:
                      id: null
                      type: voai
                      file_url: null
                      json_url: null
                      configuration:
                        from_date: '2024-01-01T00:00:00Z'
                        income_stream_confidence_minimum: 50
                        report_custom_fields:
                          - label: loanID
                            value: '12345'
                            shown: true
                    employments: []
                    loan:
                      number: '5678'
                      borrower_id: '5678'
                      application_id: '2121313'
                      officer_email: john.doe@mortgage.com
                    billing:
                      cost_center: new_cost_center
                    data_source: banking
                documents:
                  summary: Example Response (Documents)
                  value:
                    id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                    user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                    client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                    created_at: '2023-03-09T16:22:06.081Z'
                    updated_at: '2023-03-09T16:22:06.081Z'
                    channel: api
                    status:
                      state: PROCESSING
                      code: documents_processing
                      errors: []
                    report:
                      id: null
                      type: doc-voi-mortgage
                      file_url: null
                      json_url: null
                    employments:
                      - employer: Warehouse Services Inc
                        status: previous
                        hire_date: '2015-08-28'
                        termination_date: '2023-05-01'
                      - employer: Amazon
                        status: active
                        hire_date: '2023-06-15'
                        termination_date: null
                    loan:
                      number: '1234'
                      borrower_id: '5678'
                      application_id: '2121313'
                      officer_email: john.doe@mortgage.com
                    billing:
                      cost_center: '5'
                    data_source: documents
  /partners/v2/verifications/{id}/cancel:
    post:
      summary: Cancel a verification
      description: |
        Cancels a verification order.

        <Note>
        Only verifications in the `PAUSED` state can be cancelled.
        </Note>
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the verification to be cancelled.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerVerification'
              example:
                id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                created_at: '2023-03-09T16:22:06.081Z'
                updated_at: '2023-03-09T16:22:06.081Z'
                channel: api
                status:
                  state: CANCELLED
                  code: cancelled_by_client
                  errors: []
                report:
                  id: null
                  type: doc-voi-mortgage
                  file_url: null
                  json_url: null
                employments:
                  - employer: Warehouse Services Inc
                    status: active
                    hire_date: '2023-02-01'
                    termination_date: null
                loan:
                  number: '1234'
                  borrower_id: ABC789
                  application_id: '2121313'
                  officer_email: john.doe@mortgage.com
                billing:
                  cost_center: '5'
                data_source: documents
  /partners/v2/webhooks:
    post:
      summary: Create webhook subscription
      description: >-
        Creates a partner webhook subscription for `verifications.updated` or
        `verifications.creation_failed`.


        For `verifications.updated`, set `config.include_resource = true` to
        include the full verification object in `data.resource`.
      tags:
        - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerWebhookSubscriptionRequest'
            example:
              events:
                - verifications.updated
              name: name-for-the-webhook-subscription
              url: https://your-webhook-backend.com
              secret: optional-secret
              config:
                include_resource: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PartnerVerificationWebhookMessage'
                  - $ref: >-
                      #/components/schemas/PartnerVerificationCreationFailedWebhookMessage
              examples:
                verifications_updated:
                  summary: Example Webhook Update
                  value:
                    event: verifications.updated
                    name: name-for-the-webhook-subscription
                    data:
                      user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                      verification: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                      client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                      resource:
                        id: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
                        user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                        client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                        created_at: '2023-03-09T16:22:06.081Z'
                        updated_at: '2023-03-09T16:22:06.081Z'
                        channel: api
                        status:
                          state: COMPLETED
                          code: completed
                          errors: []
                        report:
                          id: 2a14ce6f-3aed-4c15-8ea2-92a17b6edb95
                          type: doc-voi-mortgage
                          file_url: www.argyle.com/storagename/pdf
                          json_url: www.argyle.com/storagename/json
                        employments:
                          - employer: Starbucks
                            status: active
                            hire_date: '2015-08-28'
                            termination_date: null
                        loan:
                          number: '1234'
                          borrower_id: ABC789
                          application_id: '2121313'
                          officer_email: john.doe@mortgage.com
                        billing:
                          cost_center: '5'
                        data_source: documents
                verifications_creation_failed:
                  summary: Example Webhook Delivery
                  value:
                    event: verifications.creation_failed
                    name: name-for-the-webhook-subscription
                    data:
                      user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                      client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
                      context:
                        user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
                        attempted_at: '2023-03-09T16:22:06.081Z'
                        channel: encompass
                        data_source: banking
                        report_type: voa
                        loan:
                          number: '1234'
                          borrower_id: ABC789
                          application_id: '2121313'
                          officer_email: john.doe@mortgage.com
                        billing:
                          cost_center: '5'
  /partners/v2/user-uploads:
    post:
      summary: Upload a document
      description: Upload a document via the API.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - user
                - document_type
                - upload
              properties:
                user:
                  type: string
                  format: uuid
                  description: ID of the user object.
                document_type:
                  type: string
                  enum:
                    - paystubs
                    - W-2
                    - 1099
                    - proof-of-identity
                    - proof-of-address
                    - miscellaneous
                  description: The type of document.
                upload:
                  type: string
                  format: binary
                  description: |
                    Link to the document to be uploaded.

                    Max of 1 document per POST request.
      responses:
        '200':
          $ref: '#/components/responses/PartnerUserUploadResponse'
  /partners/v2/payroll-documents/{id}:
    get:
      summary: Retrieve a payroll document
      description: Retrieves a payroll document object.
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          description: ID of the payroll document object to be retrieved.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayrollDocument'
              example:
                id: 0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6
                account: 0187c66e-e7e5-811c-b006-2232f00f426a
                document_number: ced46eb3-7586-3cd7-2418-8eb9482bc3ec
                available_date: '2019-03-14T17:46:25Z'
                expiration_date: '2027-03-12T17:46:25Z'
                employer: GigAndGo
                employment: 42d6531c-520a-26b9-35c3-b7137a6d205a
                document_type: drivers-licence
                document_type_description: Driver's license
                file_url: api.argyle.com/partners/v2/payroll-documents/{id}/file
                created_at: '2023-03-13T17:46:28.240Z'
                updated_at: '2023-03-13T17:46:28.240Z'
                ocr_data: {}
                metadata: {}
  /partners/v2/payroll-documents:
    get:
      summary: List all payroll documents
      description: Returns a paginated list of all payroll document objects.
      parameters:
        - in: query
          name: user
          required: true
          schema:
            type: string
            format: uuid
          description: Filter by user ID.
        - in: query
          name: account
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by account ID.
        - in: query
          name: employment
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by employment ID.
        - in: query
          name: from_available_date
          required: false
          schema:
            type: string
            format: date-time
          description: >
            Filter for payroll documents with an `available_date` on or after
            this timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
        - in: query
          name: to_available_date
          required: false
          schema:
            type: string
            format: date-time
          description: >
            Filter for payroll documents with an `available_date` on or before
            this timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
        - in: query
          name: limit
          required: false
          schema:
            type: integer
          description: >
            Number of payroll document objects returned [per
            page](/api-guide/overview#pagination). Default: 10. Maximum: 200.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            The URL returned in `next` or `previous` used to retrieve another
            [page](/api-guide/overview#pagination) of results.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: URL for the next page of results, if available.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: URL for the previous page of results, if available.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayrollDocument'
              example:
                next: >-
                  https://api-sandbox.argyle.com/partners/v2/payroll-documents?cursor=ZXhhbXBsZV9jdXJzb3I
                previous: null
                results:
                  - id: 0186dc02-05b6-b83f-c366-b39a267e1570
                    account: 0185a8b8-60eb-80ca-7482-5f24504573f7
                    document_number: null
                    available_date: '2020-05-13T17:25:59Z'
                    expiration_date: null
                    employer: Whole Goods
                    employment: 0186a27d-e5c6-735a-a359-6315b34d544c
                    document_type: payout-statement
                    document_type_description: null
                    file_url: api.argyle.com/partners/v2/payroll-documents/{id}/file
                    created_at: '2023-03-13T17:27:01.501Z'
                    updated_at: '2023-03-13T17:27:01.501Z'
                    ocr_data: {}
                    metadata: {}
                  - id: 0176dc14-bb37-402a-7be1-f5261759fae7
                    account: 0187c66e-e7e5-811c-b006-2232f00f426a
                    document_number: ced46eb3-7586-3cd7-2418-8eb9482bc3ec
                    available_date: '2019-03-14T17:46:25Z'
                    expiration_date: '2027-03-12T17:46:25Z'
                    employer: GigAndGo
                    employment: 42d6531c-520a-26b9-35c3-b7137a6d205a
                    document_type: drivers-licence
                    document_type_description: Driver's license
                    file_url: api.argyle.com/partners/v2/payroll-documents/{id}/file
                    created_at: '2023-03-13T17:46:28.240Z'
                    updated_at: '2023-03-13T17:46:28.240Z'
                    ocr_data: {}
                    metadata: {}
  /partners/v2/paystubs/{id}:
    get:
      summary: Retrieve a paystub
      description: Retrieves a paystub object.
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          description: |
            ID of the paystub object to be retrieved.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerPaystub'
  /partners/v2/paystubs:
    get:
      summary: List all paystubs
      description: Returns a paginated list of all paystub objects.
      parameters:
        - in: query
          name: account
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by account ID.
        - in: query
          name: user
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by user ID.
        - in: query
          name: employment
          required: false
          schema:
            type: string
            format: uuid
          description: Filter by employment ID.
        - in: query
          name: from_start_date
          required: false
          schema:
            type: string
            format: date-time
          description: >
            Filter for paystubs with a `paystub_date` on or after this timestamp
            ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
        - in: query
          name: to_start_date
          required: false
          schema:
            type: string
            format: date-time
          description: >
            Filter for paystubs with a `paystub_date` on or before this
            timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
        - in: query
          name: limit
          required: false
          schema:
            type: integer
          description: >
            Number of paystubs objects returned [per
            page](/api-guide/overview#pagination). Default: 10. Maximum: 200.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            The URL returned in `next` or `previous` used to retrieve another
            [page](/api-guide/overview#pagination) of results.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: URL for the next page of results, if available.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: URL for the previous page of results, if available.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerPaystub'
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Username = api_key_id, Password = api_key_secret
  schemas:
    PartnerPaystub:
      type: object
      example:
        id: 0187dc99-63be-bc96-51bf-af6b51d43687
        account: 0187c66e-e7e5-811c-b006-2232f00f426a
        payroll_document: 0186eb89-2e52-b3c5-ac6d-05e7debb2aff
        deduction_list:
          - amount: '38.10'
            name: 401K
            tax_classification: pre_tax
            amount_ytd: '139.70'
          - amount: '25.40'
            name: Garnishment
            tax_classification: post_tax
            amount_ytd: '76.20'
          - amount: '25.40'
            name: Garnishment
            tax_classification: post_tax
            amount_ytd: '101.60'
        filing_status:
          - type: federal
            location: null
            status: married filing separately
          - type: state
            location: NY
            status: married filing separately
        tax_list:
          - amount: '88.91'
            name: Federal Withholding
            type: federal
            amount_ytd: '850.99'
          - amount: '139.72'
            name: Social Security Tax
            type: fica
            amount_ytd: '381.04'
        status: completed
        paystub_date: '2023-03-12T00:00:00Z'
        paystub_period:
          start_date: '2023-02-28T00:00:00Z'
          end_date: '2023-03-07T00:00:00Z'
        currency: USD
        gross_pay: '1607.63'
        deductions: '88.90'
        taxes: '228.63'
        net_pay: '1290.10'
        reimbursements: '0.00'
        hours: '49.60'
        fees: null
        net_pay_ytd: '12714.18'
        gross_pay_ytd: '15730.10'
        employer: Whole Goods
        employment: 0186a27d-e5c6-735a-a359-6315b34d544c
        employer_address:
          city: New York
          line1: 852 North W St
          line2: Apt 221
          state: NY
          country: US
          postal_code: '10014'
        created_at: '2023-03-13T19:53:57.122Z'
        updated_at: '2023-03-13T19:53:57.122Z'
        destinations:
          - reference: CHECKING *********2201
            amount: '1290.10'
            method: direct deposit
            ach_deposit_account:
              bank_name: NW Regional
              routing_number: null
              account_number: '*********2201'
            card: null
        hours_ytd: '422.00'
        deductions_ytd: '533.40'
        taxes_ytd: '2502.17'
        gross_pay_list:
          - name: Regular
            type: base
            start_date: '2023-02-28'
            end_date: '2023-03-07'
            rate: '25.6088'
            hours: '49.5977'
            amount: '1270.14'
            hours_ytd: '422.0000'
            amount_ytd: '13971.54'
          - name: Commission
            type: commission
            start_date: '2023-03-04'
            end_date: '2023-03-04'
            rate: null
            hours: null
            amount: '337.49'
            hours_ytd: null
            amount_ytd: '1758.56'
        gross_pay_list_totals:
          base:
            amount: '1270.14'
            amount_ytd: '13971.54'
            hours: '49.5977'
            hours_ytd: '422.0000'
            rate_implied: '25.6100'
            rate_implied_ytd: '33.1100'
          overtime: null
          commission:
            amount: '337.49'
            amount_ytd: '1758.56'
            hours: null
            hours_ytd: null
            rate_implied: null
            rate_implied_ytd: null
          bonus: null
          other: null
        metadata: null
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the paystub object.
        account:
          type: string
          format: uuid
          description: ID of the account associated with the paystub.
        payroll_document:
          type: string
          format: uuid
          description: >
            ID of the [payroll document
            object](/api-reference/payroll-documents#object) associated with
            this paystub.
        deduction_list:
          type: array
          items:
            $ref: '#/components/schemas/Deduction'
          description: >-
            An itemized list of deductions listed on the paystub. Each object
            corresponds to one line item.
        filing_status:
          type: array
          items:
            $ref: '#/components/schemas/FilingStatus'
          description: Information on the user's filing status.
        tax_list:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
          description: >-
            An itemized list of tax withholdings listed on the paystub. Each
            object corresponds to one line item.
        status:
          type: string
          enum:
            - completed
            - scheduled
            - cancelled
            - excluded
          description: >
            Payment status of the paystub.

            - `completed` — Payment has been made to the user.

            - `scheduled` — Payment is scheduled to be made to the user.

            - `cancelled` — Payment was cancelled, and was not nor will be paid
            to the user.

            - `excluded` — Tag used for dummy/sample/watermarked/test paystubs
            present in the account. These paystubs are excluded when generating
            reports and other calculations and should not be considered proof of
            income.
        paystub_date:
          type: string
          format: date-time
          description: >
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of
            the payment date, sourced from the paystub.
        paystub_period:
          type: object
          properties:
            start_date:
              type: string
              format: date-time
              description: >-
                Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601))
                of the start of the work period.
            end_date:
              type: string
              format: date-time
              description: >-
                Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601))
                of the end of the work period.
          description: Start date and end date of the work period.
        currency:
          type: string
          description: Currency code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).
        gross_pay:
          type: string
          description: Total gross pay from the paystub period before taxes or deductions.
        deductions:
          type: string
          description: Total amount of deductions from the paystub period.
        taxes:
          type: string
          description: Total tax amount from the paystub period.
        net_pay:
          type: string
          description: >-
            Net pay (gross pay minus taxes and deductions) from the paystub
            period.
        reimbursements:
          type: string
          description: Total reimbursement amount from the paystub period.
        hours:
          type: string
          description: Total hours worked during the paystub period.
        fees:
          type: string
          description: Total fees incurred during the paystub period.
        net_pay_ytd:
          type: string
          description: Net pay year-to-date, including this paystub.
        gross_pay_ytd:
          type: string
          description: Gross pay year-to-date, including this paystub.
        employer:
          type: string
          description: Employer name.
        employment:
          type: string
          description: >
            [Employment](/api-reference/employments) ID. Can be used as a filter
            when [listing paystubs](/api-reference/paystubs/list-all-paystubs).
        employer_address:
          type: object
          properties:
            city:
              type: string
              description: Name of the city, town, district, or similar regional entity.
            line1:
              type: string
              description: Address-Line 1, usually street address or P.O. Box information.
            line2:
              type: string
              description: Address-Line 2, usually the apartment or unit number.
            state:
              type: string
              description: State, county, province, region, or equivalent.
            country:
              type: string
              description: >-
                Two-letter country code ([ISO 3166-1
                alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                format).
            postal_code:
              type: string
              description: Zip code, or equivalent.
          description: >-
            Object containing employer address information, sourced from the
            paystub.
        created_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the paystub object was created.
        updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            a property value of the paystub object most recently changed.
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: Contains information on where and how pay was delivered to the user.
        hours_ytd:
          type: string
          description: >-
            Total hours worked year-to-date, including this paystub's work
            period.
        deductions_ytd:
          type: string
          description: Total deductions year-to-date, including amounts from this paystub.
        taxes_ytd:
          type: string
          description: Total taxes year-to-date, including amounts from this paystub.
        gross_pay_list:
          type: array
          items:
            $ref: '#/components/schemas/GrossPay'
          description: >-
            An itemized list of gross pay listed on the paystub. Each object
            corresponds to one line item.
        gross_pay_list_totals:
          type: object
          properties:
            base:
              $ref: '#/components/schemas/GrossPayTotal'
            overtime:
              $ref: '#/components/schemas/GrossPayTotal'
            commission:
              $ref: '#/components/schemas/GrossPayTotal'
            bonus:
              $ref: '#/components/schemas/GrossPayTotal'
            other:
              $ref: '#/components/schemas/GrossPayTotal'
          description: |
            Sums the values of `gross_pay_list` objects based on their `type`:
            * **base** = base + pto
            * **overtime** = overtime
            * **commission** = commission
            * **bonus** = bonus
            * **other** = disability + benefits + tips + stock + other
        metadata:
          type: object
          description: Additional, non-categorized information.
    Deduction:
      type: object
      properties:
        amount:
          type: string
          description: Amount of the deduction.
        name:
          type: string
          description: Name or description of the deduction.
        tax_classification:
          type: string
          enum:
            - pre_tax
            - post_tax
          description: |
            Tax classification.
            - `pre_tax`
            - `post_tax`
        amount_ytd:
          type: string
          description: >-
            Total amount deducted year-to-date, including the amounts from this
            paystub.
    FilingStatus:
      type: object
      properties:
        type:
          type: string
          enum:
            - federal
            - state
            - local
          description: |
            Tax authority.
            - `federal`
            - `state`
            - `local`
        location:
          type: string
          description: |
            Local jurisdiction. Values depend on `type`.
            - if type is `federal` — `null`
            - if type is `state` — state abbreviation code
            - if type is `local` — city name or area code
        status:
          type: string
          description: Marital status.
    Tax:
      type: object
      properties:
        amount:
          type: string
          description: Amount of the tax withholding.
        name:
          type: string
          description: Name or description of the tax withholding.
        type:
          type: string
          enum:
            - federal
            - state
            - local
            - fica
            - other
          description: |
            Payroll tax type.
            - `federal`
            - `state`
            - `local`
            - `fica`
            - `other`
        amount_ytd:
          type: string
          description: >
            Total tax withholdings year-to-date (specific to the tax `type`),
            including the amounts from this paystub.
    Destination:
      type: object
      properties:
        reference:
          type: string
          description: >-
            Describes where the payment was sent, such as a checking account or
            bank name.
        amount:
          type: string
          description: Pay amount sent to the destination.
        method:
          type: string
          description: Payment method, such as direct deposit.
        ach_deposit_account:
          type: object
          properties:
            bank_name:
              type: string
              description: Name of the bank account.
            routing_number:
              type: string
              description: Routing number of the bank account.
            account_number:
              type: string
              description: Account number of the bank account.
          description: Details for bank account destinations.
        card:
          type: object
          properties:
            name:
              type: string
              description: Name of the card where the payout was sent.
            number:
              type: string
              description: Card number.
          description: Details for payout card destinations.
    GrossPay:
      type: object
      properties:
        name:
          type: string
          description: Name or description of the gross pay line item.
        type:
          type: string
          enum:
            - base
            - pto
            - overtime
            - commission
            - bonus
            - disability
            - benefits
            - tips
            - stock
            - other
          description: >
            Categorized type of gross pay, based on `name`. Used in
            `gross_pay_list_totals`.

            - `base`

            - `pto`

            - `overtime`

            - `commission`

            - `bonus`

            - `disability`

            - `benefits`

            - `tips`

            - `stock`

            - `other`
        start_date:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of
            the start of the work period.
        end_date:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of
            the end of the work period.
        rate:
          type: string
          description: Hourly rate of gross pay earnings for this line item.
        hours:
          type: string
          description: Hours worked for this line item.
        amount:
          type: string
          description: Gross pay earned from this line item.
        hours_ytd:
          type: string
          description: >-
            Total hours worked year-to-date related to this gross pay line item,
            including this paystub's work period.
        amount_ytd:
          type: string
          description: >-
            Total gross pay earned year-to-date related to this gross pay line
            item, including this paystub.
    GrossPayTotal:
      type: object
      properties:
        amount:
          type: string
          description: Gross pay earned from line items of this type.
        amount_ytd:
          type: string
          description: >-
            Total gross pay earned year-to-date from line items of this type,
            including this paystub.
        hours:
          type: string
          description: Hours worked from line items of this type.
        hours_ytd:
          type: string
          description: >-
            Hours worked year-to-date from line items of this type, including
            this paystub.
        rate_implied:
          type: string
          description: Calculated ratio of `amount` to `hours` of gross pay list totals.
        rate_implied_ytd:
          type: string
          description: >-
            Calculated ratio of `amount_ytd` to `hours_ytd` of gross pay list
            totals.
    PartnerUserUpload:
      type: object
      example:
        id: 01320596-2c3d-189c-53e7-a8ce6d625b33
        account: 01856c65-43b6-8b5d-b32a-56b8fbda5c28
        document_type: proof-of-identity
        file_url: www.argyle.com/storagename
        file_name: my_drivers_license.pdf
        metadata:
          employment: null
          ocr_data: null
          ocr_authenticity: null
          ocr_authenticity_score: null
        processing:
          classification: unauthorized
          ocr: unauthorized
          authenticity: unauthorized
        created_at: '2024-07-08T13:43:49.864Z'
        updated_at: '2024-07-08T13:43:51.868Z'
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the uploaded document.
        account:
          type: string
          format: uuid
          description: ID of the account associated with the uploaded document.
        document_type:
          type: string
          description: >
            The document
            [category](/workflows/document-processing#enabling-document-uploads)
            in Link the user selected, or the `document_type` provided when
            [uploading via the API](/api-reference/user-uploads#upload).


            If [OCR processing](/integrations/ocr/ocrolus) is enabled, this
            value is overwritten when the document is found to be a different
            type.


            Possible values:

            - `paystubs`

            - `W-2`

            - `1099`

            - `proof-of-identity`

            - `proof-of-address`

            - `miscellaneous`
        file_url:
          type: string
          description: >
            URL linking to the original uploaded document file.


            This static URL redirects to a download page that requires [Argyle
            authentication headers](/api-guide/overview#authentication).


            **Implementation requirements for client-side applications**


            1. Ensure your HTTP client or library (for example, Axios or Python
            requests) is configured to follow redirects.

            2. Append [Basic authentication
            headers](/api-guide/overview#authentication) for Argyle to the file
            download request.
        file_name:
          type: string
          description: File name of the uploaded document on the user's computer or phone.
        metadata:
          type: object
          description: Contains document OCR and authenticity information.
          properties:
            employment:
              type: object
              deprecated: true
              description: Contains document verification data.
            ocr_data:
              type: object
              description: |
                Contains [Ocrolus OCR](/integrations/ocr/ocrolus#api) data.

                Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
            ocr_authenticity:
              type: object
              description: >
                Contains [Ocrolus authenticity](/integrations/ocr/ocrolus#api)
                data.


                Includes individual instances of tampering or other
                authenticity-related edits made to the uploaded document that
                were detected.


                Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
            ocr_authenticity_score:
              type: integer
              description: >
                [Ocrolus authenticity
                score](/integrations/ocr/ocrolus#authenticity-scores).


                Single score that captures the likelihood the uploaded document
                is authentic, as determined by Ocrolus.


                Available for paystubs, W-2s, and 1099s when Ocrolus is enabled.
        processing:
          type: object
          description: Contains OCR processing statuses.
          properties:
            classification:
              type: string
              enum:
                - unauthorized
                - idle
                - in_progress
                - completed
                - failed
              description: |
                OCR classification processing status.

                - `unauthorized`: Classification permissions are not enabled.
                - `idle`: Processing has not started.
                - `in_progress`: Processing is in progress.
                - `completed`: Processing successfully completed.
                - `failed`: Processing failed.
            ocr:
              type: string
              enum:
                - unauthorized
                - idle
                - in_progress
                - completed
                - failed
              description: |
                Full OCR processing status.

                - `unauthorized`: Full OCR permissions are not enabled.
                - `idle`: Processing has not started.
                - `in_progress`: Processing is in progress.
                - `completed`: Processing successfully completed.
                - `failed`: Processing failed.
            authenticity:
              type: string
              enum:
                - unauthorized
                - idle
                - in_progress
                - completed
                - failed
              description: |
                OCR authenticity processing status.

                - `unauthorized`: Full OCR permissions are not enabled.
                Full OCR permissions are required for authenticity.
                - `idle`: Processing has not started.
                - `in_progress`: Processing is in progress.
                - `completed`: Processing successfully completed.
                - `failed`: Processing failed.
        created_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the uploaded document was submitted.
        updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the user upload object was last updated.
    PayrollDocument:
      type: object
      example:
        id: 0176dc14-bb37-402a-7be1-f5261759fae7
        account: 0187c66e-e7e5-811c-b006-2232f00f426a
        document_number: ced46eb3-7586-3cd7-2418-8eb9482bc3ec
        available_date: '2021-03-14T17:46:25Z'
        expiration_date: null
        employer: GigAndGo
        employment: 42d6531c-520a-26b9-35c3-b7137a6d205a
        document_type: '1099'
        document_type_description: 1099 Form 2020
        file_url: api.argyle.com/partners/v2/payroll-documents/{id}/file
        created_at: '2023-03-13T17:46:28.240Z'
        updated_at: '2023-03-13T17:46:28.240Z'
        ocr_data:
          form_type: 1099-MISC
          omb_no: 1545-0115
          year: '2020'
          form:
            recipient:
              name: BOB JONES
              address:
                city: null
                country: null
                line1: 759 VICTORIA PLAZA
                line2: null
                postal_code: '10014'
                state: NY
            recipient_tin: 111-11-1112
            payer:
              name: WAREHOUSE SERVICES INC
              address:
                city: SEATTLE
                country: null
                line1: 202 WESTLAKE AVE N (55
                line2: null
                postal_code: '98109'
                state: WA
            payer_tin: 11-1111112
            account_no: 000110CHIC/NHO
            rent_1: null
            royalties_2: null
            other_inc_3: null
            fed_inc_4: null
            fishing_5: null
            med_care_6: null
            comp_7: null
            crop_insurance_10: null
            golden_parachute_13: null
            gross_attorney_14: null
            sec_409a_defer_15a: null
            sec_409a_inc_15b: null
            state_tax_16: null
            state_no_17: null
            state_inc: null
          warnings:
            - field_name: rent_1
              message: rent_1 value empty/bad format
              severity: 0
            - field_name: royalties_2
              message: royalties_2 value empty/bad format
              severity: 0
            - field_name: other_inc_3
              message: other_inc_3 value empty/bad format
              severity: 0
            - field_name: fed_inc_4
              message: fed_inc_4 value empty/bad format
              severity: 0
            - field_name: fishing_5
              message: fishing_5 value empty/bad format
              severity: 0
            - field_name: med_care_6
              message: med_care_6 value empty/bad format
              severity: 0
            - field_name: comp_7
              message: comp_7 not found
              severity: 0
            - field_name: crop_insurance_10
              message: crop_insurance_10 value empty/bad format
              severity: 0
            - field_name: golden_parachute_13
              message: golden_parachute_13 value empty/bad format
              severity: 0
            - field_name: gross_attorney_14
              message: gross_attorney_14 value empty/bad format
              severity: 0
            - field_name: sec_409a_defer_15a
              message: sec_409a_defer_15a value empty/bad format
              severity: 0
            - field_name: sec_409a_inc_15b
              message: sec_409a_inc_15b not found
              severity: 0
            - field_name: state_tax_16
              message: state_tax_16 value empty/bad format
              severity: 0
            - field_name: state_no_17
              message: state_no_17 value empty/bad format
              severity: 0
            - field_name: state_inc
              message: state_inc value empty/bad format
              severity: 0
          confidence: EXACT_MATCH
          ocr_page_count: 1
        metadata: null
      properties:
        id:
          type: string
          format: uuid
          description: >
            Unique ID of the payroll document object.


            Also the `payroll_document` ID value of the [paystub
            object](/api-reference/paystubs#object).
        account:
          type: string
          format: uuid
          description: ID of the account where the payroll document was sourced.
        document_number:
          type: string
          description: Identification number that appears on the payroll document.
        available_date:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the payroll document was made available to the user on the
            underlying payroll system.
        expiration_date:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            payroll document (such as a driver's license) expires.
        employer:
          type: string
          description: Employer name.
        employment:
          type: string
          description: >
            [Employment](/api-reference/employments) ID. Can be used as a filter
            when [listing payroll
            documents](/api-reference/verifications-partners/list-all-payroll-documents).
        document_type:
          type: string
          description: >-
            The type of payroll document, as returned by the payroll system. The
            following values are the most common, but document_type is not
            restricted to these values.
          enum:
            - payout-statement
            - W-2
            - W-4
            - W-9
            - 1095
            - 1095-C
            - 1099
            - profile-picture
            - drivers-license
            - vehicle-insurance
            - vehicle-registration
            - vehicle-inspection
            - other
        document_type_description:
          type: string
          description: Description of the payroll document type.
        file_url:
          type: string
          description: >
            URL linking to the original payroll document file.


            This static URL redirects to a download page that requires [Argyle
            authentication headers](/api-guide/overview#authentication). See the
            dropdown below for more information.


            **Implementation requirements for client-side applications**
              1. Ensure your HTTP client or library (e.g. Axios, Python requests, etc.) or similar tool is configured to pursue redirects. Most tools support this functionality.

              2. [Basic authentication headers](https://docs.argyle.com/api-guide/overview#authentication) for Argyle must be appended to the file download request.
        created_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the payroll document object was created.
        updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            a property value of the payroll document object most recently
            changed.
        ocr_data:
          type: object
          description: >
            Argyle scans and provides additional information for 1099 and W-2
            documents retrieved from connected payroll accounts.
          properties:
            form_type:
              type: string
              description: |
                The specific type of 1099 or W-2 document.

                  **W-2 and W-2c**
                    W-2: Wage and Tax Statement
                    W-2c: Corrected Wage and Tax Statement

                    - **`control_no_d`**: Identifies the W-2 in the payer's records.  
                    - **`comp_1`**: The amount of wages, tips, and other compensation.  
                    - **`fed_income_tax_2`**: The amount of federal income tax withheld.  
                    - **`ss_wages_3`**: The amount of social security wages.  
                    - **`ss_tax_4`**: The amount of social security tax withheld.  
                    - **`med_wages_5`**: The amount of Medicare wages and tips.  
                    - **`med_tax_6`**: The amount of Medicare tax withheld.  
                    - **`ss_tips_7`**: The amount of social security tips.  
                    - **`tips_8`**: The amount of allocated tips.  
                    - **`verification_9`**: Code used to identify the accuracy of the form's contents for electronic tax returns.  
                    - **`benefits_10`**: The amount of dependent care benefits.  
                    - **`nonqualified_11`**: The amount of contributions made to a non-qualified savings plan.  
                    - **`uncollected_ss_RRTA_12a`**: The amount of uncollected social security or RRTA tax on tips.  
                    - **`uncollected_med_tax_12b`**: The amount of uncollected Medicare tax on tips.  
                    - **`insurance_12c`**: The amount of taxable costs of group-term life insurance over $50,000.  
                    - **`plan_401k_12d`**: The amount of elective deferrals related to contributions to 401-k plans.  
                    - **`other_14`**: Used to report additional tax information.  
                    - **`employers_state_15`**: Lists the states for which the employer withheld the taxes and to which state the employer remitted the taxes, indicated by the employer's state ID number.  
                    - **`state_wages_16`**: The amount of state wages, tips, etc.  
                    - **`state_income_tax_17`**: The amount of state income tax.  
                    - **`local_wages_18`**: The amount of local wages, tips, etc.  
                    - **`local_income_tax_19`**: The amount of local income tax.  
                    - **`locality_name_20`**: The name of the locality where taxes indicated in the `local_income_tax_19` field are paid.  

                  **1099-NEC**
                    1099-NEC: Non-Employee Compensation

                    - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc.  
                    - **`comp_1`**: The amount of non-employee compensation.  
                    - **`fed_inc_tax_4`**: The amount of federal income tax withheld.  
                    - **`state_tax_5`**: The amount of state tax withheld.  
                    - **`state_no_6`**: The abbreviated name of the state and the payer's state tax identification number.  
                    - **`state_inc_7`**: The amount of state income.  

                  **1099-SSA**
                    1099-SSA: Social Security Benefits

                    - **`recipient_name_1`**: The name of the recipient.  
                    - **`benefits_3`**: The amount of benefits paid.  
                    - **`benefits_ssa_4`**: The amount of benefits repaid to the Social Security Administration (SSA).  
                    - **`net_benefits_5`**: The amount of net benefits.  
                    - **`fed_inc_tax_6`**: The amount of voluntary federal income tax withholding.  
                    - **`claim_no`**: The social security number under which a claim is filed or benefits are paid.  

                  **1099-MISC**
                    1099-MISC: Miscellaneous Income

                    - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc.  
                    - **`rent_1`**: The amount of rental income.  
                    - **`royalties_2`**: The amount of royalty income.  
                    - **`other_inc_3`**: Other income.  
                    - **`fed_inc_4`**: The amount of federal income tax withheld.  
                    - **`fishing_5`**: The amount of fishing boat proceeds.  
                    - **`med_care_6`**: The amount of medical and health care payment.  
                    - **`comp_7`**: The amount of non-employee compensation.  
                    - **`crop_insurance_10`**: The amount of crop insurance proceeds.  
                    - **`golden_parachute_13`**: The amount of excess golden parachute payments.  
                    - **`gross_attorney_14`**: The amount of gross proceeds paid to an attorney.  
                    - **`sec_409a_defer_15a`**: The amount of section 409A deferrals.  
                    - **`sec_409a_inc_15b`**: The amount of section 409A income.  
                    - **`state_tax_16`**: The amount of state tax withheld.  
                    - **`state_no_17`**: The abbreviated name of the state and the payer's state tax identification number.  
                    - **`state_inc`**: The amount of state income.  

                  **1099-INT**
                    1099-INT: Interest Income

                    - **`payer_rtn`**: The payer's RTN (Routing and Transit Number).  
                    - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc.  
                    - **`interest_1`**: The amount of interest income.  
                    - **`withdraw_penalty_2`**: The amount of early withdrawal penalty.  
                    - **`interest_obligations_3`**: The amount of interest earned on U.S. savings bonds or Treasury notes, bills, or bonds.  
                    - **`fed_inc_tax_4`**: The amount of federal income tax withheld.  
                    - **`investment_5`**: The amount of investment expenses.  
                    - **`foreign_tax_6`**: The amount of foreign tax paid.  
                    - **`foreign_possession_7`**: Shows the country or U.S. possession to which the foreign tax was paid.  

                  **1099-R**
                    1099-R: Distributions from Pensions and Annuities

                    - **`control_no`**: The code that uniquely identifies a particular 1099-R document in the employer's records.  
                    - **`gross_1`**: The amount of gross distribution.  
                    - **`tax_amount_2a`**: The amount of distribution that is taxable.  
                    - **`fed_inc_tax_4`**: The amount of federal income tax withheld.  
                    - **`distribution_code_7`**: A code that identifies the type of distribution received.  
                    - **`distribution_percent_9`**: The percentage of total distribution received.  
                    - **`state_tax_14`**: The amount of state tax withheld.  
                    - **`state_no_15`**: The abbreviated name of the state and the payer's state tax identification number.  

                  **1099-G**
                    1099-G: Certain Government Payments

                    - **`a_unemployment_comp_1`**: The amount of unemployment compensation.  
                    - **`a_state_inc_tax_2`**: The amount of state or local income tax refunds, credits, or offsets.  
                    - **`a_benefits_this_year_3`**: The amount of benefits repaid for the current year.  
                    - **`a_benefits_prev_year_3`**: The amount of benefits repaid for the previous year.  
                    - **`a_fed_inc_tax_4`**: The amount of federal income tax withheld.  
                    - **`b_unemployment_comp_1`**: The amount of unemployment compensation, paid family leave.  
                    - **`b_state_inc_tax_2`**: The amount of state or local income tax refunds, credits, or offsets.  
                    - **`b_benefits_this_year_3`**: The amount of benefits repaid for the current year.  
                    - **`b_benefits_prev_year_3`**: The amount of benefits repaid for the previous year.  
                    - **`b_fed_inc_tax_4`**: The amount of federal income tax withheld.  

                  **1099-K**
                    1099-K: Payment Card and Third Party Network Transactions

                    - **`pse_name_phone`**: Payment settlement entity's name and telephone number.  
                    - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc.  
                    - **`gross_1a`**: Gross amount of payment card/third-party network transactions.  
                    - **`gross_1b`**: The amount of Card Not Present transactions.  
                    - **`category_code_2`**: Merchant category code.  
                    - **`no_transactions_3`**: Number of payment transactions.  
                    - **`fed_inc_tax_4`**: The amount of federal income tax withheld.  
                    - **`january_5a`**: The total reportable payment transactions for this month.  
                    - **`february_5b`**: The total reportable payment transactions for this month.  
                    - **`march_5c`**: The total reportable payment transactions for this month.  
                    - **`april_5d`**: The total reportable payment transactions for this month.  
                    - **`may_5e`**: The total reportable payment transactions for this month.  
                    - **`june_5f`**: The total reportable payment transactions for this month.  
                    - **`july_5g`**: The total reportable payment transactions for this month.  
                    - **`august_5h`**: The total reportable payment transactions for this month.  
                    - **`september_5i`**: The total reportable payment transactions for this month.  
                    - **`october_5j`**: The total reportable payment transactions for this month.  
                    - **`november_5k`**: The total reportable payment transactions for this month.  
                    - **`december_5l`**: The total reportable payment transactions for this month.  
                    - **`state_6`**: State.  
                    - **`state_id_7`**: State identification number.  
                    - **`state_income_8`**: The amount of state income tax withheld.  
              enum:
                - W-2
                - W-2c
                - 1099-NEC
                - 1099-SSA
                - 1099-MISC
                - 1099-INT
                - 1099-R
                - 1099-G
                - 1099-K
            omb_no:
              type: string
              description: OMB reference number.
            year:
              type: string
              description: Calendar year.
            form:
              type: object
              description: Information scanned from the payroll document.
              properties:
                recipient:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Recipient name, as it appears on the form.
                    address:
                      type: object
                      description: Recipient address, as it appears on the form.
                      properties:
                        city:
                          type: string
                          description: >-
                            Name of the city, town, district, or similar
                            regional entity.
                        country:
                          type: string
                          description: >-
                            Two-letter country code ([ISO 3166-1
                            alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                            format).
                        line1:
                          type: string
                          description: >-
                            Address-Line 1, usually street address or P.O. Box
                            information.
                        line2:
                          type: string
                          description: >-
                            Address-Line 2, usually the apartment or unit
                            number.
                        postal_code:
                          type: string
                          description: Zip code, or equivalent.
                        state:
                          type: string
                          description: State, county, province, region, or equivalent.
                recipient_tin:
                  type: string
                  description: Recipient's tax identification number.
                payer:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Payer name, as it appears on the form.
                    address:
                      type: object
                      description: Payer address, as it appears on the form.
                      properties:
                        city:
                          type: string
                          description: >-
                            Name of the city, town, district, or similar
                            regional entity.
                        country:
                          type: string
                          description: >-
                            Two-letter country code ([ISO 3166-1
                            alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                            format).
                        line1:
                          type: string
                          description: >-
                            Address-Line 1, usually street address or P.O. Box
                            information.
                        line2:
                          type: string
                          description: >-
                            Address-Line 2, usually the apartment or unit
                            number.
                        postal_code:
                          type: string
                          description: Zip code, or equivalent.
                        state:
                          type: string
                          description: State, county, province, region, or equivalent.
                payer_tin:
                  type: string
                  description: Payer's tax identification number.
            warnings:
              type: array
              description: Information on scan quality and missing fields.
              items:
                type: object
                properties:
                  field_name:
                    type: string
                    description: Which field encountered the error.
                  message:
                    type: string
                    description: The `field_name` and warning message.
                    enum:
                      - not found
                      - value empty/bad format
                      - obfuscated
                      - obfuscated last two digits given
                      - obfuscated last four digits given
                      - >-
                        field_name had non numeric chars removed, original
                        value: <value>
                      - >-
                        field_name invalid - non numeric value, original value:
                        <value>
                  severity:
                    type: number
                    format: float
                    description: >
                      The severity of the encountered issue.


                      - `0.0`: The field was found, but its value was unclear or
                      obfuscated.

                      - `0.5`: A field or value was not found, but unclear if it
                      needed to be present.

                      - `1.0`: A field or value was not found.
                    enum:
                      - 0
                      - 0.5
                      - 1
            confidence:
              type: string
              description: >
                Indicator of how successful the scanning process went.


                - **`EXACT_MATCH`**: No errors found.  

                - **`HIGH`**: 1 error was found.  

                - **`MEDIUM`**: 2 errors were found.  

                - **`LOW`**: 3 errors were found.  

                - **`NO_MATCH`**: 4 or more errors were found. This typically
                indicates the document's `form_type` did not match the scanned
                document.  
              enum:
                - EXACT_MATCH
                - HIGH
                - MEDIUM
                - LOW
                - NO_MATCH
            ocr_page_count:
              type: integer
              description: Number of pages scanned.
            error:
              type: string
              description: >
                An error was encountered during document retrieval.


                - **`invalid_document`**: The document was empty, cropped,
                missing required fields, or otherwise incomplete.  

                - **`type_mismatch`**: The document does not match the
                classified type.  

                - **`unrecognized_document_type`**: The document could not be
                classified.  

                - **`unsupported_document_type`**: The document type is not
                supported.  

                - **`unsupported_document_subtype`**: The document sub-type
                (e.g., 1099-C) is not supported.  

                - **`unknown`**: An unknown issue occurred. The Argyle team will
                automatically be notified and will investigate.  
              enum:
                - invalid_document
                - type_mismatch
                - unrecognized_document_type
                - unsupported_document_type
                - unsupported_document_subtype
                - unknown
              nullable: true
        metadata:
          type: object
          description: Additional, non-categorized information.
    PartnerCreateUserResponse:
      type: object
      description: Response returned after creating a partner user.
      properties:
        user_token:
          type: string
          description: Token associated with the created user.
        id:
          type: string
          format: uuid
          description: Unique ID of the user.
    PartnerAddress:
      type: object
      description: Address of the user.
      properties:
        city:
          type: string
          description: Name of the city, town, district, or similar regional entity.
        line1:
          type: string
          description: Address-Line 1, usually street address or P.O. Box information.
        line2:
          type: string
          nullable: true
          description: Address-Line 2, usually the apartment or unit number.
        state:
          type: string
          description: State, county, province, region, or equivalent.
        country:
          type: string
          description: Two-letter country code (ISO 3166-1 alpha-2 format).
        postal_code:
          type: string
          nullable: true
          description: Zip code, or equivalent.
    PartnerBirthDate:
      type: object
      description: Date of birth in year-month-day format.
      properties:
        year:
          type: integer
          description: Birth year (1900 or later).
        month:
          type: integer
          description: Birth month (between 1 and 12).
        day:
          type: integer
          description: Birth day (between 1 and 31).
    PartnerOpenBankingEndUser:
      type: object
      description: Contains details about the person or entity making the lending decision.
      properties:
        name:
          type: string
          description: Name of the lender or entity.
        address:
          type: string
          description: >-
            Street address or P.O. Box information (include apartment or unit
            numbers).
        city:
          type: string
          description: Name of the city, town, district, or similar regional entity.
        state:
          type: string
          description: State, county, province, region, or equivalent.
        zip:
          type: string
          description: Zip code, or equivalent.
        phone:
          type: string
          description: Phone number of the lender or entity.
    PartnerOpenBanking:
      type: object
      description: Banking-specific user metadata.
      properties:
        end_user:
          $ref: '#/components/schemas/PartnerOpenBankingEndUser'
    PartnerUserCreateRequest:
      type: object
      properties:
        client:
          type: string
          format: uuid
          description: |
            ID of the client on whose behalf the user is created.

            <Info>
            Provided to you by your Argyle Customer Success manager.
            </Info>
        first_name:
          type: string
          description: User first name.
        last_name:
          type: string
          description: User last name.
        email:
          type: string
          description: User email address.
        phone_number:
          type: string
          description: User phone number. E.164 international format recommended.
        ssn:
          type: string
          description: User Social Security number.
        address:
          $ref: '#/components/schemas/PartnerAddress'
        birth_date:
          $ref: '#/components/schemas/PartnerBirthDate'
        external_metadata:
          type: object
          description: Additional metadata for internal partner workflows.
          additionalProperties: true
          properties:
            suppress_verification:
              type: boolean
              description: Set to `true` for banking and document verification workflows.
        open_banking:
          $ref: '#/components/schemas/PartnerOpenBanking'
        external_id:
          type: string
          nullable: true
          description: External identifier for your internal mapping.
      required:
        - client
    PartnerUserUpdateRequest:
      type: object
      properties:
        first_name:
          type: string
          description: User first name.
        last_name:
          type: string
          description: User last name.
        email:
          type: string
          description: User email address.
        phone_number:
          type: string
          description: User phone number.
        ssn:
          type: string
          description: User Social Security number.
        address:
          $ref: '#/components/schemas/PartnerAddress'
        birth_date:
          $ref: '#/components/schemas/PartnerBirthDate'
        external_metadata:
          type: object
          description: Additional metadata for internal partner workflows.
          additionalProperties: true
          properties:
            suppress_verification:
              type: boolean
              description: Set to `true` for banking and document verification workflows.
        open_banking:
          $ref: '#/components/schemas/PartnerOpenBanking'
        external_id:
          type: string
          nullable: true
          description: External identifier for your internal mapping.
    PartnerUser:
      type: object
      description: Partner user object.
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the user.
        created_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the user was created.
        items_connected:
          type: array
          items:
            type: string
          description: Items the user has connected through Link.
        employers_connected:
          type: array
          items:
            type: string
          description: Employers associated with the connected items.
        first_name:
          type: string
          description: User first name.
        last_name:
          type: string
          description: User last name.
        email:
          type: string
          description: User email address.
        phone_number:
          type: string
          description: User phone number.
        ssn:
          type: string
          description: User Social Security number.
        address:
          $ref: '#/components/schemas/PartnerAddress'
        birth_date:
          $ref: '#/components/schemas/PartnerBirthDate'
        external_metadata:
          type: object
          description: Additional metadata for internal partner workflows.
          additionalProperties: true
        external_id:
          type: string
          nullable: true
          description: External identifier for your internal mapping.
    PartnerSessionCreateConfiguration:
      type: object
      description: Connection session configuration for payroll and banking verifications.
      properties:
        experience:
          type: string
          format: uuid
          description: Banking only. Optional bank connection experience customization ID.
        single_use_url:
          type: boolean
          description: >-
            Banking only. If `true`, the session link expires after one
            successful connection.
        redirect_url:
          type: string
          nullable: true
          description: >-
            Payroll and banking. Optional redirect URL after session completion.
            Hosted/direct-launch flows should always set this. On desktop
            browsers, use a regular `https://` URL. For mobile app flows, use a
            custom scheme such as `your-custom-scheme://return-to-app`, or a
            Universal Link on iOS / App Link on Android. Universal Links and App
            Links are the more modern approach. You can include an
            application-owned state or nonce value to match the returning
            browser session to an internal user, session, or verification.
            Argyle appends `user_submission_complete` and
            `user_attempted_employer_selection`, which mirror the
            [`onClose`](/link/reference/callbacks#onclose) fields.
        flow_id:
          type: string
          description: >-
            Payroll only. Optional payroll embedded connection experience
            customization ID.
        items:
          type: array
          description: >-
            Payroll only. Limits Link to the provided Items. If one Item is
            provided, Link skips search and opens that Item's login screen. If
            multiple Items are provided, Link shows only those Items.
          items:
            type: string
          example:
            - item_000000001
            - item_000000002
        language:
          type: string
          enum:
            - EN
            - ES
            - RU
            - ZH
          description: >-
            Payroll only. Supported Link [display
            language](/link/initialization/overview#optional-initialization-parameters).
        mobile_app:
          type: boolean
          description: >-
            Payroll only. Set to `true` when the session is used in a mobile
            app, including Hosted Link opened in a secure browser context.
    PartnerSessionConfiguration:
      allOf:
        - $ref: '#/components/schemas/PartnerSessionCreateConfiguration'
    PartnerSessionCreateRequest:
      type: object
      properties:
        verification:
          type: string
          format: uuid
          description: ID of the verification used to initialize the session.
        configuration:
          $ref: '#/components/schemas/PartnerSessionCreateConfiguration'
      required:
        - verification
    PartnerSession:
      type: object
      description: Partner connection session object.
      properties:
        verification:
          type: string
          format: uuid
          description: Verification ID associated with the session.
        configuration:
          $ref: '#/components/schemas/PartnerSessionConfiguration'
        link:
          type: string
          description: >-
            URL used to launch the payroll or banking frontend experience. For
            payroll, use it as `connectUrl` when initializing the [Web
            SDK](/link/initialization/web#initialize-with-connecturl); the
            returned session URL already determines whether the session runs in
            Sandbox or Production. Alternatively, open it directly for [Hosted
            Link](/link/initialization/hosted-link). For banking, use it to
            launch either an Embedded banking session or a Hosted banking
            session. Session links expire after one hour. A new session link can
            be created at any time by creating another session for the active
            verification.
        data_source:
          type: string
          enum:
            - payroll
            - banking
          description: Source of connection data.
    PartnerVerificationListResponse:
      type: object
      description: Paginated list of partner verification objects.
      properties:
        next:
          type: string
          format: uri
          nullable: true
          description: URL for the next page of results, if available.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL for the previous page of results, if available.
        results:
          type: array
          items:
            $ref: '#/components/schemas/PartnerVerification'
    PartnerVerification:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the verification.
        user:
          type: string
          format: uuid
          description: ID of the user associated with the verification.
        client:
          type: string
          format: uuid
          description: ID of the client on whose behalf the verification was requested.
        created_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the verification was requested.
        updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when
            the verification object was last updated.
        channel:
          type: string
          enum:
            - api
            - encompass
          example: api
          description: Origin of the verification order.
        status:
          $ref: '#/components/schemas/PartnerVerificationStatus'
        report:
          $ref: '#/components/schemas/PartnerVerificationReport'
        employments:
          type: array
          description: List of employments for the user. Documents only.
          items:
            $ref: '#/components/schemas/PartnerVerificationEmployment'
        loan:
          $ref: '#/components/schemas/PartnerVerificationLoan'
        billing:
          $ref: '#/components/schemas/PartnerVerificationBilling'
        data_source:
          type: string
          enum:
            - payroll
            - banking
            - documents
          description: Source of verification data.
    PartnerVerificationStatus:
      type: object
      description: Verification status information.
      properties:
        state:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - PAUSED
            - CANCELLED
            - COMPLETED
          description: >
            Verification state.


            - `PENDING` - Initial status after verification is created.

            - `PROCESSING` - Verification processing is underway.

            - `PAUSED` - Verification is paused because more data or documents
            are required.

            - `CANCELLED` - Verification has been cancelled.

            - `COMPLETED` - Verification is complete and report assets are
            available.
        code:
          type: string
          enum:
            - pending
            - documents_processing
            - more_data_required
            - report_available
            - waiting_on_third_party
            - report_generating
            - argyle_timeout
            - cancelled_by_client
            - completed
            - completed_with_errors
            - user_session_started
            - authenticated
          description: >-
            Verification status code.


            For `doc-voi-mortgage` report types:

            - `pending` - Verification created.

            - `documents_processing` - Documents processing.

            - `more_data_required` - More data or documents are needed to
            complete the verification.

            - `report_available` - Data and documents are sufficient to complete
            verification.

            - `waiting_on_third_party` - Awaiting processing by a third party.

            - `report_generating` - Report is currently generating.

            - `argyle_timeout` - Verification request has been cancelled by
            Argyle after 180 days of inactivity.

            - `cancelled_by_client` - Verification has been cancelled.

            - `completed` - Verification request complete. Report can be
            retrieved.

            - `completed_with_errors` - Verification request completed. Report
            can be retrieved but is not GSE eligible.


            For payroll and banking report types:

            - `pending` - Verification created.

            - `user_session_started` - User opened the payroll or banking
            connection experience.

            - `authenticated` - User authenticated for payroll or banking; data
            aggregation is in progress.

            - `completed` - Report is ready for download.
        errors:
          type: array
          description: >
            Error information.


            Error details can explain what caused a `PAUSED` state or prevented
            GSE eligibility for a `COMPLETED` document verification.
          items:
            $ref: '#/components/schemas/PartnerVerificationError'
    PartnerVerificationError:
      type: object
      description: Verification error details.
      properties:
        code:
          type: string
          description: Error code.
        title:
          type: string
          description: Error title.
        message:
          type: string
          description: Error message.
        resources:
          type: array
          description: >-
            Additional troubleshooting resources (for example, the ID of an
            unmatched document).
          items:
            $ref: '#/components/schemas/PartnerVerificationErrorResource'
      example:
        code: self-employed_income
        title: Self-employed income
        message: Self-employed income cannot be assessed using Paystub and W2 Data.
        resources:
          - id: null
            type: employments
            name: Freelance Consulting LLC
    PartnerVerificationErrorResource:
      type: object
      description: Verification error resource details.
      properties:
        id:
          type: string
          nullable: true
          description: ID of the associated resource, if available.
        type:
          type: string
          description: Resource type.
        name:
          type: string
          description: Resource name.
    PartnerReportCustomField:
      type: object
      description: Custom field returned in report JSON as a pass-through value.
      properties:
        label:
          type: string
          description: Custom field name.
        value:
          type: string
          description: Custom field value.
        shown:
          type: boolean
          description: Show custom field on report PDF.
    PartnerVerificationReportConfiguration:
      type: object
      description: Optional banking report configurations.
      properties:
        bank_accounts:
          type: array
          items:
            type: string
          description: >-
            List of [bank account](/api-reference/bank-accounts) IDs to be
            included in the report.
        from_date:
          type: string
          format: date-time
          description: >
            Restrict report to data from on or after this datetime ([ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601)).


            - `VOAI` reports - controls the length of asset history

            - `VOA` reports - controls the length of asset history

            - `VOI` reports - controls the length of income history
        income_from_date:
          type: string
          format: date-time
          description: >
            Restrict report to data from on or after this datetime ([ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601)).


            - `VOAI` reports - controls the length of income history

            - Does not apply to `VOA` or `VOI` reports.
        income_stream_confidence_minimum:
          type: integer
          minimum: 0
          maximum: 100
          description: >
            Limit income streams used in the report to those above this
            confidence value (`0-100` accepted).


            Only available for `VOI` and `VOAI` report types.
        report_custom_fields:
          type: array
          maxItems: 5
          description: >-
            Include up to `5` custom objects in the report metadata. Often used
            for identifying information.
          items:
            $ref: '#/components/schemas/PartnerReportCustomField'
    PartnerVerificationReport:
      type: object
      description: Report information.
      properties:
        id:
          type: string
          format: uuid
          nullable: true
          description: |
            Unique ID of the report.

            Only available when verification state is `COMPLETED`.
        type:
          type: string
          enum: &ref_2
            - voie
            - voe
            - voa
            - voi
            - voai
            - voe-transactions
            - doc-voi-mortgage
          description: >-
            The type of report.


            Payroll:

            - `voie` - Verification of Income and Employment.

            - `voe` - Verification of Employment.


            Banking:

            - `voa` - Banking verification of assets.

            - `voi` - Banking verification of income.

            - `voai` - Banking verification of income and assets.

            - `voe-transactions` - Banking verification of employment.


            Documents:

            - `doc-voi-mortgage` - Document-based verification of income,
            integrated with Freddie Mac's AIM Check.
        file_url:
          type: string
          nullable: true
          example: www.argyle.com/storagename/pdf
          description: >
            Download link to the report PDF.


            Requires [Argyle authentication
            headers](/api-guide/overview#authentication). Only available when
            verification state is `COMPLETED`.
        json_url:
          type: string
          nullable: true
          example: www.argyle.com/storagename/json
          description: >
            Download link to the report in JSON.


            Requires [Argyle authentication
            headers](/api-guide/overview#authentication). Only available when
            verification state is `COMPLETED`.
        configuration:
          $ref: '#/components/schemas/PartnerVerificationReportConfiguration'
    PartnerVerificationEmployment:
      type: object
      description: Employment details for the user.
      properties:
        employer:
          type: string
          description: Name of the employer.
        status:
          type: string
          enum:
            - active
            - previous
          description: User's current employment status at this employer.
        hire_date:
          type: string
          format: date
          description: >-
            Employment start date in [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        termination_date:
          type: string
          format: date
          nullable: true
          description: >-
            Employment end date in [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601) format. `null` when
            employment `status` is `active`.
    PartnerVerificationEmploymentRequest:
      allOf:
        - $ref: '#/components/schemas/PartnerVerificationEmployment'
        - type: object
          required:
            - employer
            - status
            - hire_date
    PartnerVerificationLoan:
      type: object
      description: Optional loan details.
      properties:
        number:
          type: string
          description: Loan number or identifier.
        borrower_id:
          type: string
          description: Borrower identifier.
        application_id:
          type: string
          description: Application identifier.
        officer_email:
          type: string
          description: Email of the loan officer requesting the verification.
    PartnerVerificationBilling:
      type: object
      description: Optional billing details.
      properties:
        cost_center:
          type: string
          description: Cost center identifier.
    PartnerVerificationCreateReportRequest:
      type: object
      description: Report request configuration.
      properties:
        type:
          type: string
          enum: *ref_2
          description: >-
            The type of report to generate.


            Payroll:

            - `voie` - Verification of Income and Employment.

            - `voe` - Verification of Employment.


            Banking:

            - `voa` - Banking verification of assets.

            - `voi` - Banking verification of income.

            - `voai` - Banking verification of income and assets.

            - `voe-transactions` - Banking verification of employment.


            Documents:

            - `doc-voi-mortgage` - Document-based verification of income,
            integrated with Freddie Mac's AIM Check.
        configuration:
          allOf:
            - $ref: '#/components/schemas/PartnerVerificationReportConfiguration'
            - description: Optional banking report configurations.
      required:
        - type
    PartnerVerificationRefreshReportRequest:
      type: object
      description: Report request configuration for refresh requests.
      properties:
        type:
          type: string
          enum:
            - voie
            - voe
            - voa
            - voi
            - voai
            - voe-transactions
            - doc-voi-mortgage
          description: >-
            Payroll, banking, or Doc VOI report type to generate.


            Payroll:

            - `voie` - Verification of Income and Employment.

            - `voe` - Verification of Employment.


            Banking:

            - `voa` - Banking verification of assets.

            - `voi` - Banking verification of income.

            - `voai` - Banking verification of income and assets.

            - `voe-transactions` - Banking verification of employment.


            Documents:

            - `doc-voi-mortgage` - Document-based verification of income,
            integrated with Freddie Mac's AIM Check.
        configuration:
          allOf:
            - $ref: '#/components/schemas/PartnerVerificationReportConfiguration'
            - description: Optional banking report configurations.
      required:
        - type
    PartnerVerificationCreateRequest:
      type: object
      description: |-
        Request body for ordering a verification.

        - `user` and `report` are required for all requests.
        - `employments` is required for document verifications only.
        - `report.configuration` is used for banking verifications only.
      properties:
        user:
          type: string
          format: uuid
          description: User ID for the verification.
        employments:
          type: array
          description: >-
            List of employments for the user.


            Required for document verifications only. Not used for payroll or
            banking verifications.
          items:
            $ref: '#/components/schemas/PartnerVerificationEmploymentRequest'
        report:
          $ref: '#/components/schemas/PartnerVerificationCreateReportRequest'
        loan:
          $ref: '#/components/schemas/PartnerVerificationLoan'
        billing:
          $ref: '#/components/schemas/PartnerVerificationBilling'
      required:
        - user
        - report
    PartnerVerificationRefreshRequest:
      type: object
      properties:
        user:
          type: string
          format: uuid
          description: User ID for the verification refresh.
        report:
          $ref: '#/components/schemas/PartnerVerificationRefreshReportRequest'
        loan:
          $ref: '#/components/schemas/PartnerVerificationLoan'
        billing:
          $ref: '#/components/schemas/PartnerVerificationBilling'
      required:
        - user
        - report
    PartnerVerificationUpdateRequest:
      type: object
      description: >
        Request body for updating a verification.


        - `loan` and `billing` can be updated for either data source.

        - `employments` can only be updated when a document verification is in
        the `PAUSED` state.

        - Updating `employments` replaces the full employments array.
      properties:
        loan:
          $ref: '#/components/schemas/PartnerVerificationLoan'
        billing:
          $ref: '#/components/schemas/PartnerVerificationBilling'
        employments:
          type: array
          description: Updated list of employments for the user.
          items:
            $ref: '#/components/schemas/PartnerVerificationEmploymentRequest'
    PartnerWebhookSubscriptionRequest:
      type: object
      properties:
        events:
          type: array
          description: '`verifications.updated` or `verifications.creation_failed`'
          items:
            type: string
            enum:
              - verifications.updated
              - verifications.creation_failed
            example: verifications.updated
        name:
          type: string
          example: name-for-the-webhook-subscription
          description: Your name for the webhook subscription.
        url:
          type: string
          example: https://your-webhook-backend.com
          description: >-
            Where you want to receive webhook delivery. Argyle handles URL
            encoding for webhook URLs. Send the URL in its normal, unencoded
            form.
        secret:
          type: string
          example: optional-secret
          description: Optional secret used to verify webhooks.
        config:
          type: object
          description: Optional webhook delivery configuration.
          example:
            include_resource: true
      required:
        - events
        - name
        - url
    PartnerVerificationWebhookMessage:
      type: object
      properties:
        event:
          type: string
          description: '`verifications.updated`'
          example: verifications.updated
        name:
          type: string
          description: Name used for the webhook subscription.
        data:
          type: object
          properties:
            user:
              type: string
              format: uuid
              description: ID of the user.
              example: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
            verification:
              type: string
              format: uuid
              description: ID of the verification.
              example: 43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b
            client:
              type: string
              format: uuid
              description: ID of the client.
              example: 39096494-45c8-4fd8-9454-3d1cb2d62db7
            resource:
              $ref: '#/components/schemas/PartnerVerification'
    PartnerVerificationCreationFailedWebhookMessage:
      type: object
      properties:
        event:
          type: string
          description: '`verifications.creation_failed`'
          example: verifications.creation_failed
        name:
          type: string
          description: Name used for the webhook subscription.
        data:
          type: object
          properties:
            user:
              type: string
              format: uuid
              description: ID of the user.
              example: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
            client:
              type: string
              format: uuid
              description: ID of the client.
              example: 39096494-45c8-4fd8-9454-3d1cb2d62db7
            context:
              $ref: '#/components/schemas/PartnerVerificationCreationFailedContext'
      example:
        event: verifications.creation_failed
        name: name-for-the-webhook-subscription
        data:
          user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
          client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
          context:
            user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
            attempted_at: '2023-03-09T16:22:06.081Z'
            channel: encompass
            data_source: banking
            report_type: voa
            loan:
              number: '1234'
              borrower_id: ABC789
              application_id: '2121313'
              officer_email: john.doe@mortgage.com
            billing:
              cost_center: '5'
    PartnerVerificationCreationFailedContext:
      type: object
      properties:
        user:
          type: string
          format: uuid
          description: ID of the user.
          example: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
        attempted_at:
          type: string
          format: date-time
          description: Time when Argyle attempted to create the verification.
          example: '2023-03-09T16:22:06.081Z'
        channel:
          type: string
          description: Channel where verification creation was attempted.
          example: encompass
        data_source:
          type: string
          description: Data source requested for the verification.
          example: banking
        report_type:
          type: string
          description: Report type requested for the verification.
          example: voa
        loan:
          $ref: '#/components/schemas/PartnerVerificationLoan'
        billing:
          $ref: '#/components/schemas/PartnerVerificationBilling'
  responses:
    PartnerUserUploadResponse:
      description: A user upload object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PartnerUserUpload'