Skip to main content
PUT
Update PDF attributes including status

Authorizations

x-api-key
string
header
required

Path Parameters

heron_id
string
required

heron_id of the pdf

Body

application/json
filename
string

The filename of the PDF

Example:

"my-favourite.pdf"

fraud_reason
string | null

If fraud reason

is_fraud
boolean

True if fraud was detected in the PDF

notes
string

Notes associated with PDF, e.g., rejected reason, failed reason

reference_id
string

An optional field for your unique identifier for the PDF

Maximum string length: 140
Example:

"my-favourite-pdf"

status
enum<string>

Status of PDF

Available options:
new,
parsing,
parsed,
processed,
human_reviewing,
approved,
rejected,
failed,
transactions_loaded,
transactions_unloaded
Example:

"processed"

Response

200 - application/json

OK

pdf
object
request_id
string

Unique UUID per request