openapi: 3.0.1
info:
  title: Truv Admin Employment API
  description: Truv provides consumer-permissioned access to payroll, income, and employment data. This specification covers the Truv REST API for managing users, minting bridge tokens, working with links, and retrieving employment, income, pay statement, direct deposit, insurance, identity, and banking data, plus orders, tasks, and webhooks.
  termsOfService: https://truv.com/terms-of-service/
  contact:
    name: Truv Support
    email: support@truv.com
    url: https://docs.truv.com
  version: '1.0'
servers:
- url: https://prod.truv.com
  description: Truv production API
security:
- accessClientId: []
  accessSecret: []
tags:
- name: Employment
  description: Verification of employment data and reports.
paths:
  /v1/links/{link_id}/employment/:
    parameters:
    - $ref: '#/components/parameters/LinkId'
    get:
      operationId: getEmployment
      tags:
      - Employment
      summary: Retrieve employment data for a link.
      responses:
        '200':
          description: Employment data.
          content:
            application/json:
              schema:
                type: object
  /v1/links/{link_id}/employments/:
    parameters:
    - $ref: '#/components/parameters/LinkId'
    get:
      operationId: listEmployments
      tags:
      - Employment
      summary: List all employments for a link.
      responses:
        '200':
          description: A list of employments.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
  /v1/links/{link_id}/employment/report/:
    parameters:
    - $ref: '#/components/parameters/LinkId'
    get:
      operationId: getEmploymentReport
      tags:
      - Employment
      summary: Retrieve the employment verification report for a link.
      responses:
        '200':
          description: An employment report.
          content:
            application/json:
              schema:
                type: object
components:
  parameters:
    LinkId:
      name: link_id
      in: path
      required: true
      schema:
        type: string
      description: The ID of the link.
  securitySchemes:
    accessClientId:
      type: apiKey
      in: header
      name: X-Access-Client-Id
      description: Your Truv access client ID.
    accessSecret:
      type: apiKey
      in: header
      name: X-Access-Secret
      description: Your Truv access secret.