Public Api Media Gateway Service
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.
Private App Key of your Application. It is available in Workplace on the page of the Application.
Type of the file, for example applicant.doc or applicant.image.
Path of the file inside the storage.
OK
Unauthorized: the x-private-app-key header is missing or not valid
GET /api/public/file/{fileType}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}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}.
Private App Key of your Application. It is available in Workplace on the page of the Application.
Type of the file, for example applicant.doc or applicant.image.
Path of the file inside the storage.
Identifier of the verification the file belongs to.
OK
Unauthorized: the x-private-app-key header is missing or not valid
GET /api/public/file/{fileType}/{transactionId}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}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}.
Private App Key of your Application. It is available in Workplace on the page of the Application.
Storage directory of the report.
Key of your company. Must be the key of the client that owns the report, otherwise the file is not found.
Identifier of the report document.
Name of the report file.
OK
Unauthorized: the x-private-app-key header is missing or not valid
GET /api/public/file/crypto-reports/{storageDirectory}/{clientKey}/{documentId}/{fileName} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}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}.
Private App Key of your Application. It is available in Workplace on the page of the Application.
Base directory of the file in the storage.
Identifier of the applicant the file belongs to.
Type of the file.
Identifier of the service result the file belongs to.
Name of the file.
OK
Unauthorized: the x-private-app-key header is missing or not valid
GET /api/public/file/{baseDir}/{applicantId}/{fileType}/{serviceId}/{fileName} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}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}.
Private App Key of your Application. It is available in Workplace on the page of the Application.
Type of the file.
Path of the file inside the storage.
Identifier of the verification the file belongs to.
Base directory of the file in the storage.
Part of the file to download, for example bytes=0-1023.
OK
Unauthorized: the x-private-app-key header is missing or not valid
GET /api/public/file/{baseDir}/{fileType}/{transactionId}/{path} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{}Last updated