Version: 1.0.0

Ark Party Management API

Party management, KYX verification, and relationship APIs for the platform. Supports provisioning and managing INDIVIDUAL, COMPANY, and SOLE_TRADER entity types. TRUST and PARTNERSHIP are defined in the schema but not yet provisioned end-to-end.

Party lifecycle

A party moves through the following statuses:

Status	Meaning
PROSPECT	Party created in the platform; KYX not yet completed
ACTIVE	Party fully provisioned in the core banking system
TERMINATED	Party terminated; no further operations permitted

KYX verification status

KYX checks (POST /v1/parties/kyx) track identity verification with the following outcome states:

Status	Meaning
SUSPECT	Initial state before party registration
PROSPECT	Party registered; KYX not yet initiated
IN_PROGRESS	Verification underway
UNDER_REVIEW	Verification requires manual intervention
VERIFIED	KYX passed; party eligible for core banking onboarding
ACTIVE	Fully onboarded and operational
FAILED	KYX check failed; a new check can be initiated
ERRORED	KYX check encountered an error; a new check can be initiated
DECLINED	Permanent rejection (e.g. PEP or watchlist match)
SUSPENDED	Temporarily suspended from operations
DISABLED	Permanently disabled; cannot proceed
INCOMPLETE	KYX process started but missing required information

A party can advance to ACTIVE only when the KYX outcome is VERIFIED.

Conventions

• All resource identifiers are UUIDs (format: uuid).
• Errors follow the envelope { errorCode, message, timestamp, traceId } where errorCode is formatted {DOMAIN}{CLASSIFICATION}{SEQUENCE} (e.g. PAR004001).
• Authentication is HTTP Bearer (JWT) on every operation.
• clientid and brandid request headers identify the tenant and are required on most operations (see individual endpoint parameters).
• The partyid request header is required on party-scoped operations; its value must match the partyId path parameter (PAR000006 if mismatched).

Authentication

HTTP: Bearer Auth

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

Contact

support@digizoo.com.au