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.

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 201

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)
• 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}

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)
• 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}

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)
• 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

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)
• 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

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

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)
• 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.