Skip to main content

Retrieves an identity with its child contacts (each contact being a core identity).

GET 

/api/v1/identity/:identityId/contact

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

SOAP to REST Field Mapping

REST FieldSOAP FieldNotes
identityIdid_identityRoute parameter
familyFAMILY familyOptional query filter (IDENTITY / IDENTITYWITHOUTACCOUNT / BENEFICIARY)
identity.contactscontactsChild contacts (IdentityRelationShip, ID_Parent = identity)
identity.contacts[].isContactDefaultisContactDefautDefault contact flag

Scoped by the x-tenant header; the session context (institution) is validated first. A disabled (removed in back office) or family-mismatching identity is returned as HTTP 404 (SOAP result 10510); an anonymised identity as HTTP 404 (SOAP result 10511). The reuse of the identity id after a merge (SOAP warning 10258) is not surfaced.

Request

Responses

OK