POST
/
generate_upload_url
Extract portfolio at a Sensible URL
curl --request POST \
  --url https://api.sensible.so/v0/generate_upload_url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "webhook": {
    "url": "https://example.com/example_webhook_url",
    "payload": "info extra to the default extraction payload"
  },
  "types": [
    [
      "tax_returns",
      "bank_statements",
      "credit_reports"
    ]
  ]
}'
{
  "id": "246a6f60-0e5b-11eb-b720-295a6fba723e",
  "created": "2022-10-31T16:27:53.433Z",
  "status": "COMPLETE",
  "upload_url": "https://sensible-so-utility-bucket-prod-us-west-2.s3.us-west-2.amazonaws.com/EXTRACTION_UPLOAD/sensible/fc3484c5-3f35-4129-bb29-0ad1291ee9f8/EXTRACTION/14d82783-c12b-4e70-b0ae-ca1ce35a9836.pdf?AWSAccessKeyId=REDACTED&Expires=1623861476&Signature=REDACTED&x-amz-security-token=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.

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
​
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.

Response

Returns the upload_url at which to PUT the document for extraction

​
id
string<uuid>

Unique ID for the extraction, used to retrieve the extraction

Example:

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

​
created
string<date-time>

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

Example:

"2022-10-31T16:27:53.433Z"

​
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
Example:

"COMPLETE"

​
upload_url
string<url>

URL at which to PUT the PDF bytes array for extraction. for example, curl -T ./sample.pdf "YOUR_UPLOAD_URL"

Example:

"https://sensible-so-utility-bucket-prod-us-west-2.s3.us-west-2.amazonaws.com/EXTRACTION_UPLOAD/sensible/fc3484c5-3f35-4129-bb29-0ad1291ee9f8/EXTRACTION/14d82783-c12b-4e70-b0ae-ca1ce35a9836.pdf?AWSAccessKeyId=REDACTED&Expires=1623861476&Signature=REDACTED&x-amz-security-token=REDACTED"