increase-test
POST/entity_supplemental_documents

Create a supplemental document for an entity

Creates a supplemental document submission for an entity during onboarding. Supply entity_id to associate the document with an entity and file_id to identify the file containing it. Supplemental documents are only needed for programs that require them.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

The entity and file associated with the supplemental document submission.

entity_idstringrequired
The identifier of the Entity to associate with the supplemental document.
file_idstringrequired
The identifier of the File containing the document.

3 status codes
200Returns the created supplemental document object, including its entity identifier, file identifier, and creation time.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created.
entity_idstringrequired
The Entity the supplemental document is attached to.
file_idstringrequired
The File containing the document.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
typestringrequired
A constant representing the object's type. For this resource it will always be `entity_supplemental_document`.
Allowed:entity_supplemental_document
4XXReturned when the request has a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

entity_id and file_id are both required. entity_id identifies the entity receiving the submission, and file_id identifies the file containing the document.