API schema

All endpoints have the base URL set to: https://tapp-api.typless.com

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

[External] Invoice text blocks

get

Query parameters

inv_keystring · uuidRequired

page_numberinteger · max: 100Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/v1/invoice/text-blocks

HTTPcURLJavaScriptPython

GET /api/v1/invoice/text-blocks?inv_key=123e4567-e89b-12d3-a456-426614174000&page_number=1 HTTP/1.1
Accept: */*

No content

[External] Poll invoice blocks

get

Query parameters

inv_keystring · uuidRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/v1/poll-invoice/blocks

HTTPcURLJavaScriptPython

GET /api/v1/poll-invoice/blocks?inv_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Accept: */*

No content

[External] Download batch url

get

Query parameters

poll_keystring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/v1/batch/download-urls

HTTPcURLJavaScriptPython

GET /api/v1/batch/download-urls?poll_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Accept: */*

{
  "file_name": "text",
  "documents_in_file": [
    {
      "file_name": "text",
      "url": "text"
    }
  ]
}

[External] Poll batch document

get

Query parameters

poll_keystring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/v1/batch/poll-document

HTTPcURLJavaScriptPython

GET /api/v1/batch/poll-document?poll_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Accept: */*

{
  "status": "IN_PROGRESS",
  "results": [
    {
      "extraction_id": "123e4567-e89b-12d3-a456-426614174000",
      "results": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "error": "text"
}