docs

Forms

Create a form by uploading a flat PDF. Emboss detects its fields asynchronously; check the form's status before fetching its contract or filling it.

Create a form

POST/formsBearer auth

Upload a flat PDF. Returns 202 with a form_id while field detection runs in the background.

Parameters

NameInTypeRequiredDescription
filebodyfile (multipart)yesThe flat PDF to detect fields in.

Status codes

  • 202Accepted; detection started.
  • 400Missing or non-PDF file.
  • 401Missing or invalid API key.
  • 429Rate limited.
curl -X POST https://api.getemboss.ai/forms \
  -H "Authorization: Bearer sk_live_yourkey" \
  -F "file=@./w9.pdf"
Response
{
  "form_id": "form_3d9a",
  "status": "detecting"
}

Get a form

GET/forms/{id}Bearer auth

Check a form's detection status.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe form_id returned by POST /forms.

Status codes

  • 200The form status.
  • 401Missing or invalid API key.
  • 404No such form, or owned by another key.
curl https://api.getemboss.ai/forms/form_3d9a \
  -H "Authorization: Bearer sk_live_yourkey"
Response
{
  "form_id": "form_3d9a",
  "status": "ready"
}