v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

File Uploads

Finalize Image Group

Finalize an image group and construct a <glossary:Document> from its images.

After you have uploaded images, call this endpoint to finalize an image group and construct a <glossary:Document> from its content.

📘 The term image group refers to a collection of images that may consist of one or more images.

Here is the list of all the Additional Supported Form Types we support. For more information, please contact your Account Executive or Customer Success Executive to discuss other options for your organization.

post/v1/book/upload/image/done

Request body

book_uuidstring

The unique identifer of the <glossary:Book> that the newly-constructed <glossary:Document> will be saved to. Mutually exclusive with pk.

pkstring

The <glossary:PK> of the <glossary:Book> that the newly-constructed <glossary:Document> will be saved to. Mutually exclusive with book_uuid.

form_typestring

The code identifying the type of <glossary:Document> that the uploaded images represent.

Example request

{
  "pk": 30219565,
  "book_uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
  "form_type": "PAYSTUB"
}

Response

200

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

responseobject

An object received from the server that potentially contains data.

Example response

{
  "status": 200,
  "message": "OK"
}