API Reference
System status

Upload client document

post
https://api.ext-sandbox.fourthline.com/v2/workflows//clients//data

Use this endpoint to upload or update a document for a client within a workflow. In this API, a document can be an identity document image, document video, selfie, selfie video, proof of residence, document to sign, or signed document. Supported file formats include images, videos, and PDF files.

Send a multipart/form-data request containing:

  • metadata: A JSON string containing document metadata. See the request body schema for details.
  • file: The document file. The MIME type must match the file content and the type specified in metadata.

Note Note:

  • You can upload only one file per request. The maximum supported file size is 200 MB.

  • For error responses, inspect the response body for additional details:

    • 400 Bad Request returns a validationProblemDetails object, including an errors property that maps request fields to validation error messages.
    • All other error responses return a problemDetails object containing type, title, status, and detail.
Path Params
string
required

The unique identifier of the workflow.

Format: uuid

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

string
required

The unique client id for this client from the Create workflow response.

Format: uuid

Example: baa2bf19-5258-47ec-b428-276d3f045820

Body Params
file
required

The document file to upload. It must match the type in metadata.

Document types and accepted formats

Image documents — DocumentImage, ReferenceDocumentImage, SelfieImage, ReferenceSelfieImage:

  • PNG (.png)
  • JPEG (.jpg, .jpeg)

Proof of residence — ProofOfResidence:

  • PDF (.pdf)
  • PNG (.png)
  • JPEG (.jpg, .jpeg)

Video documents — DocumentVideo, SelfieVideo, ReferenceSelfieVideo:

  • MKV (.mkv)
  • WebM (.webm)
  • MP4 (.mp4)
  • MP4V1 (.mp4v)
  • QuickTime
  • M4V (.m4v)

Signature documents — DocumentToSign:

  • PDF (.pdf)
metadata
object
required

The document metadata. In the multipart request, pass this object as a JSON string in the metadata form field. Required fields depend on the type value.

Base metadata (all document types): type (required), id (required), and location (optional).
When location is included, both latitude and longitude must be provided and cannot be null or empty.

Headers
string
required
Defaults to Bearer <access_token>

The access_token returned in your most recent Create access token response.

string
Defaults to no-cache

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

Responses

Updated 5 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago