Retrieve Extractions

Retrieve extraction by ID

Use this endpoint in conjunction with asynchronous extraction requests to retrieve your results. You can also use this endpoint to retrieve the results for documents extractions from the synchronous /extract endpoint. To poll extraction status, check the status field in this endpoint’s response. When the extraction completes, the returned status is COMPLETE and the response includes results in the parsed_document field. For fields in the extraction for which Sensible couldn’t find a value, Sensible returns null.

GET

documents

{id}

curl --request GET \
  --url https://api.sensible.so/v0/documents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "246a6f60-0e5b-11eb-b720-295a6fba723e",
  "created": "2022-10-31T16:27:53.433Z",
  "type": "auto_insurance_quotes_all_carriers",
  "status": "COMPLETE",
  "configuration": "config_for_x_company",
  "parsed_document": {
    "policy_number": {
      "type": "number",
      "value": 123456789,
      "lines": [
        {
          "text": "123456789",
          "page": 0,
          "boundingPolygon": [
            {
              "x": 6.458,
              "y": 2.601
            },
            {
              "x": 7.354,
              "y": 2.601
            },
            {
              "x": 7.354,
              "y": 2.767
            },
            {
              "x": 6.458,
              "y": 2.767
            }
          ]
        }
      ]
    },
    "name_insured": {
      "type": "string",
      "value": "Petar Petrov",
      "lines": [
        {
          "text": "Petar Petrov",
          "page": 0,
          "boundingPolygon": [
            {
              "x": 1,
              "y": 5.515
            },
            {
              "x": 1.935,
              "y": 5.515
            },
            {
              "x": 1.935,
              "y": 5.674
            },
            {
              "x": 1,
              "y": 5.674
            }
          ]
        }
      ]
    }
  },
  "validations": [
    {
      "description": "Policy number must be 11 digits",
      "severity": "error"
    },
    {
      "description": "Company email must be in format string@string",
      "severity": "skipped",
      "message": "Missing prerequisites - company_email"
    }
  ],
  "file_metadata": {
    "metadata": {},
    "error": "Error retrieving PDF metadata: Invalid PDF structure",
    "info": {
      "author": "Jay S. Schiller",
      "title": "file123",
      "creator": "macOS Version 11.2 (Build 20D64) Quartz PDFContext",
      "producer": "Preview",
      "creation_date": "2022-08-02T18:09:31.000Z",
      "modification_date": "2022-08-03T15:09:23.000Z",
      "error": "<string>"
    }
  },
  "validation_summary": {
    "fields": 6,
    "fields_present": 4,
    "errors": 0,
    "warnings": 1,
    "skipped": 1
  },
  "errors": [
    {
      "field_id": "phone_number",
      "message": "ConfigurationError: width <=0",
      "type": "configuration"
    }
  ],
  "completed": "2022-10-31T16:27:53.741Z",
  "classification_summary": [
    {
      "configuration": "config_for_x_company",
      "fingerprints": 2,
      "fingerprints_present": 2,
      "score": {
        "value": 3,
        "fields_present": 4,
        "penalities": 0.5
      }
    },
    {
      "configuration": "acme_co",
      "fingerprints": 2,
      "fingerprints_present": 2,
      "score": {
        "value": 0,
        "fields_present": 2,
        "penalities": 1.5
      }
    }
  ],
  "page_count": 100,
  "environment": "development",
  "document_name": "example.pdf",
  "coverage": 0.75,
  "download_url": "https://sensible-so-document-type-bucket-dev-us-west-2.s3.us-west-2.amazonaws.com/sensible/fc3484c5-3f35-4129-bb29-0ad1291ee9f8/EXTRACTION/246a6f60-0e5b-11eb-b720-295a6fba723e.pdf?AWSAccessKeyId=REDACTED"
}

Authorizations

Authorization

string

header

required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Path Parameters

string

required

Unique ID for the extraction, used to retrieve the extraction.

Example:

"246a6f60-0e5b-11eb-b720-295a6fba723e"

Response

200

application/json

Returns the extraction.

The response is of type object.

Extract portfolio at your URL List extractions

curl --request GET \
  --url https://api.sensible.so/v0/documents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "246a6f60-0e5b-11eb-b720-295a6fba723e",
  "created": "2022-10-31T16:27:53.433Z",
  "type": "auto_insurance_quotes_all_carriers",
  "status": "COMPLETE",
  "configuration": "config_for_x_company",
  "parsed_document": {
    "policy_number": {
      "type": "number",
      "value": 123456789,
      "lines": [
        {
          "text": "123456789",
          "page": 0,
          "boundingPolygon": [
            {
              "x": 6.458,
              "y": 2.601
            },
            {
              "x": 7.354,
              "y": 2.601
            },
            {
              "x": 7.354,
              "y": 2.767
            },
            {
              "x": 6.458,
              "y": 2.767
            }
          ]
        }
      ]
    },
    "name_insured": {
      "type": "string",
      "value": "Petar Petrov",
      "lines": [
        {
          "text": "Petar Petrov",
          "page": 0,
          "boundingPolygon": [
            {
              "x": 1,
              "y": 5.515
            },
            {
              "x": 1.935,
              "y": 5.515
            },
            {
              "x": 1.935,
              "y": 5.674
            },
            {
              "x": 1,
              "y": 5.674
            }
          ]
        }
      ]
    }
  },
  "validations": [
    {
      "description": "Policy number must be 11 digits",
      "severity": "error"
    },
    {
      "description": "Company email must be in format string@string",
      "severity": "skipped",
      "message": "Missing prerequisites - company_email"
    }
  ],
  "file_metadata": {
    "metadata": {},
    "error": "Error retrieving PDF metadata: Invalid PDF structure",
    "info": {
      "author": "Jay S. Schiller",
      "title": "file123",
      "creator": "macOS Version 11.2 (Build 20D64) Quartz PDFContext",
      "producer": "Preview",
      "creation_date": "2022-08-02T18:09:31.000Z",
      "modification_date": "2022-08-03T15:09:23.000Z",
      "error": "<string>"
    }
  },
  "validation_summary": {
    "fields": 6,
    "fields_present": 4,
    "errors": 0,
    "warnings": 1,
    "skipped": 1
  },
  "errors": [
    {
      "field_id": "phone_number",
      "message": "ConfigurationError: width <=0",
      "type": "configuration"
    }
  ],
  "completed": "2022-10-31T16:27:53.741Z",
  "classification_summary": [
    {
      "configuration": "config_for_x_company",
      "fingerprints": 2,
      "fingerprints_present": 2,
      "score": {
        "value": 3,
        "fields_present": 4,
        "penalities": 0.5
      }
    },
    {
      "configuration": "acme_co",
      "fingerprints": 2,
      "fingerprints_present": 2,
      "score": {
        "value": 0,
        "fields_present": 2,
        "penalities": 1.5
      }
    }
  ],
  "page_count": 100,
  "environment": "development",
  "document_name": "example.pdf",
  "coverage": 0.75,
  "download_url": "https://sensible-so-document-type-bucket-dev-us-west-2.s3.us-west-2.amazonaws.com/sensible/fc3484c5-3f35-4129-bb29-0ad1291ee9f8/EXTRACTION/246a6f60-0e5b-11eb-b720-295a6fba723e.pdf?AWSAccessKeyId=REDACTED"
}

Introduction

Extraction

Classification

Configuration

Retrieve extraction by ID

Authorizations

Path Parameters

Response