Skip to main content
PUT
Handles `PUT /v1/verification-flows/{flow_id}`.

Authorizations

esectra_session
string
cookie
required

A signed-in reviewer's session. httpOnly and SameSite=Lax; set by POST /v1/control/sessions and only usable once the second factor is met.

Path Parameters

flow_id
string
required

Flow identifier

Body

application/json

Changes to a draft. Every field optional; absent leaves it alone.

documents
object[] | null

A new selection, replacing the old one entirely.

flow_type
null | enum<string>

A new type. Changing it re-validates the documents against it.

Available options:
BIOMETRIC,
DOCUMENT,
FULL_IDENTITY
name
string | null

A new name.

return_url

A new return URL; null clears it, absent leaves it.

Available options:
Keep

Response

The flow as it now reads

A flow as the API shows it.

created_at
string
required

RFC 3339 creation time.

documents
object[]
required

The draft's selection, by catalog code.

flow_id
string
required

Identifier, vf_....

flow_type
enum<string>
required

The draft's type.

Available options:
BIOMETRIC,
DOCUMENT,
FULL_IDENTITY
name
string
required

Name.

status
enum<string>
required

DRAFT, ACTIVE or ARCHIVED.

Available options:
DRAFT,
ACTIVE,
ARCHIVED
updated_at
string
required

RFC 3339 time of the last change.

archived_at
string | null

RFC 3339 time it was archived.

published
null | object

The latest published revision, when there is one.

published_at
string | null

RFC 3339 time of the latest publish.

published_revision
integer<int32> | null

The latest published revision number.

Required range: x >= 0
return_url
string | null

The draft's return URL, as entered.