Add submission 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).

put/v2/submission/{submission_id}/characteristics

Path parameters

submission_idstring required

Request body

submission_timestring nullable

Time of document submission by the end user

customer_tenant_idstring 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_idstring 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.

Example request

{
  "device_characteristics": {
    "country_code": "GBR",
    "gcs_latitude": "38.77554692",
    "gcs_longitude": "-75.1396939",
    "user_agent": "Mozilla/5.0 (Android 4.4; Mobile; rv:41.0) Gecko/41.0 Firefox/41.0",
    "device_language": "en"
  },
  "identity_characteristics": {
    "date_of_birth": "2020-01-30"
  },
  "transaction_characteristics": {
    "amount_usd": 120.5,
    "maturity_days": 60
  },
  "email_characteristics": {
    "originator_address_hashes": [
      "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
    ],
    "originator_domain_hashes": [
      "486ea46224d1bb4fb680f34f7c9ad96a8f24ec88be73ea8e5a6c65260e9cb8a7"
    ],
    "subject_hash": "bbcfcbdecdfec348f558015cc36d01ab27081c2cef9dad3e44d9277b46de2f72",
    "recipient_hashes": [
      "486ea46224d1bb4fb680f34f7c9ad96a8f24ec88be73ea8e5a6c65260e9cb8a7"
    ]
  },
  "claims_characteristics": {
    "incident_date": "2020-01-30",
    "reported_date": "2020-01-30",
    "claim_value": 1729.2
  }
}

Response

Submission characteristics were submitted successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.