POST
Find or Create Associated Entity

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Body

application/json
relationships
object[]
required
sourceEntityId
string
required
noteIds
string[]
targetEntityId
string

Existing entity to link. Needs an email unless every relationship sets isConfirmationRequired to false. Either targetEntityId or targetEntity is required; targetEntityId wins if both are sent

targetEntity
object

Details of the related party. Needs an email unless every relationship sets isConfirmationRequired to false. An existing entity with the same email is linked as-is, ignoring the other details; otherwise a new entity is created. Identities with supporting documents are marked as verified. Ignored when targetEntityId is sent

Response

Success

data
object[]
required
creationStatus
enum<string>
Available options:
Created,
Invalid,
Existing