Data models
The models correspond to the schemas in the OpenAPI specification. Fields not listed can appear depending on the environment; ignore fields your integration does not recognize.
OperationResponse
Common envelope of operation responses.
| Field | Type | Description |
|---|---|---|
status | integer | Result of the operation. 0 indicates success. |
description | string | Description of the result returned by the API. |
apiver | string | API and product version, in the v2 (9.0.1) format. |
user | string | User of the operation. |
length | integer (int64) | Size, in bytes, when applicable. |
time | string | Response date and time in ISO 8601 (RFC 3339) format, with the server time zone, for example 2026-11-07T14:03:21-03:00. In API v1, the field used the 2026-11-07 14:03:21.123456789 -0300 -03 format. |
LoginResponse
200 response of /auth/login.
| Field | Type | Description |
|---|---|---|
status | integer | 0 on success. |
description | string | Description of the result. |
apiver | string | API and product version, in the v2 (9.0.1) format. |
user | string | Authenticated user. |
urllink | string (URI) | Portal access link. |
time | string | Response date and time in ISO 8601 (RFC 3339) format, with the server time zone, for example 2026-11-07T14:03:21-03:00. In API v1, the field used the 2026-11-07 14:03:21.123456789 -0300 -03 format. |
The session token is not part of the JSON; it is sent in the __Host-dirl_session cookie.
MfaChallengeResponse
206 response of /auth/login when MFA is required.
| Field | Type | Description |
|---|---|---|
status | integer | MFA step: 1 PIN by email or SMS, 2 registered TOTP, 3 TOTP registration. |
description | string | Challenge description. |
apiver | string | API and product version, in the v2 (9.0.1) format. |
user | string | User. |
linkURL | string (URI) | Full secure URL: /auth/mfa (status 1 and 2) or /auth/mfa/register (status 3). |
secret | string | Status 3: TOTP secret in Base32. Empty in status 2; absent in status 1. Sensitive data. |
qrcode | string | Status 3: secret QR code, 200 × 200 PNG image in URL-safe Base64. Empty in status 2; absent in status 1. |
time | string | Response date and time in ISO 8601 (RFC 3339) format, with the server time zone, for example 2026-11-07T14:03:21-03:00. In API v1, the field used the 2026-11-07 14:03:21.123456789 -0300 -03 format. |
MfaRegisterResponse
200 response of /auth/mfa/register. Does not establish a session.
| Field | Type | Description |
|---|---|---|
status | integer | 0 on success. |
description | string | Result description. |
apiver | string | API and product version, in the v2 (9.0.1) format. |
user | string | User. |
length | integer | Always 0. |
time | string | Response date and time. |
SecureLinkResponse
Response of /auth/firstaccess and /auth/forget.
| Field | Type | Description |
|---|---|---|
status | integer | 0 on success. |
description | string | Description of the result. |
apiver | string | API and product version, in the v2 (9.0.1) format. |
user | string | User. |
linkURL | string (URI) | Secure link sent to the user. |
time | string | Response date and time in ISO 8601 (RFC 3339) format, with the server time zone, for example 2026-11-07T14:03:21-03:00. In API v1, the field used the 2026-11-07 14:03:21.123456789 -0300 -03 format. |
TokenResponse
200 response of /auth/token and /oauth2/token. All fields are always returned.
| Field | Type | Description |
|---|---|---|
access_token | string | Access token. |
issued_token_type | string | urn:ietf:params:oauth:token-type:access_token. |
token_type | string | Bearer. |
expires_in | integer (int64) | Token validity, in seconds. Varies with the environment. |
scope | string | URI of the configured API. It does not represent a list of permissions. |
OAuthError
400 response of /auth/token and /oauth2/token.
| Field | Type | Description |
|---|---|---|
error | integer | Numeric code of the condition reported by the validation. |
error_description | string | Reason for the failure. |
error_uri | string (URI) | API URI. |
UploadResponse
200 response of /upload. Includes the fields of OperationResponse and:
| Field | Type | Description |
|---|---|---|
id | string | Name or identifier of the received file. |
destination | string | Transfer destination. |
length | integer (int64) | Size received, in bytes. |
linkURL | array of string (URI) | Notification links generated, if any. |
FileListResponse
200 response of /download/list and /download/list/backup. Includes the fields of OperationResponse and:
| Field | Type | Description |
|---|---|---|
files | array of FileEntry | Files on the page. Can be empty. |
page_next | string | Index of the next page. |
FileEntry
| Field | Type | Description |
|---|---|---|
id | integer | Identifier of the file in the listing. |
name | string | File name. |
length | integer (int64) | Size, in bytes. |
modified | integer (int64) | Modification date, in milliseconds since 1970-01-01 UTC. |
linkURL | string (URI) | Signed download link. Use the full URL. |
DownloadPinResponse
200 response of /download/pin. Includes the fields of OperationResponse and:
| Field | Type | Description |
|---|---|---|
email | string | Recipient email. |
phone | string | Recipient phone. |
file | string | File name. |
linkURL | string (URI) | Secure download link. |
ReportResponse
200 response of /report. Includes the fields of OperationResponse and:
| Field | Type | Description |
|---|---|---|
page | integer | Page returned. |
logs | array of objects | Transfer records of the query. |