The operation new in case of a party will add a party. A party can be a natural person (e.g. partner, employee) or an organization (e.g. bank, insurance company).

A party can exist without being connected (immediately) to a contract.

How to use variants

If you want to add a new party (for example an employer or a partner), choose the operation new. Only one variant is applicable for party (the variant ‘default’).

A positive response to the operation new contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.


The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

Variant Description party
<default> Add a new party Yes

<default> – Add a new party

The variant ‘default’ adds a new party. The partyStructure is used to add the party. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
Response Remarks
POST { uri } /parties/new partyStructure N/A partyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based.
commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional afdDefinitionName I/O Name of the AFD-definition.
commonFunctional afdDefinitionVersion I/O Version of the AFD-definition.
process statusType O The status of the process (codelist ADNSTS) within the entityType transaction.
party refKey O Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.


Thanks for your feedback.

Post your comment on this topic.

Post Comment