AddPartyResponse

object

Response 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.

workspaceIdstring(uuid)required

Identifier of the workspace the parties were added to

partiesarray[object]required

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
Example

AddedParty

object
partyIdstring(uuid)

Identifier of the newly created party

partyTypestring

Party type of the added party. Allowed values: INDIVIDUAL, ENTITY.

Allowed values:INDIVIDUALENTITY

rolestring

Role of the added party. Allowed values: BUYER, SELLER.

Allowed values:BUYERSELLER

organisationPartyIdstring(uuid)

Present only for entity-linked individuals; the entity party this individual is linked to

externalPartyIdstring

The integrator-supplied identifier echoed from the request for this party. Null when no externalPartyId was supplied.

<= 50 characters

partyDetailsobject

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.

* Additional properties are allowed.
Example

ErrorResponse

object
errorsarray[object]
Show Child Parameters
Example

Error

object
codestring
messagestring
fieldstring
Example

Email

string

Email address

Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$

<= 320 characters