Skip to main content
POST
Add an item to a checklist template

Authorizations

Authorization
string
header
required

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.

Path Parameters

template
string
required

The checklist template id, from list_checklist_templates.

Required string length: 1 - 60

Body

application/json
kind
enum<string>
required

document asks for a file upload; questions is a short form; connect_banks asks the client to connect their banks through open banking and finishes by itself when they do.

Available options:
document,
questions,
connect_banks
title
string
required
Maximum string length: 200
help
string · null · null

One line shown under the title.

Maximum string length: 300
required
boolean | null

Default true.

questions
object[] | null

For a questions item: 1 to 30.

prefill_from_facts
boolean | null

For a questions item: fill answers from the client’s accepted document facts when there are any. The client can change them.

Response

Created.

object
enum<string>
required
Available options:
checklist_template
id
string
required
name
string
required
description
string | null
required
clients
number
required

Clients that were sent a copy.

created_at
string
required

An ISO 8601 time in UTC.

updated_at
string
required

An ISO 8601 time in UTC.

items
object[]
required