Create a party
POST/v1/parties/provision
Creates a platform party and returns it in ACTIVE status on success.
During processing, the platform first persists the party in PROSPECT status and activates it only when create processing succeeds.
On success, the response includes the newly created partyId, ACTIVE status, and core system reference.
If create processing fails after the PROSPECT party is created, activation does not occur and the platform party remains PROSPECT.
Supported Entity Types: INDIVIDUAL, COMPANY, SOLE_TRADER
Sole trader parties are provisioned as an individual client in the core banking system with the proprietor's ABN attached.
Required Roles: CLIENT
Requires identity provider authentication with clientId and brandId headers.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
- 503
Party created successfully
Schema validation error (GEN000000).
Business validation errors may also be returned here, including unsupported relationship type (PAR000010).
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001)
Party not found (PAR004001).
Returned when a company relationship references a relatedPartyId that cannot be resolved during create processing.
Capability not configured for this tenant (CRT022003)
Internal server error (GEN100000). Service error (GEN100001).
All connector targets are currently unhealthy (CRT103001)