Patch Applicant

patch/v1/applicants/{applicant_id}

Update applicant fields. ``internal_status`` and ``risk_tier`` require admin (Bearer or operator with ``role=ADMIN``); other fields don't.

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

applicant_id

path · required

No additional parameter description.

Request body

JSON · required

consent

ConsentIn | null

No additional field description.

custom_attributes

object | null

No additional field description.

dob

string | null

No additional field description.

gender

ApplicantGender | null

No additional field description.

internal_status

ApplicantInternalStatus | null

No additional field description.

legal_name_first

string | null

No additional field description.

legal_name_last

string | null

No additional field description.

legal_name_middle

string | null

No additional field description.

nationality

string | null

No additional field description.

risk_tier

ApplicantRiskTier | null

No additional field description.

Example request

cURL

curl --request PATCH \
  --url 'https://api.fideralabs.com/v1/applicants/{applicant_id}' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "consent": {
    "biometric": true,
    "policy_version": "string"
  },
  "custom_attributes": {},
  "dob": "string",
  "gender": "string",
  "internal_status": "string",
  "legal_name_first": "string",
  "legal_name_last": "string",
  "legal_name_middle": "string",
  "nationality": "string",
  "risk_tier": "string"
}'

Responses

200Successful Response

addresses

ApplicantAddressOut[]

No additional field description.

business_name

string | nullrequired

No additional field description.

checks

CheckOut[]

No additional field description.

consent

object | null

No additional field description.

created_at

stringrequired

No additional field description.

custom_attributes

objectrequired

No additional field description.

dob

string | nullrequired

No additional field description.

email_hash

string | nullrequired

No additional field description.

entity_type

ApplicantEntityTyperequired

No additional field description.

external_id

string | nullrequired

No additional field description.

flows

FlowSummary[]

No additional field description.

gender

ApplicantGender | nullrequired

No additional field description.

id

stringrequired

No additional field description.

internal_status

ApplicantInternalStatusrequired

No additional field description.

legal_name_first

string | nullrequired

No additional field description.

legal_name_last

string | nullrequired

No additional field description.

legal_name_middle

string | nullrequired

No additional field description.

nationality

string | nullrequired

No additional field description.

notes

ApplicantNoteOut[]

No additional field description.

phone_hash

string | nullrequired

No additional field description.

risk_tier

ApplicantRiskTierrequired

No additional field description.

updated_at

stringrequired

No additional field description.

application/json

{
  "addresses": [
    {
      "city": "string",
      "country": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "string",
      "line1": "string",
      "line2": {},
      "postal_code": {},
      "region": {},
      "verified": true
    }
  ],
  "business_name": "string",
  "checks": [
    {
      "alert_count": 0,
      "applicant_id": {},
      "applicant_name": {},
      "check_type": "string",
      "completed_at": {},
      "created_at": "2026-07-29T12:00:00Z",
      "dataset_versions": [
        {}
      ],
      "datasets": {},
      "decision": {},
      "error": {},
      "evidence": {},
      "flow_id": {}
    }
  ],
  "consent": {},
  "created_at": "2026-07-29T12:00:00Z",
  "custom_attributes": {},
  "dob": "string",
  "email_hash": "string",
  "entity_type": "string",
  "external_id": "string",
  "flows": [
    {
      "completed_at": {},
      "created_at": "2026-07-29T12:00:00Z",
      "datasets": [
        {}
      ],
      "decision": "string",
      "decision_reason_codes": [
        {}
      ],
      "execution_mode": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "result": "pending",
      "status": "string",
      "type": "string"
    }
  ],
  "gender": "string"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

patch_applicant_v1_applicants__applicant_id__patch