forms

Embed

<a href="https://hermeticor.com/docs/ref-forms"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3a095c68-d07c-4776-8a75-070cf1437150/social-card.svg?v=3e7ae33eec8b" alt="forms" width="600" height="315"></a>

POSThttps://hermeticor.com/p/f/{ref}/upload

Upload a file for a file field of a published form; the returned URL is the answer to submit

Parameters

refstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/p/f/{ref}/upload"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "filename": "string",
  "bytes": 0
}

Schema

urlstringrequired

filenamestringrequired

bytesintegerrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

POSThttps://hermeticor.com/ingest/v1/forms/{id}/upload

Same as the hosted upload, for embedded forms (site key)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/forms/{id}/upload" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /p/f/{ref}/upload

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

POSThttps://hermeticor.com/ingest/v1/forms/{id}/submit

Parameters

idstringpathrequired

Request body

application/json

dataobjectrequired

startedAtinteger

websitestring

anonymousIdstring

pageUrlstring

turnstileTokenstring

captchaTokenstring

prefillTokenstring

stepinteger

stepTokenstring

{
  "data": {},
  "startedAt": 0,
  "website": "string",
  "anonymousId": "string",
  "pageUrl": "string",
  "turnstileToken": "string",
  "captchaToken": "string",
  "prefillToken": "string",
  "step": 0,
  "stepToken": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/forms/{id}/submit" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{},"startedAt":0,"website":"string","anonymousId":"string","pageUrl":"string","turnstileToken":"string","captchaToken":"string","prefillToken":"string","step":0,"stepToken":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "success": {
    "type": "message",
    "text": "string",
    "title": "string"
  },
  "pendingConfirmation": true,
  "outcome": "success",
  "spin": {
    "index": 0
  },
  "stepToken": "string"
}

Schema

okbooleanrequired

true

successSuccessVariant4 | SuccessVariant5 | SuccessVariant6 | SuccessVariant7required

pendingConfirmationbooleanrequired

outcomestring

success | already_subscribed

spinobject

Show child parameters

indexintegerrequired

stepTokenstring

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

GEThttps://hermeticor.com/ingest/v1/forms

Parameters

vstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/ingest/v1/forms" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "forms": [
    {
      "id": "string"
    }
  ]
}

Schema

formsobject[]required

Show child parameters

idstringrequired

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

GEThttps://hermeticor.com/p/f/{ref}

Hosted form page (`pp` = signed progressive-profiling token)

Parameters

ppstringquery

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/f/{ref}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

POSThttps://hermeticor.com/p/f/{ref}/submit

Parameters

refstringpathrequired

Request body

application/json

dataobjectrequired

startedAtinteger

websitestring

anonymousIdstring

pageUrlstring

turnstileTokenstring

captchaTokenstring

prefillTokenstring

stepinteger

stepTokenstring

{
  "data": {},
  "startedAt": 0,
  "website": "string",
  "anonymousId": "string",
  "pageUrl": "string",
  "turnstileToken": "string",
  "captchaToken": "string",
  "prefillToken": "string",
  "step": 0,
  "stepToken": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/p/f/{ref}/submit" \
  -H "Content-Type: application/json" \
  -d '{"data":{},"startedAt":0,"website":"string","anonymousId":"string","pageUrl":"string","turnstileToken":"string","captchaToken":"string","prefillToken":"string","step":0,"stepToken":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /ingest/v1/forms/{id}/submit

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

GEThttps://hermeticor.com/p/c/{*}

Double opt-in confirmation page (does not change state)

Parameters

*stringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/c/{*}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

POSThttps://hermeticor.com/p/c/{*}

Confirm double opt-in; idempotent

Parameters

*stringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/p/c/{*}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

GEThttps://hermeticor.com/v1/forms/{id}/captcha-secret

Whether a captcha secret is stored (the secret itself is never returned)

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/forms/{id}/captcha-secret" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "configured": true
}

Schema

configuredbooleanrequired

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

PUThttps://hermeticor.com/v1/forms/{id}/captcha-secret

Store (or clear with null) the sealed secret for the form captcha provider

Parameters

idstringpathrequired

Request body

application/json

secretstringrequired

{
  "secret": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/forms/{id}/captcha-secret" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"secret":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

POSThttps://hermeticor.com/v1/forms/{id}/prefill-link

Signed link that shows the hosted form to a known contact with known fields hidden or pre-filled

Parameters

idstringpathrequired

Request body

application/json

profileIdstringrequired

ttlHoursinteger

= 72

{
  "profileId": "string",
  "ttlHours": 72
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/forms/{id}/prefill-link" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","ttlHours":72}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "token": "string",
  "url": "string"
}

Schema

tokenstringrequired

urlstringrequired

4XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

5XX Default Response

Same as 4XX · POST /p/f/{ref}/upload

Next part

Updated Nov 8, 2026

Was this page helpful?