Version: 1.0.0

Administration API

Admin API for managing domain object mappings between the Ark platform and external connector systems (core banking, identity verification, etc.).

Authentication: ADMIN role required — either an API key (x-api-key header) or an OAuth2 client-credentials token with the ADMIN scope.

Domain object types

type	Description
CUSTOMER	A party/customer record in the platform
ACCOUNT	A bank account record
CARD	A payment card record

Error envelope: { errorCode, message, timestamp, traceId } where errorCode follows the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE} (e.g. GEN004001, ADM100008).

Authentication

API Key: apiKeyAuth

Security Scheme Type:	apiKey
Header parameter name:	x-api-key

OAuth 2.0: OAuth2

Client credentials flow - requires ADMIN role

Security Scheme Type:	oauth2
OAuth Flow (clientCredentials):	Token URL: https://login.microsoftonline.com/tenant-id/oauth2/v2.0/token Scopes:

Contact

ark-support@digizoo.com.au