identities

Update Identity Endpoint

Update identity fields including external_ref, PII (name, DOB, address, document number, SSN), country, email, and phone.

Status is intentionally NOT settable via this endpoint — use POST /identities/{id}/status instead so the change is recorded with a dedicated audit action and dispatches the identity.status_changed webhook event. PATCH still returns 422 if status is supplied.

Redacted identities cannot be updated. Dispatches an identity.updated webhook.

patch/api/v1/identities/{identity_id}

Request

  • Base URL: https://api.withverifa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withverifa.com/api/v1/identities/{identity_id}
  • Auth: none declared

Path parameters

identity_idstring required

Request body

external_refstring nullable
first_namestring nullable
last_namestring nullable
date_of_birthstring nullable
address_line1string nullable
address_line2string nullable
citystring nullable
statestring nullable
zip_codestring nullable
document_numberstring nullable
ssnstring nullable
nationalitystring nullable
genderstring nullable
countrystring nullable
statusstring nullable
emailstring nullable
phonestring nullable

Response

Successful Response

unknown required

Changes

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