INincrease

Create a Supplemental Document

Changed on
post/entity_supplemental_documents

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/entity_supplemental_documents
  • Auth
    HTTP bearer

Request body

entity_idstring required

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

file_idstring required

The identifier of the File containing the document.

Example request

{
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "file_id": "file_makxrc67oh9l6sg7w9yc"
}

Response

Supplemental Document

created_atstring date-time required

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

entity_idstring required

The Entity the supplemental document is attached to.

file_idstring required

The File containing the document.

idempotency_keystring nullable required

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'entity_supplemental_document' required

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

Example response

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

Changes

  • d410a6abb15dRevision changes
    • info

      api operation id create_a_supplemental_document_for_an_entity removed and replaced with create_a_supplemental_document

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status