Get attachment status

Returns the malware-scan and file-type status of an attachment.

Request

GET https://www.activityinfo.org/resources/form/{formId}/record/{recordId}/field/{fieldId}/blob/{blobId}/status

Successful response

application/json

object
status string Values:
PENDING
Not yet scanned, or pending re-scan. May still be served.
CLEAN
Scanned with no threat found.
INFECTED
Scanner reported a known signature match. Will not be served.
ERROR
Scanner refused to process the file (e.g. malformed). Will not be served.
required
fileTypeStatus string Values:
PENDING
The content type has not been determined yet (e.g. a legacy attachment, or a backend that does not inspect content). The attachment may still be served.
ACCEPTED
No file-type restriction applies, or the detected content type is on the allow-list.
REJECTED
The detected content type is not on the field's allow-list. Will not be served.
required
detectedFileType string Values:
PDF
IMAGE
OFFICE_DOCUMENT
VIDEO
optional
scanTime integer optional
signature string optional

Error responses

Status Code Error Code Description
401 AUTHENTICATION_REQUIRED The request must be authenticated
403 FORBIDDEN Permission denied
404 NOT_FOUND The resource could not be found
410 DELETED The resource has been deleted

Example

curl -u anything:YOUR_API_TOKEN \
  https://www.activityinfo.org/resources/form/ck8pu9ha07/record/ck34ujs6v8/field/carknkldta8h4o3/blob/ccwnp64ldta8ds82/status
Next item
Get billing account