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

Authorizations

Authorization
string
header
required

A tenant API key. Acts for exactly one tenant and cannot conclude a case, because a conclusion records a person.

Path Parameters

flow_id
string
required

Flow identifier

Response

The flow with its latest published revision

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.