๐ŸŒ See how URLs of assets are stored and can be downloaded when needed.

asset is an object that represents an asset URL and is generated dynamically when requisite. The URL will expire after some time (15 minutes by default).

โ—๏ธ

Warning!

The URL will expire after some time (15 mins by default).

asset will be defined in a JSON object with the following structure:

{
    "url": "string",
    "size": "integer",
    "content_type": "string"
}

The following table explains the details of each field:

๐Ÿšง

Note:

There will be various responses depending on user activity. There are two categories:

  • Mandatory: means the field and its value will always be returned, even with null values.
  • Optional: means the field would not exist in some cases. I.e., the transaction is not completed yet. Thus, some fields are missing.
FieldsData TypeMandatory/OptionalDescriptionPossible Responses
urlstringMandatoryURL for the asset (image or video).- If the url has been redacted, the value will be invalid with null.

- Otherwise, it will always be present.
sizeintegerMandatoryAsset size in bytes.- It will be returned with 0 bytes if the size has been redacted.

- Otherwise, it will always be present.
content_typestringMandatoryAsset mime-type.- If its asset or face has been redacted, the value will be invalid with null.

- Otherwise, it will always be present.

An example response of asset object is as follows:

"face_photo": {
        "url": "https://url_for_downloading_the_face_photo",
        "size": 7392,
        "content_type": "image/jpeg"
      }

๐Ÿ’ฌ We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.