Skip to main content
GET
/
document_intelligence
/
{id}
Get Document Intelligence
curl --request GET \
  --url https://connect.penbox.io/v1/document_intelligence/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "attachments": [
    {
      "name": "<string>",
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "results": {
    "fields": [
      {
        "key": "firstname",
        "name": "firstname",
        "type": "text",
        "value": "Jane",
        "confidence": "high"
      },
      {
        "key": "lastname",
        "name": "lastname",
        "type": "text",
        "value": "Doe",
        "confidence": "high"
      },
      {
        "key": "number",
        "name": "id card number",
        "type": "text",
        "value": "000-0000000-00",
        "confidence": "high"
      },
      {
        "key": "birthday",
        "name": "date de naissance",
        "hint": "DD MMM YYYY",
        "type": "text",
        "value": "01 JAN 1990",
        "confidence": "high"
      }
    ],
    "validation": {
      "is_valid": true,
      "is_blurry": false,
      "user_explanation": "All required fields were successfully extracted from the document."
    },
    "document_type": "ID Card"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "language": "<string>",
  "creator": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com"
  },
  "usage": {
    "input": 123,
    "output": 123,
    "total": 123,
    "pages": 123
  }
}
Retrieve the results of a document intelligence extraction job.
The results object contains the extracted field values with the same keys you specified when creating the job. Values are automatically typed based on the field type (text, number, or date).

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Path Parameters

id
string<uuid>
required

Document intelligence job UUID

Response

200 - application/json

Successful response

id
string<uuid>
required

Document intelligence job UUID

created_at
string<date-time>
required

Job creation timestamp

attachments
object[]
required

Array of processed documents

results
object
required

Extraction results: the extracted fields, a validation assessment, and the detected document type.

Example:
{
"fields": [
{
"key": "firstname",
"name": "firstname",
"type": "text",
"value": "Jane",
"confidence": "high"
},
{
"key": "lastname",
"name": "lastname",
"type": "text",
"value": "Doe",
"confidence": "high"
},
{
"key": "number",
"name": "id card number",
"type": "text",
"value": "000-0000000-00",
"confidence": "high"
},
{
"key": "birthday",
"name": "date de naissance",
"hint": "DD MMM YYYY",
"type": "text",
"value": "01 JAN 1990",
"confidence": "high"
}
],
"validation": {
"is_valid": true,
"is_blurry": false,
"user_explanation": "All required fields were successfully extracted from the document."
},
"document_type": "ID Card"
}
updated_at
string<date-time>

Last update timestamp

language
string

Document language detected or specified

creator
object

User who created the job

usage
object

Token usage statistics for the AI processing