Retrieves an identity (its addresses, communications, opt-ins and affected populations).

GET 
/api/v1/identity/:identityId

SOAP Equivalent: ACP_GetIdentity (and its family-filtered variant ACP_GetIdentityFamily, reachable through the optional family query parameter).

SOAP to REST Field Mapping

REST Field	SOAP Field	Notes
identityId	id_identity	Route parameter
family	FAMILY family	Optional query filter (IDENTITY / IDENTITYWITHOUTACCOUNT / BENEFICIARY)
identity	identity	The identity graph (identityId 0 = not found)
identity.mergedIds	ListIdentityMerged	Merged identity ids (FUSION events)
identity.populationsAffected	ListPopulationsAffected	Affected population models

Scoped by the x-tenant header; the session context (institution) is validated first. An anonymised identity is returned as HTTP 404 (SOAP result 10511); a family mismatch as HTTP 404 (10510). A not-found identity is returned as HTTP 200 with identityId = 0 (SOAP: bresult == false, empty identity).

Request

Responses

200

OK

401

Unauthorized

404

Not Found

422

Unprocessable Content

500

Internal Server Error