Download files

Download files generated by services during verification processes. It always returns a file from the latest session if the request is ambiguous. Combine the file label with only one of the next IDs - session ID, flow ID or person ID. Specifying multiple IDs in a query string may cause an error. Returns the file as a binary stream.

GET

/resources/file

curl -X GET "https://demo.verigram.kz/resources/file?label=bestframe&flow_id=01KMWYGEEVW2TH4Q4SFFFFFFF5-F" \ -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \ -H "X-Verigram-Api-Version: 2.0.0"

API referenceResources

Download files

GET

/resources/file

GET

/resources/file

curl -X GET "https://demo.verigram.kz/resources/file?label=bestframe&flow_id=01KMWYGEEVW2TH4Q4SFFFFFFF5-F" \
  -H "X-Verigram-Api-Key: $IDENTIFICATION_SAAS_API_KEY" \
  -H "X-Verigram-Api-Version: 2.0.0"

Авторизация

X-Verigram-Api-Key
string
header
обязательно
API key in the X-Verigram-Api-Key header

Параметры

label
enum<string>
query
обязательно
Filter by file label.
Одно из:
bestframe
bf_zoom_in
bf_zoom_out
bf_turn_left
bf_turn_right
liveness_video
liveness_alt_video
liveness_frames
liveness_card
doc_face_picture
doc_signature_picture
doc_original_front_img
doc_original_back_img
doc_original_img
face_enroll_img
face_verif_img
egov_doc_pdf
kisc_pii
kisc_raw_content
kisc_raw_headers
signed_doc
signed_docs
certificate
cert_status
esign_original_doc
client_card
signed_doc_ticket
doc_builder_template
doc_builder_data
doc_builder_pdf
doc_builder_pdfs
person_id
string
query
Filter by person_id.
session_id
string
query
Filter by session_id.
flow_id
string
query
обязательно
Filter by flow_id.
X-Verigram-Api-Version
string
header
обязательно
Required API version header.
Значение по умолчанию:
2.0.0

Ответ

application/octet-stream

A file requested by identifier and/or labels

string<binary>

string