Page History

...

Important: Depending on the agency settings for 'Title structure', either commonTitle / formalTitle OR compoundTitle are being used. Please consult our documentation for further details.

On top a new field will be available: Name suffix / nameSuffix

Transition logic for deprecated fields

We will continue to support the deprecated fields until their scheduled removal. The following translation logic will be applied:

Direction	Field	Logic
From Faces (HTTP GET)	gender	If a commonTitle is present, it is reported as-is If a sex is set, it is reported (M / F / U / X) Otherwise the field will be set to null
	title	Will be mapped one-to-one from greeting.formalTitle
To Faces (HTTP PATCH / POST)	gender	If value is a known sex type (M / F / U / X) , apply it as "sex" For F set greeting commonTitle = MS for M set greeting commonTitle = MR If value is a known common title, apply it as such and derive the default sex from it (e.g. MR = Sex "M", MS = Sex "F") Otherwise set Sex = "U" and remove commonTitle. The sent value will not be stored
	title	Will be mapped one-to-one to greeting.formalTitle

API rate limiting

If we monitor excessive API calls over a longer period, we reserve the right to set a rate limiting or to charge for these calls.

Versions Compared

Old Version 21

New Version 22

Key

Transition logic for deprecated fields

API rate limiting