OCocrolus
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 <<glossary:Image group>> and construct a <glossary:Document> from its content.

post/v1/book/upload/image/done

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/upload/image/done
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

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.

pkinteger

The primary key <glossary:PK> of the Book that the newly-constructed 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

Success

OR

Example response

{
  "status": 200,
  "message": "OK",
  "response": {
    "image_bucket_uuid": "8dc88eed-2b6f-414a-82f2-a99bd181cf6e",
    "image_group_pk": 87479,
    "uploaded_doc_uuid": "e3f2f66a-2792-439e-905f-240c33a84bd1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.