Skip to main content
POST
Approve a checklist item

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

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
item
string
required

The checklist item id, from list_client_checklists.

Required string length: 1 - 60

Body

application/json

The body is of type object.

Response

Success.

object
enum<string>
required
Available options:
checklist_item
id
string
required
checklist_id
string
required
position
number
required
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
help
string | null
required
required
boolean
required
questions
object[]
required
prefill_from_facts
boolean
required
state
enum<string>
required

todo (waiting for the client), submitted (waiting for the firm to review), changes_requested (sent back with a note), done.

Available options:
todo,
submitted,
changes_requested,
done
change_note
string | null
required

What the firm asked to change, while the item is changes_requested.

submitted_at
string | null
required

An ISO 8601 time in UTC.

submitted_by
string | null
required
reviewed_at
string | null
required

An ISO 8601 time in UTC.

reviewed_by
string | null
required
documents
object[]
required
answers
object[]
required