/v1/tasks/{task_id}/photos/{document_id}/completeAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request POST \
--url 'https://api.staging.facily.ai/v1/tasks/<TASK_ID>/photos/<DOCUMENT_ID>/complete' \
--header "Authorization: Bearer $FACILY_API_KEY"Parameters
task_idpath · stringrequiredFormat: uuid
document_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"can_delete": false,
"document_type": "string",
"expires_at": "2026-10-29T12:00:00Z",
"file_size_bytes": 0,
"id": "00000000-0000-4000-8000-000000000001",
"mime_type": "string",
"title": "string",
"unit_id": "00000000-0000-4000-8000-000000000001",
"uploaded_at": "2026-10-29T12:00:00Z",
"uploaded_by": {
"display_name": "string",
"id": "00000000-0000-4000-8000-000000000001"
},
"url": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataTaskPhotoResponserequiredOne photo of a task.
Show data schema
can_deletebooleanrequiredTrue when the caller may remove this photo now.
document_typestringrequiredThe photo's type: task_photo_proof, task_photo_reference, task_photo_before, task_photo_after or task_photo_finding.
expires_atstringrequiredWhen url stops working.
Format: date-time
file_size_bytesintegerrequiredThe file's size in bytes, as stored.
idstringrequiredThe photo's id.
Format: uuid
mime_typestringrequiredThe file's type: image/jpeg, image/png or image/webp.
titlestring | nullrequiredThe photo's label, such as its file name; null when none was sent.
Show title schema
string | nullThe photo's label, such as its file name; null when none was sent.
Variant 1: string
stringVariant 2: null
nullunit_idstring | nullrequiredThe unit of the inspection finding this photo belongs to; null for every other photo, and for a finding photo whose unit is gone.
Format: uuid
Show unit_id schema
string | nullThe unit of the inspection finding this photo belongs to; null for every other photo, and for a finding photo whose unit is gone.
Variant 1: string
stringVariant 2: null
nulluploaded_atstringrequiredWhen the upload was confirmed.
Format: date-time
uploaded_byPersonResponserequiredA user, as a task or a thread entry names one.
Show uploaded_by schema
display_namestringrequiredThe name to show for the user.
idstringrequiredThe user's id.
Format: uuid
urlstringrequiredA link to the file, valid for 15 minutes. Opened in a browser tab, it downloads the file.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired