Skip to content

Supported endpoints

What the client covers today, checked endpoint by endpoint against the official OpenAPI specifications rather than against memory.

API Documentation API version Covered
das-Peak v2.33 v1 11 / 11
VCSP v1.17 v1 31 / 31
das-Face v3.35 v2 11 / 11, plus 2 †

Two version numbers, and they are not the same thing

The version in a documentation URL is the product release; the API is versioned separately and appears in the request path. das-Face product 3.35 serves API v2, which is why the client calls dasface/v2. das-Peak product 2.33 serves v1, and so does VCSP 1.17.

† das-Face also covers the two liveness challenge endpoints, which the v3.35 specification dropped while the service kept answering. See the section below.


das-Peak

Fully covered.

Endpoint Client
GET /v1/alive alive()
GET /v1/models get_models()
POST /v1/models/metadata get_model_metadata()
POST /v1/models/calibration get_model_calibrations()
POST /v1/models/metadata/from-credential get_model_metadata_from_credential()
POST /v1/models/{hash}/credential/wav generate_credential()
POST /v1/similarity/credential2credential compare_credential_to_credential()
POST /v1/similarity/credential2wav compare_credential_to_audio()
POST /v1/similarity/wav2wav compare_audio_to_audio()
POST /v1/identification/wav2credentials identify_audio()
POST /v1/identification/credential2credentials identify_credential()

VCSP

Fully covered.

Endpoint Client
GET /v1/alive alive()
POST /v1/enrollments enroll_subject()
POST /v1/enrollments/batch enroll_batch()
GET /v1/accounts/{subject_id} get_account()
DELETE /v1/accounts/{subject_id} delete_account()
GET /v1/accounts/{subject_id}/credentials get_all_subject_credentials()
GET /v1/accounts/{subject_id}/credentials/{credential_id} get_credential()
DELETE /v1/accounts/{subject_id}/credentials/{credential_id} delete_credential()
GET /v1/accounts/{subject_id}/credentials/{credential_id}/sample get_credential_sample()
PATCH /v1/accounts/{subject_id}/credentials/{credential_id}/tags modify_credential_tags()
GET /v1/credentials list_credentials()
DELETE /v1/credentials delete_credentials()
POST /v1/groups create_group()
GET /v1/groups get_groups()
GET /v1/groups/{group_name} get_group()
PATCH /v1/groups/{group_name} modify_group()
DELETE /v1/groups/{group_name} delete_group()
GET /v1/groups/{group_name}/credentials get_group_members()
POST /v1/groups/{group_name}/clustering start_clustering()
POST /v1/matchings match()
GET /v1/credential_configurations get_credential_configurations()
GET /v1/credential_configurations/{credential_configuration_urn} get_credential_configuration()
GET /v1/assurance_methods get_assurance_methods()
GET /v1/assurance_methods/{assurance_method_urn} get_assurance_method_info()
POST /v1/tags create_tags()
GET /v1/tags get_tags()
DELETE /v1/tags/{tag_name} delete_tag()
GET /v1/tasks get_tasks()
GET /v1/tasks/{task_id} get_task(), wait_for_task()
DELETE /v1/tasks/{task_id} delete_task()
GET /v1/tasks/{task_id}/result get_task_result()

das-Face

Counted against the v3.35 specification, which describes 11 endpoints, all covered. The older v3.26 page, still served, lists 14: one of its extras it marks deprecated itself, another is not deployed, and the challenges pair responds on work/eu but is gone from v3.35 — see #30. The challenges are covered too, since they work and there is no liveness flow without them.

Endpoint Client
GET /v2/alive alive()
GET /v2/models get_models()
POST /v2/models/{hash}/{mode}/credential/photo generate_credential()
POST /v2/models/inemex/default-mode/credential/photo generate_credential(inemex=True)
POST /v2/models/metadata/from-credential get_model_metadata_from_credential()
POST /v2/inemex/models/{hash}/{mode}/credential/photo generate_credential(inemex=True)
POST /v2/verification/photo verify_photo()
POST /v2/verification/video verify_video()
POST /v2/verification/credential verify_credential()
POST /v2/authenticity/photo check_photo_authenticity()
POST /v2/authenticity/video/photo check_video_authenticity()
POST /v2/challenges/generation/sequential † generate_sequential_challenge()
POST /v2/challenges/analysis/video-photo † analyse_challenge_response()

† Documented in v3.26 only, and working on work/eu.

das-Face is served under /v2, unlike the other two, and takes JSON with base64 images rather than multipart parts.

Other Veridas APIs

vali-Das (#8) and eSign (#9) have exploratory branches but no supported client yet.