Skip to main content

Admin endpoints — domain-object mapping

Registers and looks up the link between an Ark resource and its record at a backing provider — used when onboarding existing customer / account / card data into Ark. Auth: API key in the X-Api-Key header (no JWT on these routes). The formal schema is on the API Reference.

MethodPathCodeDoes
GET/v1/admin/mapping/{type}/{arkId}200Read a domain-object mapping
PUT/v1/admin/mapping/{type}/{arkId}201Create or update a mapping

{type} is one of CUSTOMER, ACCOUNT, or CARD.

Notes for operators​

  • Customer mappings also write the party record. A CUSTOMER PUT upserts the platform party (as an INDIVIDUAL): a successful active mapping leaves the party ACTIVE, while an inactive mapping — or a provider that reports the customer as not found / login-disabled — leaves it TERMINATED. ACCOUNT and CARD mappings do not write platform records.
  • Registering a mapping makes the resource routable without a prior customer-facing call, so later requests reach the right provider.
  • Only GET and PUT exist. The OpenAPI contract additionally lists a DELETE /v1/admin/mapping/{type}/{arkId} and a POST /v1/admin/mapping/customer/{arkId}/load-data (bulk load); neither is implemented by the platform today.