Skip to main content
PUT
Handles `PUT /v1/platform/catalog/{code}`.

Authorizations

Authorization
string
header
required

The platform operator's token, from ESECTRA_PLATFORM_OPERATOR_TOKEN on the API. Administers the global verification catalog; it is not a tenant key and opens no tenant route. Absent on a deployment that has not set it, in which case the platform routes answer 404.

Path Parameters

code
string
required

Capability code, e.g. NG_PASSPORT

Body

application/json

What an operator may change on an entry. Country and type are the code, and the code is what every flow and session points at, so neither moves.

capture
null | object

New capture rules.

display_name
string | null

A new display name.

enabled
boolean | null

Switch on or off.

reader

A new reader, explicitly none, or - when absent - no change.

Available options:
Keep

Response

The entry as it now reads

A catalog entry as the API shows it.

capture
object
required

Capture rules.

code
string
required

Stable code, {country}_{document type}.

country
string
required

ISO-3166-1 alpha-2 issuing country.

country_name
string
required

The country's English short name, from the same table the capture page uses, so a console shows "Nigeria" without carrying its own list.

created_at
string
required

RFC 3339 creation time.

display_name
string
required

What a person is shown.

document_type
enum<string>
required

Document type.

Available options:
PASSPORT,
DRIVING_LICENCE,
NATIONAL_ID,
RESIDENCE_PERMIT,
NIN_SLIP,
OTHER
enabled
boolean
required

Whether new flows may select it.

extraction_support
enum<string>
required

AUTOMATED when a reader exists, otherwise MANUAL_REVIEW: the document is captured and its reading goes to a reviewer.

Available options:
AUTOMATED,
MANUAL_REVIEW
revision
integer<int32>
required

Change counter, from 1.

Required range: x >= 0
updated_at
string
required

RFC 3339 time of the last change.

reader
null | enum<string>

The reader that reads it, when one exists.

Available options:
NG_NIN_SLIP,
TD3_MRZ