Skip to main content
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
file
/
fetch
cURL
curl \
-H 'x-ti-app-id: 1234567890' \
-H 'x-ti-secret-code: 1234567890' \
'https://docflow.textin.ai/api/app-api/sip/platform/v2/file/fetch?workspace_id=1234567890&batch_number=202412190001'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "total": 100,
    "page": 1,
    "page_size": 20,
    "files": [
      {
        "id": 202412190001,
        "task_id": 202412190001,
        "task_type": 1,
        "batch_number": 202412190001,
        "name": "invoice.pdf",
        "format": "<string>",
        "recognition_status": 0,
        "verification_status": 0,
        "category": "invoice",
        "pages": [
          {
            "angle": 0,
            "width": 1024,
            "height": 1024,
            "dpi": 144
          }
        ],
        "data": {
          "fields": [
            {
              "key": "Invoice Code",
              "value": "3100231130",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "key": "Invoice Number",
              "value": "28737000",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "items": [
            [
              {
                "key": "Goods and Services Name",
                "value": "＊Electronic Computer＊Microcomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "Specification Model",
                "value": "DMS-SC68",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ],
            [
              {
                "key": "Goods and Services Name",
                "value": "＊Mechanical Computer＊Supercomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "Specification Model",
                "value": "AN/FSQ-7",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ]
          ],
          "tables": [
            {
              "tableName": "table1",
              "tableType": 0,
              "items": [
                [
                  {
                    "key": "<string>",
                    "value": "<string>",
                    "textInLines": [
                      "<any>"
                    ],
                    "index": 123
                  }
                ]
              ]
            }
          ],
          "stamps": [
            {
              "angel": 0,
              "page": 0,
              "text": "National Unified Invoice Supervision Seal",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "Tax Bureau Seal",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            }
          ],
          "handwritings": [
            {
              "angel": 0,
              "page": 0,
              "text": "March 1st",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "Zhang San",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "invoiceVerifyResult": {
            "invoiceVerifyStatus": 0,
            "invoiceVerifyErrorCode": 0,
            "invoiceVerifyCanRetry": 0,
            "invoiceVerifyFailMsg": "Exceeded daily limit"
          }
        },
        "document": {
          "pages": [
            {}
          ]
        },
        "child_files": [
          {
            "id": 202412190001,
            "task_id": 202412190001,
            "task_type": 1,
            "parent_task_id": 202412190001,
            "batch_number": 202412190001,
            "name": "invoice.pdf",
            "format": "<string>",
            "recognition_status": 0,
            "verification_status": 0,
            "category": "invoice",
            "pages": [
              {
                "angle": 0,
                "width": 1024,
                "height": 1024,
                "dpi": 144
              }
            ],
            "data": {
              "fields": [
                {
                  "key": "Invoice Code",
                  "value": "3100231130",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "key": "Invoice Number",
                  "value": "28737000",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "items": [
                [
                  {
                    "key": "Goods and Services Name",
                    "value": "＊Electronic Computer＊Microcomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "Specification Model",
                    "value": "DMS-SC68",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ],
                [
                  {
                    "key": "Goods and Services Name",
                    "value": "＊Mechanical Computer＊Supercomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "Specification Model",
                    "value": "AN/FSQ-7",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ]
              ],
              "tables": [
                {
                  "tableName": "table1",
                  "tableType": 0,
                  "items": [
                    [
                      "<any>"
                    ]
                  ]
                }
              ],
              "stamps": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "National Unified Invoice Supervision Seal",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "Tax Bureau Seal",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ],
              "handwritings": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "March 1st",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "Zhang San",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "invoiceVerifyResult": {
                "invoiceVerifyStatus": 0,
                "invoiceVerifyErrorCode": 0,
                "invoiceVerifyCanRetry": 0,
                "invoiceVerifyFailMsg": "Exceeded daily limit"
              }
            },
            "document": {
              "pages": [
                {}
              ]
            },
            "from_parent_position_list": [
              1
            ],
            "crop_info": {
              "page": 123,
              "imageAngle": "<string>"
            }
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-ti-app-id
string
header
required
​
x-ti-secret-code
string
header
required

Query Parameters

​
page
integer
default:1

Page number, default 1

​
page_size
integer
default:1000

Number of items per page, default 1000

​
workspace_id
string
required

Workspace ID

​
batch_number
string

Batch Number

​
file_id
string

File ID

​
category
string

File Category

​
recognition_status
enum<integer>

File recognition status 0: Pending recognition 1: Recognition successful 2: Recognition failed

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
10
​
verification_status
enum<integer>

File verification status 0: Pending verification 2: Confirmed 3: Rejected 4: Deleted 5: Deferred processing

Available options:
0,
2,
3,
4,
5
​
start_time
string<date-time>

Start time for search by update time, RFC3339 format (YYYY-MM-DDTHH:MM:SSZ)

Example:

"2024-01-01T00:00:00.000Z"

​
end_time
string<date-time>

End time for search by update time, RFC3339 format (YYYY-MM-DDTHH:MM:SSZ)

Example:

"2024-01-01T10:00:00.000Z"

​
with_document
boolean
default:false

Whether to return the complete text recognition result of the document

Response

200 - application/json

Successfully retrieved file list

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description

​
result
object
⌘I