Make a document type

curl --request POST \
  --url https://advisor.redbark.com/api/v1/document_types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', description: '<string>'})
};

fetch('https://advisor.redbark.com/api/v1/document_types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://advisor.redbark.com/api/v1/document_types"

payload = {
    "label": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "object": "document_type",
  "id": "<string>",
  "key": "<string>",
  "label": "<string>",
  "description": "<string>",
  "group": "banking",
  "origin": "redbark",
  "holds": "values",
  "archived": true,
  "field_count": 123,
  "fact_keys": [
    "<string>"
  ],
  "read_last_30_days": 123,
  "sections": [
    {
      "label": "<string>",
      "fields": [
        {
          "object": "document_type_field",
          "id": "<string>",
          "key": "<string>",
          "label": "<string>",
          "type": "text",
          "section": "<string>",
          "required": true,
          "instruction": "<string>",
          "origin": "redbark",
          "archived": true,
          "fact_key": "<string>"
        }
      ]
    }
  ],
  "read_document": {
    "document_id": "<string>",
    "started": true,
    "message": "<string>"
  },
  "unplaced_queued": 123
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

Document types

Make a document type

Makes a document type of the firm’s own, with a key made from the label (firm_ and a slug). From now on the reader sorts files into it, told the description. holds is values (read into its fields) or file (kept as a file, no fields). Fields take the shape of add_document_type_field; each may name fact_key, or new_fact to make a client fact in the same step. read_document_id reads that document again as the new type once it is made. sort_unplaced_since_days sorts again the firm’s documents the reader could not place in that many days (count_unplaced_documents says how many); the answer says how many were queued. suggestion_id deletes the suggestion it was made from. The name must differ from every type the firm has. The label and description are refused like a field’s. A label or instruction that asks for a tax file number, an identity document number, a government reference number or medical details is refused (value_never_kept). Only an admin can call this.

POST

document_types

curl --request POST \
  --url https://advisor.redbark.com/api/v1/document_types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', description: '<string>'})
};

fetch('https://advisor.redbark.com/api/v1/document_types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://advisor.redbark.com/api/v1/document_types"

payload = {
    "label": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "object": "document_type",
  "id": "<string>",
  "key": "<string>",
  "label": "<string>",
  "description": "<string>",
  "group": "banking",
  "origin": "redbark",
  "holds": "values",
  "archived": true,
  "field_count": 123,
  "fact_keys": [
    "<string>"
  ],
  "read_last_30_days": 123,
  "sections": [
    {
      "label": "<string>",
      "fields": [
        {
          "object": "document_type_field",
          "id": "<string>",
          "key": "<string>",
          "label": "<string>",
          "type": "text",
          "section": "<string>",
          "required": true,
          "instruction": "<string>",
          "origin": "redbark",
          "archived": true,
          "fact_key": "<string>"
        }
      ]
    }
  ],
  "read_document": {
    "document_id": "<string>",
    "started": true,
    "message": "<string>"
  },
  "unplaced_queued": 123
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>"
  }
}

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.

Body

application/json

label

string

required

Required string length: 1 - 80

description

string

required

What kind of document it is, in a sentence or two. The reader is told this when it sorts a file, so say how to recognise one.

Required string length: 1 - 300

group

enum<string>

required

The heading it is picked under: banking (Banking and loans), income (Income and tax), investments (Investments and super), property (Property and insurance), structure (Entities and structure), other (Other).

Available options:

banking,

income,

investments,

property,

structure,

other

holds

enum<string>

required

values: values on the page are read into its fields. file: kept as a file, nothing read. Fixed once made.

Available options:

values,

file

fields

object[] | null

Maximum array length: 40

Show child attributes

read_document_id

string · null · null

A document id, from list_documents.

Required string length: 1 - 60

sort_unplaced_since_days

integer · null · null

1 to 365.

Required range: 1 <= x <= 365

suggestion_id

string · null · null

The suggestion it was made from, from suggest_document_type.

Required string length: 1 - 60

Response

Created.

object

enum<string>

required

Available options:

document_type

string | null

required

Null for a built-in type.

key

string

required

Such as payslip or super_statement, or firm_ and a slug for the firm's own.

label

string

required

description

string

required

group

enum<string>

required

Available options:

banking,

income,

investments,

property,

structure,

other

origin

enum<string>

required

redbark for Redbark's own, which cannot be changed; firm for the firm's own.

Available options:

redbark,

firm

holds

enum<string>

required

values: values on the page are read into its fields. file: kept as a file, nothing read. Fixed once made.

Available options:

values,

file

archived

boolean

required

A firm type no longer sorted into or offered. Documents already read as it keep it.

field_count

number

required

Fields read from new documents: built-in and the firm’s, archived ones left out.

fact_keys

string[]

required

The client facts its fields fill.

read_last_30_days

number

required

Documents of this type read in the last 30 days.

sections

object[]

required

Show child attributes

read_document

object | null

required

The document read again as the new type, when one was named.

Show child attributes

unplaced_queued

number | null

required

How many unplaced documents were queued to be sorted again, when sort_unplaced_since_days was given.

Guides

Firm

Team

Clients

Checklists

Documents

Money

Document types

Messages

Reports

Webhooks

Webhook events

Make a document type

Authorizations

Body

Response