For the complete documentation index, see llms.txt. This page is also available as Markdown.

Public Api Media Gateway Service

Get a file of your company

get

Downloads a file that belongs to your company by its type and path. Use the path exactly as it is returned by the API (for example, the path of a generated PDF report).

The file is returned as a stream and is encrypted: always with aes-256-cbc and the Crypto Key of your Application, without HMAC. The initialization vector is in the x-initialization-vector response header (hex, 16 bytes). This applies to all file endpoints.

Authorizations
x-private-app-keystringRequired

Private App Key of your Application. It is available in Workplace on the page of the Application.

Path parameters
fileTypestring · enumRequired

Type of the file, for example applicant.doc or applicant.image.

Possible values:
pathstringRequired

Path of the file inside the storage.

Responses
200

OK

application/json
object · ReadableOptional
get/api/public/file/{fileType}/{path}
GET /api/public/file/{fileType}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}

Get a verification file by type and verification

get

Downloads a file of a verification by its type, the identifier of the verification and the path of the file. The response is an encrypted stream, see GET /api/public/file/{fileType}/{path}.

Authorizations
x-private-app-keystringRequired

Private App Key of your Application. It is available in Workplace on the page of the Application.

Path parameters
fileTypestring · enumRequired

Type of the file, for example applicant.doc or applicant.image.

Possible values:
pathstringRequired

Path of the file inside the storage.

transactionIdstringRequired

Identifier of the verification the file belongs to.

Responses
200

OK

application/json
object · ReadableOptional
get/api/public/file/{fileType}/{transactionId}/{path}
GET /api/public/file/{fileType}/{transactionId}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}

Download a Crypto AML PDF report

get

Downloads a generated Crypto AML PDF report. Use the path of the report (status GENERATED) as it is: crypto-reports/{storageDirectory}/{clientKey}/{documentId}/{fileName}. Reports of other companies are not available: the response is 404.

The response is an encrypted stream, see GET /api/public/file/{fileType}/{path}.

Authorizations
x-private-app-keystringRequired

Private App Key of your Application. It is available in Workplace on the page of the Application.

Path parameters
storageDirectorystringRequired

Storage directory of the report.

clientKeystringRequired

Key of your company. Must be the key of the client that owns the report, otherwise the file is not found.

documentIdstringRequired

Identifier of the report document.

fileNamestringRequired

Name of the report file.

Responses
200

OK

application/json
object · ReadableOptional
get/api/public/file/crypto-reports/{storageDirectory}/{clientKey}/{documentId}/{fileName}
GET /api/public/file/crypto-reports/{storageDirectory}/{clientKey}/{documentId}/{fileName} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}

Get an applicant file

get

Downloads a file of an applicant (for example a document image) by its full path. Use the path exactly as it is returned in the applicant profile. The response is an encrypted stream, see GET /api/public/file/{fileType}/{path}.

Authorizations
x-private-app-keystringRequired

Private App Key of your Application. It is available in Workplace on the page of the Application.

Path parameters
baseDirstringRequired

Base directory of the file in the storage.

applicantIdstringRequired

Identifier of the applicant the file belongs to.

fileTypestringRequired

Type of the file.

serviceIdstringRequired

Identifier of the service result the file belongs to.

fileNamestringRequired

Name of the file.

Responses
200

OK

application/json
object · ReadableOptional
get/api/public/file/{baseDir}/{applicantId}/{fileType}/{serviceId}/{fileName}
GET /api/public/file/{baseDir}/{applicantId}/{fileType}/{serviceId}/{fileName} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}

Get a verification file by full path

get

Downloads a file of a verification by its full path. The optional Range header can be used to download a part of the file (for example, to stream a video). The response is an encrypted stream, see GET /api/public/file/{fileType}/{path}.

Authorizations
x-private-app-keystringRequired

Private App Key of your Application. It is available in Workplace on the page of the Application.

Path parameters
fileTypestringRequired

Type of the file.

pathstringRequired

Path of the file inside the storage.

transactionIdstringRequired

Identifier of the verification the file belongs to.

baseDirstringRequired

Base directory of the file in the storage.

Header parameters
rangestringOptional

Part of the file to download, for example bytes=0-1023.

Responses
200

OK

application/json
object · ReadableOptional
get/api/public/file/{baseDir}/{fileType}/{transactionId}/{path}
GET /api/public/file/{baseDir}/{fileType}/{transactionId}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}

Last updated