Skip to main content
PUT
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

Path Parameters

mandate_id
string
required

Record's mandate id (JM_...): the mandate_id returned when you create the mandate

Pattern: ^JM_[A-Z0-9]{10,40}$

Body

application/json
methods
enum<string>[]
required

Any non-empty mix; candidates always go enrichment → skills → interest. Omit to use the workflow's default.

Required array length: 1 - 3 elements
Available options:
data_enrichment,
skill_verification,
interest_collection

Response

Accepted (200 when nothing changed)

success
boolean
message
string
data
object