Skip to content

Samples of Result (or Transaction)

We have an endpoint for our customers to get all the files used ang generated during the processing of a video. This endpoint is useful for debugging and understanding the results of the processing. To use it you have to extract a Request ID from X-Request-Id header of the response of the process-video endpoint.

The Request ID is the transaction_id that you will use in the endpoint below. These terms are interchangeable. In the future we would recommend you to log Request ID somewhere in your system, so if you face any issues you can provide it to our support team.

Authorization

This endpoint requires a API token as Bearer in the Authorization header. Go to Authorization guide for details.

Request (GET)

GET https://api.biometrysolutions.com/api-transactions/transactions/{transaction_id}/samples

Headers

  • Authorization* - Your API Token.

Responses

The object with data field.

  • data - Contains the links to the files of processed video.

    • login-extracted-frame - Link to the extracted frame from the middle of the video.
    • login-original-video - Link to the original video that made by the user.

Response sample:

{
"data": {
"login-extracted-frame": "url",
"login-original-video": "url"
}
}

Sample

Request
curl --location 'https://api.biometrysolutions.com/api-transactions/transactions/{transaction_id}/samples' \
--header 'Authorization: Bearer eyJhbGciO...ANYea8r2xOG-Urc' \
Response
{
"data": {
"login-extracted-frame": "https://storage.googleapis.com/biometry/d2451e86-2b0b-...-ea750ce92143/fc5605c5-16e2-42c8-87cc-979cd72564d4/login-extracted-frame?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=768262733295-compute%40developer.gserviceaccount.com%2F20240828%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240828T180950Z&X-Goog-Expires=899&X-Goog-Signature=a026ea4eba9e015dea393786798f9f79b38910819632aa65b84d4f0a786de1996b7630ad472d27a09a272acf6a462137d97ec569d8f5e6dec9f8f2946bc0af88b14b856dbd9972a0e8510e113fb41a3dc46b7221a7a2b72da2f59bdda29bb02bbe98807a7a5fe452aaf8bbce45531f593f03ff3821992cba51b3f9b6ce28832df51e8f46ec593dbf217e2a2b6c2bf11596bf3e1f328e1cab2709cfe12cb6b88054f297f5b9b9489421418ae1535b30696b25b0d4ca6ddb248b571749ca5a46af4825f2da3042441c0b73eab2cea3696ba2636991fbfd963a59b64caba720128f807246b137759266a06899bad046a997ab163ed9f77673d4e311a2fb48a4f6a8&X-Goog-SignedHeaders=host",
"login-original-video": "https://storage.googleapis.com/biometry/d2451e86-2b0b-...-ea750ce92143/fc5605c5-16e2-42c8-87cc-979cd72564d4/login-original-video?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=768262733295-compute%40developer.gserviceaccount.com%2F20240828%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240828T180950Z&X-Goog-Expires=899&X-Goog-Signature=81f02dfddd5681270e2ec7f1efa592b9d0522e41dcb1d7ae9545576ff014d613e67db3f520202fcbacd6d11ea112ffa5f3b9b6c8000187826434944e314fd59a5c5bbb82459b850d8ab02a77580fd0d72865590baded58b8f6171cc1131a35adff283fc3b4c3345d2d2800052b1f5df09a65478b06b3229550d3428a4ab6769b7d98a7447f5e2dfd6dacf60a896b9d5e3e098b14c23713441887635d6f6b564b0ebc79ae640691c1a5b9d2402d456022c8e99f7aa8f079a7379fd138192a626ae61d0cbaebcbe8523751413c82d96a03bd22ca4f53e2ea1db019095915eff51bd4058b8bb494dfdf625f2a7810010213dc554d1103a7149df3dd7136643b7f44&X-Goog-SignedHeaders=host"
}
}

The response from this ednpoint is the list of files and their public links. These links will live for 15 minutes, so you have to download them in this time frame. Or you can generate new links by calling this endpoint again. These files will always contain the original video. Sometimes depending on the services used we might provide more or less files.

login-extracted-frame - This is the frame extracted from the middle of the video. This frame is used for the face recognition and other services. login-original-video - This is the original video that was processed. This video is used for debugging and understanding the results of the processing.