Extract portfolio at your URL

Use this endpoint with multiple documents that are packaged into one file (a “portfolio”). For a list of supported file types, see Supported file types. Segments a portfolio file at the specified document_url into the specified document types (for example, 1099, w2, and bank_statement) and then runs extractions asynchronously for each document Sensible finds in the portfolio. Take the following steps.

1. Run this endpoint.
2. To retrieve the extraction, use a webhook, or use the extraction id returned in the response to poll the GET documents/ endpoint. For more about extracting from portfolios, see Multi-document extractions.

Authorizations

Authorization

string

headerrequired

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.

Query Parameters

environment

enum<string>

default: production

If you specify development, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists.

Available options:

production,

development

document_name

string

If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response.

Body

application/json

document_url

string

required

URL that responds to a GET request with the bytes of the document you want to extract data from. This URL must be either publicly accessible, or presigned with a security token as part of the URL path. To check if the URL meets these criteria, open the URL with a web browser. The browser must either render the document as a full-page view with no other data, or download the document, without prompting for authentication.

types

string[]

required

Specifies the document types contained in the PDF portfolio.

webhook

object

Specifies to return extraction results to the defined webhook as soon as they're complete, so you don't have to poll for results status. Sensible also calls this webhook on error.

Show child attributes

Response

200 - application/json

id

string

Unique ID for the extraction, used to retrieve the extraction

created

string

Date and time Sensible created the initial empty extraction and set its status to WAITING.

status

enum<string>

Status of the extraction:

• WAITING: Sensible created an initial empty extraction and is waiting for the document.
• PROCESSING: Sensible received the document and is extracting data.
• FAILED: The extraction failed.
• COMPLETE: The extraction is complete.

Available options:

WAITING,

PROCESSING,

COMPLETE,

FAILED

types

string[]

Specifies the document types contained in the PDF portfolio.