Surepass
Files

Upload asset

View as Markdown
POST
/api/v1/files/upload-asset

Upload an image asset (JPEG or PNG). Use the returned client_id as:

  • face_ref_file_id on a signer to enable face verification, or
  • the value of an image element placed on the document.

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication — paste your access token below.

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*file

JPEG or PNG image to upload.

Formatbinary

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/files/upload-asset" \  -F file="string"
{  "data": {    "user_id": "user_xxx",    "client_id": "file_faceReferenceImage",    "name": "reference.png",    "mime": "image/png"  },  "status_code": 200,  "message": "Success",  "success": true}

Upload PDF POST

Upload a PDF file (max size 50MB) for Esign.

Initialize Esign POST

Start an Esign session for one or more signers on an uploaded document. - `page` inside elements is zero-indexed: `0` is the first page. - Multiple elements can be added per signer on different pages. - `email_template_overrides` customizes invite email branding; when `company_name` is provided, default Surepass branding is hidden for white-label emails. - `stamp` optionally reserves e-stamps into the flow — either by search (`amount` + `state_code` + `article_id`, optionally narrowed by party names) or by explicit `stamp_instance_ids`. Reserved stamp PDFs are prefixed to the uploaded PDF before signing starts.