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

# Fill a library form for a client

> Starts a fill of a form from the firm’s Forms for one client and fills every field it can from the client’s facts, people, accounts and the firm. Give people to say which client person is each person on the form; with one of each it is set for you. To fill a blank PDF instead, use create_form_fill_upload.



## OpenAPI

````yaml /openapi/advisor.json post /clients/{client}/form_fills
openapi: 3.1.0
info:
  title: Redbark Advisor API
  version: 2.0.0
  description: >-
    Read and write access to one advice firm in Redbark Advisor: clients,
    checklists, documents, money, messages, reports, team and webhooks. Send an
    API key or a connected app’s access token as a bearer token. A credential
    carries scopes, one read and one write per area, and each call says the
    scope it needs. A write scope brings its read scope. Each key may make 120
    requests a minute.
servers:
  - url: https://advisor.redbark.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Firm
    description: The firm, its name and its branding.
  - name: Team
    description: Team members and their roles.
  - name: Clients
    description: Clients, their people and portal invites.
  - name: Checklists
    description: Checklist templates, the checklists sent to clients and their answers.
  - name: Documents
    description: Documents clients upload and the details read from them.
  - name: Money
    description: Bank connections, accounts, balances and transactions.
  - name: Document types
    description: Document types, their fields and the client facts they fill.
  - name: Forms
    description: Forms filled for clients, their values, and the firm’s Forms library.
  - name: Messages
    description: Messages between the firm and clients.
  - name: Reports
    description: Reports exported for clients.
  - name: Meetings
    description: Client meetings, their agendas, transcripts, File notes and actions.
  - name: Webhooks
    description: Webhook endpoints and their deliveries.
  - name: Webhook events
    description: Events sent to your webhook endpoints.
paths:
  /clients/{client}/form_fills:
    post:
      tags:
        - Forms
      summary: Fill a library form for a client
      description: >-
        Starts a fill of a form from the firm’s Forms for one client and fills
        every field it can from the client’s facts, people, accounts and the
        firm. Give people to say which client person is each person on the form;
        with one of each it is set for you. To fill a blank PDF instead, use
        create_form_fill_upload.
      operationId: create_form_fill
      parameters:
        - name: client
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The client id, from list_clients.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                form_id:
                  type: string
                  minLength: 1
                  maxLength: 60
                  description: The library form, from list_forms.
                people:
                  anyOf:
                    - type: array
                      items:
                        type: object
                        properties:
                          role:
                            type: string
                            minLength: 1
                            maxLength: 60
                            description: A role key from the fill’s roles.
                          person_id:
                            type: string
                            minLength: 1
                            maxLength: 60
                            description: A person of the client, from get_client.
                        required:
                          - role
                          - person_id
                        additionalProperties: true
                      maxItems: 20
                    - type: 'null'
              required:
                - form_id
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormFillDetail'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key or access token is missing, wrong, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            subscription_required: the firm has no active subscription, so it
            cannot add or invite clients or send checklists. plan_seat_limit:
            the firm’s plan has no room for the change, such as a second advisor
            on Solo or a 21st team member on Firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The credential lacks the scope this call needs, the call is for
            admins only, or the member it acts as has left the firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The resource is in a state that does not allow this, such as an
            archived client.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. See the Retry-After header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something went wrong on our side. Try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - forms:write
components:
  schemas:
    FormFillDetail:
      type: object
      properties:
        object:
          type: string
          enum:
            - form_fill
        id:
          type: string
        number:
          type: number
        client_id:
          type: string
        name:
          type: string
        form_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The library form it was filled from, or null for a one-off upload.
        layout_id:
          type: string
        group_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Fills made together for each member of a couple share it.
        status:
          type: string
          enum:
            - draft
            - waiting_on_client
            - ready
          description: >-
            draft (values to check or missing), waiting_on_client (asked through
            a checklist item) or ready (nothing left to check or give; it can be
            downloaded).
        detection:
          type: string
          enum:
            - waiting
            - running
            - ready
            - failed
          description: >-
            Finding the form’s fields: waiting or running while we read a new
            form, ready, or failed.
        mapped:
          type: boolean
          description: >-
            Whether the form’s fields are matched to sources yet. A new form
            takes up to two minutes.
        people:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                description: The place on the form, such as applicant_1.
              person_id:
                type: string
            required:
              - role
              - person_id
            additionalProperties: true
          description: Which client person is each person on the form.
        checklist_item_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The checklist item that asked the client for the missing fields.
        counts:
          type: object
          properties:
            filled:
              type: number
            to_check:
              type: number
            missing:
              type: number
            left_for_client:
              type: number
          required:
            - filled
            - to_check
            - missing
            - left_for_client
          additionalProperties: true
          description: How many fields are in each state.
        created_at:
          type: string
          description: An ISO 8601 time in UTC.
        updated_at:
          type: string
          description: An ISO 8601 time in UTC.
        downloaded_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        page_count:
          type: number
        kind:
          type: string
          enum:
            - acroform
            - flat
            - scanned
          description: acroform (a fillable PDF), flat or scanned.
        roles:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
            required:
              - key
              - label
            additionalProperties: true
          description: The people the form is about. Set who each is with update_form_fill.
        mapping_version:
          anyOf:
            - type: number
            - type: 'null'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FormField'
      required:
        - object
        - id
        - number
        - client_id
        - name
        - form_id
        - layout_id
        - group_id
        - status
        - detection
        - mapped
        - people
        - checklist_item_id
        - counts
        - created_at
        - updated_at
        - downloaded_at
        - page_count
        - kind
        - roles
        - mapping_version
        - fields
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              anyOf:
                - type: string
                - type: 'null'
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          additionalProperties: true
      required:
        - error
      additionalProperties: true
    FormField:
      type: object
      properties:
        id:
          type: string
        page:
          type: number
          description: From 1.
        box:
          type: object
          properties:
            left:
              type: number
            top:
              type: number
            width:
              type: number
            height:
              type: number
          required:
            - left
            - top
            - width
            - height
          additionalProperties: true
          description: Where the field sits, as fractions of the page.
        type:
          type: string
          enum:
            - text
            - checkbox
            - radio
            - dropdown
            - option_list
            - signature
            - table
            - unknown
        label:
          type: string
        section:
          anyOf:
            - type: string
            - type: 'null'
        options:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
            required:
              - value
              - label
            additionalProperties: true
          description: The choices of a radio, dropdown or option list field.
        source:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Where the field fills from, such as fact.salary, person.given_names,
            firm.name, today, left_for_client or unknown.
        role:
          anyOf:
            - type: string
            - type: 'null'
        format:
          anyOf:
            - type: string
            - type: 'null'
        agreement:
          anyOf:
            - type: number
            - type: 'null'
          description: The share of matching runs that chose the source, 0 to 1.
      required:
        - id
        - page
        - box
        - type
        - label
        - section
        - options
        - source
        - role
        - format
        - agreement
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A firm API key, shown once when it is made, or a connected app’s OAuth
        access token. Each operation lists the scope it needs, such as
        clients:write.

````

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