DocumentationAPI Reference
DocumentationAPI ReferenceOpenAPIStatus

File URLs

Migration in v2023-01-05

The way file URLs are serialized in all API responses has changed as of API version v2023-01-05. This change affects how you use file URLs returned from an API response to download files, and alters the level of access control embedded in the file URLs.

Old behavior

File URLs were of the form https://withpersona.com/api/v1/files/[token]/[filename].[extension], and required a Persona API key in the request header to access them.

New behavior

File URLs are of the form https://files.withpersona.com/[filename].[extension]?access_token=[token]. A Persona API key is not needed.

For more information about the new URL format, see Downloading Files.

What remains the same

The Download a File API remains unchanged for previous API versions. (Note that this link references the v2022-09-01 documentation.)

Usage patterns to migrate

If you save URLs returned from API responses for use beyond 6 hours into the future, going forward, you will need to account for URLs expiring after 6 hours.