AddPartyResponse
objectResponse for the add-party request. The workspaceId is returned once at the top level as it is common to all parties. The parties array mirrors the request order; it currently contains a single element, matching the one-party-per-request limit.
Identifier of the workspace the parties were added to
Parties created by this request, in the same order as the request. Currently contains a single element, mirroring the one-party-per-request limit.
Show Child Parameters
AddedParty
objectIdentifier of the newly created party
Party type of the added party. Allowed values: INDIVIDUAL, ENTITY.
Allowed values:INDIVIDUALENTITY
Role of the added party. Allowed values: BUYER, SELLER.
Allowed values:BUYERSELLER
Present only for entity-linked individuals; the entity party this individual is linked to
The integrator-supplied identifier echoed from the request for this party. Null when no externalPartyId was supplied.
<= 50 characters
The submitted party details echoed back (e.g. names, contact, entity information), so the returned party is self-describing and can be matched to the party you submitted.
ErrorResponse
objectShow Child Parameters
Error
objectEmail address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters