Supplemental Documents

Supplemental Documents are uploaded files connected to an Entity during onboarding.

The Supplemental Document object

{
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "idempotency_key": null,
  "type": "entity_supplemental_document"
}

Attributes

created_at

string

The ISO 8601 time at which the Supplemental Document was created.

entity_id

string

The Entity the supplemental document is attached to.

More about Entities.

file_id

string

The File containing the document.

More about Files.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

type

string

A constant representing the object’s type. For this resource it will always be entity_supplemental_document.

List Entity Supplemental Document Submissions

curl \
  --url "${INCREASE_URL}/entity_supplemental_documents?entity_id=entity_n8y8tnk2p9339ti393yi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const entitySupplementalDocument of client.supplementalDocuments.list({
  entity_id: 'entity_id',
})) {
  console.log(entitySupplementalDocument.entity_id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.supplemental_documents.list(
    entity_id="entity_id",
)
page = page.data[0]
print(page.entity_id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.supplemental_documents.list(entity_id: "entity_id")

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.SupplementalDocuments.List(context.TODO(), increase.SupplementalDocumentListParams{
		EntityID: increase.F("entity_id"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.supplementaldocuments.SupplementalDocumentListPage;
import com.increase.api.models.supplementaldocuments.SupplementalDocumentListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        SupplementalDocumentListParams params = SupplementalDocumentListParams.builder()
            .entityId("entity_id")
            .build();
        SupplementalDocumentListPage page = client.supplementalDocuments().list(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.supplementaldocuments.SupplementalDocumentListPage
import com.increase.api.models.supplementaldocuments.SupplementalDocumentListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: SupplementalDocumentListParams = SupplementalDocumentListParams.builder()
        .entityId("entity_id")
        .build()
    val page: SupplementalDocumentListPage = client.supplementalDocuments().list(params)
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->supplementalDocuments->list(
    entityID: 'entity_id', cursor: 'cursor', idempotencyKey: 'x', limit: 1
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.SupplementalDocuments;

IncreaseClient client = new();

SupplementalDocumentListParams parameters = new() { EntityID = "entity_id" };

var page = await client.SupplementalDocuments.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Returns a list response :

{
  "data": [
    { /* Supplemental Document object */ },
    { /* Supplemental Document object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

entity_id

string

Required

The identifier of the Entity to list supplemental documents for.

More about Entities.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

cursor

string

limit

integer

Create a supplemental document for an Entity

curl -X "POST" \
  --url "${INCREASE_URL}/entity_supplemental_documents" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "file_id": "file_makxrc67oh9l6sg7w9yc"
  }'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const entitySupplementalDocument = await client.supplementalDocuments.create({
  entity_id: 'entity_n8y8tnk2p9339ti393yi',
  file_id: 'file_makxrc67oh9l6sg7w9yc',
});

console.log(entitySupplementalDocument.entity_id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
entity_supplemental_document = client.supplemental_documents.create(
    entity_id="entity_n8y8tnk2p9339ti393yi",
    file_id="file_makxrc67oh9l6sg7w9yc",
)
print(entity_supplemental_document.entity_id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

entity_supplemental_document = increase.supplemental_documents.create(
  entity_id: "entity_n8y8tnk2p9339ti393yi",
  file_id: "file_makxrc67oh9l6sg7w9yc"
)

puts(entity_supplemental_document)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	entitySupplementalDocument, err := client.SupplementalDocuments.New(context.TODO(), increase.SupplementalDocumentNewParams{
		EntityID: increase.F("entity_n8y8tnk2p9339ti393yi"),
		FileID:   increase.F("file_makxrc67oh9l6sg7w9yc"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", entitySupplementalDocument.EntityID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.supplementaldocuments.EntitySupplementalDocument;
import com.increase.api.models.supplementaldocuments.SupplementalDocumentCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        SupplementalDocumentCreateParams params = SupplementalDocumentCreateParams.builder()
            .entityId("entity_n8y8tnk2p9339ti393yi")
            .fileId("file_makxrc67oh9l6sg7w9yc")
            .build();
        EntitySupplementalDocument entitySupplementalDocument = client.supplementalDocuments().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.supplementaldocuments.EntitySupplementalDocument
import com.increase.api.models.supplementaldocuments.SupplementalDocumentCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: SupplementalDocumentCreateParams = SupplementalDocumentCreateParams.builder()
        .entityId("entity_n8y8tnk2p9339ti393yi")
        .fileId("file_makxrc67oh9l6sg7w9yc")
        .build()
    val entitySupplementalDocument: EntitySupplementalDocument = client.supplementalDocuments().create(params)
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $entitySupplementalDocument = $client->supplementalDocuments->create(
    entityID: 'entity_n8y8tnk2p9339ti393yi', fileID: 'file_makxrc67oh9l6sg7w9yc'
  );

  var_dump($entitySupplementalDocument);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.SupplementalDocuments;

IncreaseClient client = new();

SupplementalDocumentCreateParams parameters = new()
{
    EntityID = "entity_n8y8tnk2p9339ti393yi",
    FileID = "file_makxrc67oh9l6sg7w9yc",
};

var entitySupplementalDocument = await client.SupplementalDocuments.Create(parameters);

Console.WriteLine(entitySupplementalDocument);

Parameters

entity_id

string

Required

The identifier of the Entity to associate with the supplemental document.

More about Entities.

file_id

string

Required

The identifier of the File containing the document.

More about Files.