Skip to main content

Upload a document

POST 

/documents

Upload a document.

Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.

Request

Body

required

    oneOf

    url stringrequired

    If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.

    filename string

    The filename of the document.

    customer_reference string

    Optional reference string for customer tracking.

Responses

200: Successful response

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

    content_type string

    The document's content_type.

    size

    object

    Indicates the document's filesize

    unit string

    Identifies the unit

    amount integer

    The number of bytes

    status string

    Possible values: [pending, verified, denied]

    Indicates the current document reviewing status

    sha256 string

    The document's SHA256 hash provided for optional verification purposes.

    filename string

    The filename of the document.

    customer_reference string

    Optional reference string for customer tracking.

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...