Mutate Submission

patch/v1/submissions/{submission_id}

Mutate Submission

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

submission_id

path · required

No additional parameter description.

Idempotency-Key

header · required

No additional parameter description.

Request body

JSON · required

applicant

SubmissionApplicantUpdate | null

No additional field description.

capture_state

SubmissionCaptureState | null

No additional field description.

consent

SubmissionConsent | null

No additional field description.

entities

EvidenceEntityFragment[]

No additional field description.

state

string | null

No additional field description.

version

integerrequired

No additional field description.

Example request

cURL

curl --request PATCH \
  --url 'https://api.fideralabs.com/v1/submissions/{submission_id}' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "applicant": {
    "current_address": {},
    "dob": {},
    "email": {},
    "gender": {},
    "legal_name_first": {},
    "legal_name_last": {},
    "legal_name_middle": {},
    "nationality": {},
    "phone": {},
    "profile_source": "manual"
  },
  "capture_state": {
    "assurance_level": {},
    "completed_steps": [
      {}
    ],
    "current_step": "welcome",
    "selected_document_type": {}
  },
  "consent": {
    "accepted": true,
    "policy_version": "string"
  },
  "entities": [
    {
      "id": "string",
      "observed_at": {},
      "properties": {},
      "schema": "string"
    }
  ],
  "state": "string",
  "version": 0
}'

Responses

200Successful Response

applicant_id

stringrequired

No additional field description.

capture_state

SubmissionCaptureStaterequired

No additional field description.

created_at

stringrequired

No additional field description.

documents

SubmissionDocumentOut[]required

No additional field description.

entities

EvidenceEntityFragment[]required

No additional field description.

flow_id

string | nullrequired

No additional field description.

id

stringrequired

No additional field description.

last_activity_at

stringrequired

No additional field description.

processing_requested_at

string | nullrequired

No additional field description.

state

SubmissionStaterequired

No additional field description.

submitted_at

string | nullrequired

No additional field description.

updated_at

stringrequired

No additional field description.

version

integerrequired

No additional field description.

application/json

{
  "applicant_id": "00000000-0000-0000-0000-000000000000",
  "capture_state": {
    "assurance_level": "standard",
    "completed_steps": [
      "string"
    ],
    "current_step": "welcome",
    "selected_document_type": "string"
  },
  "created_at": "2026-07-29T12:00:00Z",
  "documents": [
    {
      "created_at": "2026-07-29T12:00:00Z",
      "doc_type": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "mime_type": {},
      "side": "string",
      "upload_status": "string"
    }
  ],
  "entities": [
    {
      "id": "string",
      "observed_at": {},
      "properties": {},
      "schema": "string"
    }
  ],
  "flow_id": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_activity_at": "2026-07-29T12:00:00Z",
  "processing_requested_at": "2026-07-29T12:00:00Z",
  "state": "string",
  "submitted_at": "2026-07-29T12:00:00Z",
  "updated_at": "2026-07-29T12:00:00Z"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

mutate_submission_v1_submissions__submission_id__patch