Proofs¶

Proofs are the files a case collects, for example an ID scan or a utility bill.

Upload a proof¶

POST /api/1/cases/{case_pk}/proofs

Send the file as multipart/form-data. The upload only stores the proof on the case; use the assign endpoint to attach it to a needed document.

keep_dirty (boolean) - Save the change without running the rule engine, see Delay the recalculation.
skip_case_response (boolean) - Answer with the case id alone instead of the whole case, see Skip the case response.

Request body

Sent as multipart/form-data.

file (string, binary, required)
name (string)

Example

curl -X POST \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs

Response 200

The case. The listed properties are the stable ones. The payload also carries the fields the Atfinity frontend needs, which are not part of this contract and can change.

calculated_name (string, nullable)
color (string)
created (string, date-time)
creation_reason (string)
given_name (string, nullable)
id (integer)
is_created (boolean)
is_dirty (boolean)
is_editable (boolean)
last_modified (string, date-time)
last_transition_at (string, date-time)
name (string)
outcome_instance_id (integer, nullable)
preferred_language (string, nullable)
state_id (integer, nullable)
state_key (string, nullable)
status (string)
use_given_name (boolean)
user_readable_id (string)

Further fields are present but are not part of this contract.

Delete a proof¶

DELETE /api/1/cases/{case_pk}/proofs/{id}

keep_dirty (boolean) - Save the change without running the rule engine, see Delay the recalculation.
skip_case_response (boolean) - Answer with the case id alone instead of the whole case, see Skip the case response.

Example

curl -X DELETE \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>

Response 200

The case. The listed properties are the stable ones. The payload also carries the fields the Atfinity frontend needs, which are not part of this contract and can change.

calculated_name (string, nullable)
color (string)
created (string, date-time)
creation_reason (string)
given_name (string, nullable)
id (integer)
is_created (boolean)
is_dirty (boolean)
is_editable (boolean)
last_modified (string, date-time)
last_transition_at (string, date-time)
name (string)
outcome_instance_id (integer, nullable)
preferred_language (string, nullable)
state_id (integer, nullable)
state_key (string, nullable)
status (string)
use_given_name (boolean)
user_readable_id (string)

Further fields are present but are not part of this contract.

Get a proof¶

GET /api/1/cases/{case_pk}/proofs/{id}

Example

curl -X GET \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>

Response 200

The proof file, with its appendices merged in.

Update a proof¶

PATCH /api/1/cases/{case_pk}/proofs/{id}

Send at least one of file and name, as multipart/form-data. Only a custom proof can be renamed: a requested proof keeps the name its configuration gives it. A name sent for one is rejected before the file is read, so the proof keeps the file it already had.

keep_dirty (boolean) - Save the change without running the rule engine, see Delay the recalculation.
skip_case_response (boolean) - Answer with the case id alone instead of the whole case, see Skip the case response.

Request body

Sent as multipart/form-data.

file (string, binary)
name (string)

Example

curl -X PATCH \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>

Response 200

The case. The listed properties are the stable ones. The payload also carries the fields the Atfinity frontend needs, which are not part of this contract and can change.

calculated_name (string, nullable)
color (string)
created (string, date-time)
creation_reason (string)
given_name (string, nullable)
id (integer)
is_created (boolean)
is_dirty (boolean)
is_editable (boolean)
last_modified (string, date-time)
last_transition_at (string, date-time)
name (string)
outcome_instance_id (integer, nullable)
preferred_language (string, nullable)
state_id (integer, nullable)
state_key (string, nullable)
status (string)
use_given_name (boolean)
user_readable_id (string)

Further fields are present but are not part of this contract.

Assign a proof to a needed document¶

POST /api/1/cases/{case_pk}/proofs/{id}/assign

keep_dirty (boolean) - Save the change without running the rule engine, see Delay the recalculation.
skip_case_response (boolean) - Answer with the case id alone instead of the whole case, see Skip the case response.

Request body

assign_to (integer, required)
information_value_id (integer)

{
  "assign_to": 3301
}

Example

curl -X POST \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"assign_to": 3301}' \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>/assign

Response 200

The case. The listed properties are the stable ones. The payload also carries the fields the Atfinity frontend needs, which are not part of this contract and can change.

calculated_name (string, nullable)
color (string)
created (string, date-time)
creation_reason (string)
given_name (string, nullable)
id (integer)
is_created (boolean)
is_dirty (boolean)
is_editable (boolean)
last_modified (string, date-time)
last_transition_at (string, date-time)
name (string)
outcome_instance_id (integer, nullable)
preferred_language (string, nullable)
state_id (integer, nullable)
state_key (string, nullable)
status (string)
use_given_name (boolean)
user_readable_id (string)

Further fields are present but are not part of this contract.

Download the original file of a proof¶

GET /api/1/cases/{case_pk}/proofs/{id}/original

Pass the id of a proof. For a proof whose from_information is true, a file uploaded to a file information, also inside a structure, pass from_file_ followed by its uuid instead. A file information holding several files lists each file as its own proof with its own uuid.

Example

curl -X GET \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>/original

Response 200

The proof file as it was uploaded, without appendices.

Unassign a proof¶

POST /api/1/cases/{case_pk}/proofs/{id}/unassign

skip_case_response (boolean) - Answer with the case id alone instead of the whole case, see Skip the case response.

Example

curl -X POST \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/proofs/<id>/unassign

Response 200

The case. The listed properties are the stable ones. The payload also carries the fields the Atfinity frontend needs, which are not part of this contract and can change.

calculated_name (string, nullable)
color (string)
created (string, date-time)
creation_reason (string)
given_name (string, nullable)
id (integer)
is_created (boolean)
is_dirty (boolean)
is_editable (boolean)
last_modified (string, date-time)
last_transition_at (string, date-time)
name (string)
outcome_instance_id (integer, nullable)
preferred_language (string, nullable)
state_id (integer, nullable)
state_key (string, nullable)
status (string)
use_given_name (boolean)
user_readable_id (string)

Further fields are present but are not part of this contract.