Witness Object
| Field | Type | Description |
|---|
| id | snowflake | the witness's id |
| user_id | snowflake | the id of the user who signed |
| user | user object | the user who signed as witness |
| type | object type | the type of object witnessed |
| first_name | string | the witness's first name |
| last_name | string | the witness's last name |
| company | string | the witness's company |
| position | string | the witness's position |
| signed_at | ISO8601 timestamp | when the witness signed |
| signed_method | witness signed method | the method used to sign |
Work Item Witness Object
| Field | Type | Description |
|---|
| id | snowflake | the witness's id |
| work_item_id | snowflake | the id of the work item being witnessed |
| user | user object | the user who signed as witness |
| type | object type | the type of object witnessed |
| first_name | string | the witness's first name |
| last_name | string | the witness's last name |
| company | string | the witness's company |
| position | string | the witness's position |
| signed_at | ISO8601 timestamp | when the witness signed |
| signed_method | witness signed method | the method used to sign |
Witness Response Object
Response returned when creating or updating a witness.
| Field | Type | Description |
|---|
| witness_id | snowflake | the witness's id |
| code | witness response code | the response code |
| message | string | a message describing the response |
| user_id | ?snowflake | the id of the user or null |
| email | string | the user's e-mail |
| phone_number | string | the user's mobile phone number |
| first_name | string | the user's first name |
| last_name | string | the user's last name |
| company | string | the user's company |
| position | string | the user's position |
| signed_at | ?ISO8601 timestamp | when the witness was signed or null |
| signed_method | witness signed method | the method used to sign |
| declaration | boolean | whether a declaration was made |
Work Item Witness Response Object
| Field | Type | Description |
|---|
| witness_id | snowflake | the witness's id |
| work_item_id | snowflake | the id of the work item being witnessed |
| code | witness response code | the response code |
| message | string | a message describing the response |
| user_id | ?snowflake | the id of the user or null |
| email | string | the user's e-mail |
| phone_number | string | the user's mobile phone number |
| first_name | string | the user's first name |
| last_name | string | the user's last name |
| company | string | the user's company |
| position | string | the user's position |
| signed_at | ?ISO8601 timestamp | when the witness was signed or null |
| signed_method | witness signed method | the method used to sign |
| declaration | boolean | whether a declaration was made |
Witness Signed Method
The method used by a witness to sign.
| Name | Value | Description |
|---|
| declaration | 0 | a declaration is made where there is no evidence |
| signature | 1 | signature provided as evidence |
| object_qr | 2 | user scanned a QR code on the object |
| user_qr | 3 | user's QR code was scanned |
| app | 4 | user signed via self-service app notification |
Witness Response Code
Response codes returned when creating or updating a witness.
| Name | Value | Description |
|---|
| not_signed | 0x00 | the witness has not yet signed |
| signed | 0x01 | the witness has been signed |
| request_details | 0x02 | witness details are requested |
| confirm_details | 0x03 | witness details need to be confirmed |
| declaration_missing | 0x04 | a declaration is required but missing |
| bad_request | 0xFE | the previous status was invalid |
| exception | 0xFF | a general failure occurred |