Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.

Maximum string length: 255

Body

application/json
name
string
required

Display name, 1–120 characters.

Required string length: 1 - 120
schedule
object
required

Required. Send these six: start_time and end_time ("HH:MM", start before end), days (mon…sun, each once), timezone (IANA), max_retries 1 to 20 and retry_after_hours 1 to 48. language is optional and defaults to english: english, hindi, tamil, kannada, telugu, malayalam, bengali or marathi.

questions
object[]
required

1 to 15 questions. An enrichment is never edited: different questions mean a new enrichment

Required array length: 1 - 15 elements
external_id
string

Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)

Pattern: ^[A-Za-z0-9._:-]{1,128}$
description
string
default:""

Optional note, up to 500 characters.

Maximum string length: 500

Response

The new enrichment

success
boolean
message
string
data
object