Update a client
Required scopes: clients:read and clients:write.
Updates a client's external_id, dob or ssn. No other fields can be changed. Omitted fields stay unchanged, and null clears a field.
Requires clients:read as well as clients:write, because the response returns the client. Changing or clearing dob or ssn also requires clients:sensitive:write. A new SSN must match the client's recorded SSN last four, and SSN changes are refused while the client is awaiting ERE access. Setting an SSN clears any invalid-SSN flag on the client.
Send If-Match with the ETag from your latest Get a client response. A missing If-Match returns 428; a stale one returns 412, in which case read again and retry. Requires an Idempotency-Key. Retrying with the same key and body within 24 hours returns the original result without repeating the action.
The response never includes SSN or date of birth, even when the key can write them. Read them with Get a client and include_sensitive=true.
/api/v2/clients/{id} clients:read, clients:write Path parameters
· 1id string required Client ID.
Headers
· 2Idempotency-Key string · min length: 1· max length: 128 · pattern required Unique key for this operation, 1 to 128 visible ASCII characters (for example a UUID). Reuse it only when retrying the same request.
If-Match string required The ETag from your latest read of this resource.
Body
external_id string | null dob string | null ssn string | null