Skip to main content

Get a domain object mapping

GET 

/v1/admin/mapping/:type/:arkId

Required role: ADMIN

Returns the platform record and external-system mapping for the specified domain object. The response shape varies by objectType:

objectTypeFields returned
CUSTOMERcustomerNumber, dpid (if set), verificationId (if set)
ACCOUNTaccountNumber, bsb, productKey, productVersion
CARDcardType, accountId

Request

Responses

The requested domain object mapping was retrieved successfully.