---
title: "Add submission characteristics"
method: PUT
path: "/v2/submission/{submission_id}/characteristics"
---

# Add submission characteristics

`PUT /v2/submission/{submission_id}/characteristics`

Attach submission characteristics to the submission. Submission characteristics are properties associated with the <i>original</i> submission of the document (i.e., from the end user).
In descriptions of the properties, "user" refers to the person who initially submitted the document, "customer" refers to a customer of Resistant.ai using this API.

Calling this endpoint is only allowed if `enable_submission_characteristics` is set to `true` when creating the submission. When submission characteristics are enabled for the submission, submitting then is <b>required</b> (the document will not be analyzed without them).

## Path parameters

- `submission_id` string, required

## Request body

- SubmissionCharacteristicsRequest — Properties associated with the <i>original</i> submission of the document (i.e., from the actual end client).
  - `document_characteristics` object, nullable — Properties associated with the analyzed document.
    - `document_type` 'unknown' | 'id_card' | 'drivers_license' | 'birth_certificate' | 'health_insurance_card' | 'id_certificate' | 'passport' | 'residence_permit' | 'account_confirmation' | 'account_statement' | 'bank_details' | 'delivery_note' | 'company_detail' | 'earnings_confirmation' | 'employer_identification_number' | 'fees_statement' | 'government_registry_confirmation' | 'incorporation_certificate' | 'insurance_claim' | 'insurance_documentation' | 'invoice' | 'order' | 'order_confirmation' | 'payment' | 'payment_confirmation' | 'payslip' | 'proof_of_address' | 'receipt' | 'registration_certificate' | 'rental_agreement' | 'report' | 'residence_certificate' | 'tax_form' | 'tax_information' | 'ticket' | 'tracking_note' | 'transaction_detail' | 'transaction_history' | 'transport_order' | 'utility_bill' | 'vehicle_appraisal' | 'vehicle_registration_certificate', nullable — Type of the document, e.g. ID card, passport, account statement, ...
    - `document_type_string` string, nullable — Unconstrained value for type of document, e.g. customer-specific naming not mapped to document types defined in document_type attribute
    - `issuing_country_code` string, nullable — [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) of the country or the string `UNKNOWN`
    - `document_id` string, nullable — Document identifier assigned by the customer (e.g., scan reference).
    - `document_filename` string, nullable
    - `document_score` string, nullable
    - `status` string, nullable — Document status computed by the customer, e.g., `accepted`, `rejected`, `sms verification needed`, ...
    - `document_position_on_image` object, nullable — Position of a document (e.g., ID card) on the submitted image
      - `corner_1` object, required — Coordinates of a first corner of the document on the submitted image.
        - `x` integer, required — X (horizontal) coordinate in pixels. The axis starts (x=0) at the top-left corner of the image.
        - `y` integer, required — Y (vertical) coordinate in pixels. The axis starts (y=0) at the top-left corner of the image.
      - `corner_2` object, required — Coordinates of a second corner of the document on the submitted image.
        - `x` integer, required — X (horizontal) coordinate in pixels. The axis starts (x=0) at the top-left corner of the image.
        - `y` integer, required — Y (vertical) coordinate in pixels. The axis starts (y=0) at the top-left corner of the image.
      - `corner_3` object, required — Coordinates of a third corner of the document on the submitted image.
        - `x` integer, required — X (horizontal) coordinate in pixels. The axis starts (x=0) at the top-left corner of the image.
        - `y` integer, required — Y (vertical) coordinate in pixels. The axis starts (y=0) at the top-left corner of the image.
      - `corner_4` object, required — Coordinates of a fourth corner of the document on the submitted image.
        - `x` integer, required — X (horizontal) coordinate in pixels. The axis starts (x=0) at the top-left corner of the image.
        - `y` integer, required — Y (vertical) coordinate in pixels. The axis starts (y=0) at the top-left corner of the image.
    - `source_channel` 'api' | 'web' | 'mobile', nullable — Identification of source that document came form eg. mobile device, Web UI etc.
    - `document_side` 'front' | 'back', nullable — Side of the document, e.g. front or back side of an ID card.
  - `device_characteristics` object, nullable — Properties associated with the device used to submit the document.
    - `device_ip_address` string, nullable
    - `server_ip_address` string, nullable
    - `country_code` string, nullable — [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) of the country from where the document was submitted.
    - `country_name` string, nullable — Name of the country from where the document was submitted.
    - `city` string, nullable
    - `postal_code` string, nullable
    - `gcs_latitude` string, nullable
    - `gcs_longitude` string, nullable
    - `isp` string, nullable
    - `referer` string, nullable
    - `user_agent` string, nullable
    - `browser_description` string, nullable
    - `device_platform` string, nullable
    - `device_language` string, nullable — Device language in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format
    - `screen_height` integer, nullable
    - `screen_width` integer, nullable
    - `device_fingerprint` string, nullable
  - `identity_characteristics` object, nullable — Properties identifying the user who submitted the document.
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `user_id` string, nullable — Customer-assigned identifier of the user who originally submitted the document (or the entity that created the account under which the document was submitted, e.g., "account holder ID")
    - `user_group_id` string, nullable — ID assigned by customer to group several users acting as a single entity
    - `phone_number` string, nullable
    - `date_of_birth` string, nullable
  - `transaction_characteristics` object, nullable — Properties of a transaction between the user and customer, e.g., load or purchase.
    - `amount_usd` number, nullable
    - `maturity_days` integer, nullable — Number of days until maturity (e.g., for a loan)
  - `email_characteristics` object, nullable — Properties of an email interaction between the user and customer, e.g. email or subject hashes.
    - `originator_address_hashes` string[], nullable
    - `originator_domain_hashes` string[], nullable
    - `subject_hash` string, nullable
    - `number_of_recipients` integer, nullable
    - `recipient_hashes` string[], nullable
    - `body_embedding` string, nullable
    - `subject_embedding` string, nullable
  - `claims_characteristics` object, nullable — Properties of an insurance claim.
    - `claim_number` string, nullable
    - `policy_number` string, nullable
    - `insurance_type` string, nullable
    - `incident_date` string, nullable
    - `reported_date` string, nullable
    - `incident_description` string, nullable
    - `incident_location` string, nullable
    - `claim_value` number, nullable
  - `submission_time` string, nullable — Time of document submission by the end user
  - `customer_tenant_id` string, nullable — Customer-assigned identifier of a customer's tenant (e.g., internal merchant ID). Please ensure the customer_tenant_id of any document is reviewed prior to submission to confirm that no PII is included. The customer_tenant_id is used to separate data by individual customer tenants for monitoring and configuration purposes.
  - `customer_case_id` string, nullable — Customer-assigned identifier of a customer's tenant (e.g., internal case ID). Please ensure the case_id of any document is reviewed prior to submission to confirm that no PII is included. The case_id is used to identify the resubmission of the document.

## Response `204`

Submission characteristics were submitted successfully

## Other responses

- `400` — Bad request.
- `401` — Missing valid authentication credentials.
- `403` — Access to the requested resource is forbidden.
- `404` — The requested resource was not found.
- `415` — Unsupported media type.
- `429` — Request quota was exceeded

---

[API](https://skmtc.dev/resistant/apis/resistant-documents-api.md) · [All operations](https://skmtc.dev/resistant/apis/resistant-documents-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/resistant/resistant-documents-api/revisions/7c1ce5331e7b/schema)