Skip to main content

UDA endpoints — admin

How to call the admin id-mapping routes. The formal schema is the OpenAPI specification (openapi/source/connector/admin/); this page is the call contract. Internal processing is in the architecture reference; caveats in the implementation notes.

These are internal routes the Ark platform uses to bind an Ark id to its ULTRACS counterpart. They are not party-scoped and carry no auth guard — they are not part of the consumer-facing surface (see the implementation notes).

MethodPathCodePurpose
PUT/admin/mapping/{type}/{arkId}200Create/refresh a domain-object id mapping
GET/admin/mapping/{type}/{arkId}200Read a domain-object id mapping

Notes for callers

  • {type} is the domain-object type. On PUT it is taken from the request body's objectType (CUSTOMER / ACCOUNT / CARD); on GET it is the path segment, where PARTY is accepted as an alias for CUSTOMER. An unknown GET type → 400.
  • {arkId} is the Ark identifier to bind (party / account / card).
  • PUT CUSTOMER looks the client up in the core system, extracts the verification id, and persists the party mapping. PUT ACCOUNT / PUT CARD resolve the core-banking record/product and persist the account / card mapping (cards bind to a card product by physicality type).
  • GET returns only the stored id mapping — it does not re-read the core system, so customer verificationId/dpid, the account body, and a card's accountId come back empty (see the implementation notes).

Errors

HTTPCodeWhen
400GEN000000request body/params fail schema validation
400ADM004002 / ADM100003GET ACCOUNT product missing / PUT CARD card product missing
400ADM100006GET with an unknown domain-object type
401ADM001008core system reports the customer login is disabled
404ADM004002GET ACCOUNT: requested product not in catalogue (NO_MATCHING_PRODUCT_FOUND)
404ADM100008the domain object / mapping was not found
409ADM100008PUT ACCOUNT: the product to connect doesn't exist
500ADM100001 / ADM100003unexpected DB error / GET CARD card product missing
500GEN100001an unmapped ULTRACS fault (handleUltracsError falls back to DOWNSTREAM_CONNECTOR_ERROR)